View source for Template:Army/doc

{{documentation subpage}}
{{High-use|10,000}}
==Usage==
<kbd><nowiki>{{army|nation|variant|size=optional|name=optional}}</nowiki></kbd>

Produces a flag icon attached to a wikilinked national army article.
;Parameters
*''nation'' — Use either the name of the nation or the three-letter [[ISO 3166-1 alpha-3]] country code
*''variant'' (optional) — Specifies an alternate (historical) army flag to use.  This parameter is documented by the appropriate template in [[:Category:Country data templates]].  Note that the standard behaviour of this template is to use the <code>army</code> variant if present, so there is no need to specify this variant in the template call.
*''size'' (optional) — Can be used to change the flag icon size
*''name'' (optional) — Can be used to change the wikilink display text

==Examples==
*<kbd><nowiki>{{army|United Kingdom}}</nowiki></kbd> → {{army|United Kingdom}}
*<kbd><nowiki>{{army|US}}</nowiki></kbd> → {{army|US}}
*<kbd><nowiki>{{army|CHN}}</nowiki></kbd> → {{army|CHN}}
*<kbd><nowiki>{{army|Republic of China}}</nowiki></kbd> → {{army|Republic of China}}
*<kbd><nowiki>{{army|Empire of Japan}}</nowiki></kbd> → {{army|Empire of Japan}}
*<kbd><nowiki>{{army|Empire of Japan|name=Japan}}</nowiki></kbd> → {{army|Empire of Japan|name=Japan}}
*<kbd><nowiki>{{army|India}}</nowiki></kbd> → {{army|India}}
*<kbd><nowiki>{{army|Pakistan}}</nowiki></kbd> → {{army|Pakistan}}
*<kbd><nowiki>{{army|Bangladesh}}</nowiki></kbd> → {{army|Bangladesh}}
*<kbd><nowiki>{{army|Canada}}</nowiki></kbd> → {{army|Canada}}
*<kbd><nowiki>{{army|Spain}}</nowiki></kbd> → {{army|Spain}}
*<kbd><nowiki>{{army|France}}</nowiki></kbd> → {{army|France}}

==Other related templates==
The {{tl|flagicon}} template can be used to display the flag by itself, using the <kbd>army</kbd> variant as a template parameter:
*<kbd><nowiki>{{flagicon|UK|army}}</nowiki></kbd> → {{flagicon|UK|army}}
*<kbd><nowiki>{{flagicon|US|army}}</nowiki></kbd> → {{flagicon|US|army}}
*<kbd><nowiki>{{flagicon|Empire of Japan|army}}</nowiki></kbd> → {{flagicon|Empire of Japan|army}}
*<kbd><nowiki>{{flagicon|ROC|army}}</nowiki></kbd> → {{flagicon|ROC|army}}

==Implementation notes==
By default, this template shows the standard national flag for the selected country, following by a wikilink to "''Country'' Army".  Either or both of these items can be changed by adding specific parameters to the appropriate <kbd>country_data</kbd> template (complete set found in [[:Category:Country data templates]]).

To use a different flag, such as an army-specific flag for the nation, use:
:<kbd>flag alias-army = ''image name''</kbd>
To use a different name for the wikilinked army article, use:
:<kbd>link alias-army = ''article name''</kbd>

<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Flag template system]]
[[Category:Army templates]]
</includeonly>
== Template Data ==
{{TemplateDataHeader}}
<templatedata>
{
	"params": {
		"1": {
			"label": "nation",
			"description": "Use either the name of the nation or the three-letter ISO 3166-1 alpha-3 country code",
			"required": true,
			"example": "\"Taiwan\", \"USA\", \"CHN\", \"French Republic\", \"MEX\"",
			"type": "line"
		},
		"2": {
			"aliases": [
				"variant"
			],
			"label": "variant",
			"description": "Specifies an alternate (historical) army flag to use. This parameter is documented by the appropriate template in [[Category:Country data templates]]. Note that the standard behaviour of this template is to use the <code>army</code> variant if present, so there is no need to specify this variant in the template call.",
			"type": "line"
		},
		"size": {
			"description": "(optional) Can be used to change the flag icon size",
			"type": "string"
		},
		"name": {
			"description": "(optional) Can be used to change the wikilink display text",
			"type": "line"
		}
	},
	"description": "Produces a flag icon attached to a wikilinked national army article.",
	"format": "inline"
}
</templatedata>