JJR: Created page with "{{Documentation subpage}} ==Syntax== *{{tlx..."

2022-05-16T05:46:44Z

Created page with "{{Documentation subpage}}  ==Syntax== *{{tlx..."

New page

{{Documentation subpage}}

==Syntax==
*{{tlx|Format time|hour|minute|second}}
*{{tlx|Format time|hour|minute|second|TimeZone|hour_format=(format)}}

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

Examples:

*{{tlx|Format time|08|30}} returns "{{Format time|08|30}}"
*:{{tlx|Format time|08|30|23}} returns "{{Format time|08|30|23}}"
*{{tlx|Format time|08|30|tz=Z}} returns "{{Format time|08|30|tz=Z}}"
*{{tlx|Format time|08|30|23|timezone=+01:00}} returns "{{Format time|08|30|23|timezone=+01:00}}"
*{{tlx|Format time|08|30|23|TimeZone=-07:00}} returns "{{Format time|08|30|23|TimeZone=-07:00}}"

=== Hour format ===
The hour format parameter {{param|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:

*{{tlx|Format time|08|30|hour_format=g}} returns "{{Format time|08|30|hour_format=g}}"
*{{tlx|Format time|08|30|hour_format=G}} returns "{{Format time|08|30|hour_format=G}}"
*{{tlx|Format time|08|30|hour_format=h}} returns "{{Format time|08|30|hour_format=h}}"
*{{tlx|Format time|08|30|hour_format=H}} returns "{{Format time|08|30|hour_format=H}}"

==See also==
* {{tl|Format date}} for dates, with times optional
{{Date and time templates}}

== Template Data ==
{{TemplateDataHeader}}

<includeonly>{{sandbox other||


}}</includeonly>
<templatedata>
{
"params": {
"hour": {
"aliases": [
"hh",
"1"
],
"label": "Hour",
"description": "Hour of the day, in 24 hour format",
"example": "13",
"type": "number",
"autovalue": "",
"required": true
},
"minute": {
"aliases": [
"mm",
"2"
],
"label": "Minute",
"description": "minutes after the hour",
"example": "3",
"type": "number",
"autovalue": "0",
"suggested": true
},
"second": {
"aliases": [
"ss",
"sec",
"3"
],
"label": "Second",
"description": "Seconds after the minute",
"type": "number"
},
"hour_format": {
"label": "Hour format",
"type": "string",
"suggested": true,
"description": "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)"
},
"timezone": {
"aliases": [
"tz",
"TimeZone",
"4"
],
"description": "A numerical offset from UTC, or 'Z'. If non-empty, shows time zone",
"example": "Z",
"type": "string"
}
},
"paramOrder": [
"hour",
"minute",
"second",
"hour_format",
"timezone"
],
"description": "Formats a time of day"
}
</templatedata>

Template:Format time/doc - Revision history

JJR: Created page with "{{Documentation subpage}} ==Syntax== *{{tlx..."