View source for Template:Duration/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

{{Lua|Module:Duration}}

This template emits the hAudio [[microformat]].

== Usage ==

=== Unformatted input ===

An unformatted duration can be input in the first parameter: <code>{{((}}Duration{{!}}10:20:30{{))}}</code> (hours:minutes:seconds) or <code>{{((}}Duration{{!}}20:30{{))}}</code> (minutes:seconds). There ''must'' be a seconds value, as inputs in hours and minutes are indistinguishable from inputs in minutes and seconds.

=== Numbered parameters ===

<pre>{{Duration|10|20|30}}</pre>

where parameters are hours, minutes and seconds respectively. If the hours or minutes values are zero, then leave them blank (e.g. <code>{{((}}Duration{{!}}{{!}}20{{!}}30{{))}}</code>). Minutes and seconds values default to zero, although they should ideally be specified.

=== h, m and s parameters ===

<pre>{{Duration|h=10|m=20|s=30}}</pre>

where h, m and s are hours, minutes and seconds respectively. Minutes and seconds values default to zero, although they should ideally be specified.

=== Parent templates ===

This template can be used in:

{{Flatlist|
* {{Tl|Infobox album}}
* {{Tl|Infobox song}}
}}

In {{tl|Infobox album}}, the microformat is added automatically if there is not one already. However, more complicated values might require this template.

== Examples ==

=== Unformatted input ===

*<code><nowiki>{{Duration|1:22:34}}</nowiki></code> renders as: {{Duration|1:22:34}}
*<code><nowiki>{{Duration|74:32}}</nowiki></code> renders as: {{Duration|74:32}}
*<code><nowiki>{{Duration|1:02:34}}</nowiki></code> renders as: {{Duration|1:02:34}}
*<code><nowiki>{{Duration|1:2:3}}</nowiki></code> renders as: {{Duration|1:2:3}}
*<code><nowiki>{{Duration|0:22:34}}</nowiki></code> renders as: {{Duration|0:22:34}}
*<code><nowiki>{{Duration|0:0:34}}</nowiki></code> renders as: {{Duration|0:0:34}}
*<code><nowiki>{{Duration|0:34}}</nowiki></code> renders as: {{Duration|0:34}}

=== h, m and s parameters ===

*<code><nowiki>{{Duration|h=1|m=22|s=34}}</nowiki></code> renders as: {{Duration|h=1|m=22|s=34}}
*<code><nowiki>{{Duration|m=74|s=32}}</nowiki></code> renders as: {{Duration|m=74|s=32}}
*<code><nowiki>{{Duration|m=2|s=34}}</nowiki></code> renders as: {{Duration|m=2|s=34}}
*<code><nowiki>{{Duration|h=1|s=34}}</nowiki></code> renders as: {{Duration|h=1|s=34}}
*<code><nowiki>{{Duration|h=1}}</nowiki></code> renders as: {{Duration|h=1}}
*<code><nowiki>{{Duration|h=0|m=22|s=34}}</nowiki></code> renders as: {{Duration|h=0|m=22|s=34}}
*<code><nowiki>{{Duration|h=0|m=0|s=34}}</nowiki></code> renders as: {{Duration|h=0|m=0|s=34}}
*<code><nowiki>{{Duration|h=1|m=22|s=34.5678}}</nowiki></code> renders as: {{Duration|h=1|m=22|s=34.5678}}
*<code><nowiki>{{Duration|h=1|m=22|s=3}}</nowiki></code> renders as: {{Duration|h=1|m=22|s=3}}
*<code><nowiki>{{Duration|h=1|m=2|s=34}}</nowiki></code> renders as: {{Duration|h=1|m=2|s=34}}
*<code><nowiki>{{Duration|h=1|m=2|s=3}}</nowiki></code> renders as: {{Duration|h=1|m=2|s=3}}
*<code><nowiki>{{Duration|h=1|m=2}}</nowiki></code> renders as: {{Duration|h=1|m=2}}
*<code><nowiki>{{Duration|s=34}}</nowiki></code> renders as: {{Duration|s=34}}
*<code><nowiki>{{Duration|m=0|s=34}}</nowiki></code> renders as: {{Duration|=0|s=34}}
*<code><nowiki>{{Duration|h=1|m=0|s=34}}</nowiki></code> renders as: {{Duration|h=1|m=0|s=34}}
*<code><nowiki>{{Duration|h=1|m=22|s=0}}</nowiki></code> renders as: {{Duration|h=1|m=22|s=0}}
*{{n}} <code><nowiki>{{Duration|h=one|m=22|s=0}}</nowiki></code> renders as: {{Duration|h=one|m=22|s=0}}
*{{n}} <code><nowiki>{{Duration|h=1|m=22|s=78}}</nowiki></code> renders as: {{Duration|h=1|m=22|s=78}}
*{{n}} <code><nowiki>{{Duration|h=1.1|m=2.2}}</nowiki></code> renders as: {{Duration|h=1.1|m=2.2}}

=== Numbered parameters ===

*<code><nowiki>{{Duration|1|22|34}}</nowiki></code> renders as: {{Duration|1|22|34}}
*<code><nowiki>{{Duration||74|32}}</nowiki></code> renders as: {{Duration||74|32}}
*<code><nowiki>{{Duration|1|2|34}}</nowiki></code> renders as: {{Duration|1|2|34}}
*<code><nowiki>{{Duration|1|2|3}}</nowiki></code> renders as: {{Duration|1|2|3}}
*<code><nowiki>{{Duration|0|22|34}}</nowiki></code> renders as: {{Duration|0|22|34}}
*<code><nowiki>{{Duration|0|0|34}}</nowiki></code> renders as: {{Duration|0|0|34}}
*<code><nowiki>{{Duration||0|34}}</nowiki></code> renders as: {{Duration||0|34}}
*<code><nowiki>{{Duration|||34}}</nowiki></code> renders as: {{Duration|||34}}
*<code><nowiki>{{Duration|1|22|34.5678}}</nowiki></code> renders as: {{Duration|1|22|34.5678}}
*<code><nowiki>{{Duration||1|22}}</nowiki></code> renders as: {{Duration||1|22}}
*<code><nowiki>{{Duration|1|22}}</nowiki></code> renders as: {{Duration|1|22}}
*<code><nowiki>{{Duration|1|22|0}}</nowiki></code> renders as: {{Duration|1|22|0}}
*{{n}} <code><nowiki>{{Duration|1|22|}}</nowiki></code> renders as: {{Duration|1|22|}}
*<code><nowiki>{{Duration|0|0|0}}</nowiki></code> renders as: {{Duration|0|0|0}}(blank)
*<code><nowiki>{{Duration|||}}</nowiki></code> renders as: {{Duration|||}}(blank)
*{{n}} <code><nowiki>{{Duration|1|22|34|55}}</nowiki></code> renders as: {{Duration|1|22|34|55}}
*{{n}} <code><nowiki>{{Duration|one|22|0}}</nowiki></code> renders as: {{Duration|one|22|0}}
*{{n}} <code><nowiki>{{Duration|1|22|78}}</nowiki></code> renders as: {{Duration|1|22|78}}
*{{n}} <code><nowiki>{{Duration|1.1|2.2}}</nowiki></code> renders as: {{Duration|1.1|2.2}}

== Microformat ==
{{UF-audio-part}}

==TemplateData==
{{TemplateDataHeader}}
<templatedata>
{
	"params": {
		"h": {
			"aliases": [
				"1"
			],
			"label": "Hours",
			"example": "3",
			"type": "number",
			"suggested": true
		},
		"m": {
			"aliases": [
				"2"
			],
			"label": "Minutes",
			"example": "32",
			"type": "number",
			"suggested": true
		},
		"s": {
			"aliases": [
				"3"
			],
			"label": "Seconds",
			"example": "42",
			"type": "number",
			"suggested": true
		}
	},
	"description": "For use in templates emitting the hAudio [[microformat]]",
	"format": "inline"
}
</templatedata>
<includeonly>{{sandbox other||

}}</includeonly>