Template:Format time/doc

- - -

There is a documentation subpage housing the metadata about parent template: Format time.

Syntax

• {{Format time|hour|minute|second}}
• {{Format time|hour|minute|second|TimeZone}}

Parameters

• {{{hour}}} is required, and is the hour in 24 hour format.
  • aliases: {{{hh}}} and {{{1}}} (the first positional parameter)
• {{{minute}}} is recommended; it is the minute after the hour (default 0).
  • aliases: {{{mm}}} and {{{2}}} (the second positional parameter)
• {{{second}}} is optional; seconds will only be rendered if this is not blank.
  • aliases: {{{ss}}}, {{{sec}}} and {{{3}}} (the third positional parameter)
• {{{TimeZone}}} may be a numerical value, or "Z" for UTC; see examples.
  • aliases: {{{timezone}}}, {{{tz}}} and {{{4}}} (the fourth positional parameter)
• {{{hour_format}}} can be blank, 'h', 'H', 'g' or 'G'; see §§ Hour format​ and below.

Examples:

• {{Format time|08|30}} returns "08:30"

  {{Format time|08|30|23}} returns "08:30:23"

• {{Format time|08|30}} returns "08:30 (UTC)"
• {{Format time|08|30|23}} returns "08:30:23 (+01:00)"
• {{Format time|08|30|23}} returns "08:30:23 (-07:00)"

Hour format

The hour format parameter {{{hour_format}}} can be variously 'g', 'G', 'h', or 'H', specifying whether to use 12 hour time with AM/PM (g/G) or 24 hour time (h/H), and whether to truncate (g/h) numbers under 10 or not (G/H).

Examples:

• {{Format time|08|30}} returns "8:30 am"
• {{Format time|08|30}} returns "8:30"
• {{Format time|08|30}} returns "08:30 AM"
• {{Format time|08|30}} returns "08:30"

See also

• {{Format date}} for dates, with times optional

Template Data

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools.

TemplateData for Format time

Formats a time of day

Template parameters

Parameter		Description	Type	Status
Hour	hour hh 1	Hour of the day, in 24 hour format Example 13 Auto value	Number	required
Minute	minute mm 2	minutes after the hour Example 3 Auto value 0	Number	suggested
Second	second ss sec 3	Seconds after the minute	Number	optional
Hour format	hour_format	Formats hours and whether to render AM/PM or a.m./p.m. Example g (7:00 p.m.), G (07:00 PM), h (19:00), or H (19:00)	String	suggested
timezone	timezone tz TimeZone 4	A numerical offset from UTC, or 'Z'. If non-empty, shows time zone Example Z	String	optional