Template:Flag/doc

This template is used to display a small flag icon next to a wikilinked country name. It is related to the, and  templates, but offers more options in terms of the text string displayed.

See WikiProject Flag Template for the main documentation/discussion page for the flag templates system.

Usage
 country identifier&#124;optional variant&#124;name=alternative text string&#124;size=maximum width and/or height of the flag image 


 * country identifier is the common name of the country (e.g. "United States"), a common alias (e.g. "US"), or a standard country code such as those listed at ISO 3166-1 alpha-3
 * variant is an optional second parameter that can be used to display a flag variation, such as a historical flag. The list of variants for each country is documented on the appropriate template page, such as Template:Country data Germany
 * alternative text string, this optional value, specified by the name parameter, is used to display alternative text
 * size, this optional value is specified by the size parameter, and is used to specify the maximum width and/or height of the flag image. This parameter is specified using standard image syntax.

See the prefix index for the templates latently called by this one.

Alternatives to avoid Wikipedia's Post-expand include size limit
Pages with many flags may come close to or exceed Wikipedia's Post-expand include size limit. In these cases consider using modules or module-wrapper templates instead:
 * For many countries, using the country code as the template name will act as a wrapper for Module:Flagg: For example,  can be replaced with , which has an include size that is about 15% smaller.
 * is a wrapper for Module:Flagg that can further reduce sizes when invoked directly. For basic use,  can be replaced with   which has an include size that is about half.

TemplateData
 {	"description": "This template displays a small flag icon next to a wikilinked country name", "params": { "1": {			"label": "Country identifier", "description": "Common name of the country (e.g. 'United States'), a common alias (e.g. 'US'), or a standard country code", "type": "string", "required": true },		"2": {			"label": "Variant", "description": "Identifies a flag variant to be used instead of the standard flag, e.g. 1815", "type": "string", "required": false, "aliases": [ "variant" ]		},		"name": { "label": "Alternative text", "description": "Display alternative text instead of the standard country name", "type": "string", "required": false },		"size": { "label": "Maximum dimension", "description": "The maximum width or height, specified via standard 'extended image syntax' (e.g. x30px)", "type": "string", "required": false }	},	"format": "inline" } 

See: Extended image syntax.