View source for Template:Flaglist/doc

{{Documentation subpage}}
{{Lua|Module:Flaglist}}
This template is identical to [[Template:Flag]] except that the names are aligned correctly with flag icons of different widths. It is for use in lists of countries, states, provinces, etc.. See the [[Template:Flag/doc|documentation of Template:Flag]] for general documentation and available parameters.

== Examples ==

{| width="50%" 
! style="text-align:left;" | Example country table using {{tl|flaglist}} and table=yes parameter
! style="text-align:left;" | Example country list using {{tl|flaglist}}
! style="text-align:left;" | Example country list using {{tl|flag}}
|-
|
{| border=1
|-
|{{flaglist|Paraguay}}
|-
|
{{flaglist|San Marino|table=yes}}
|-
|{{flaglist|Palau}}
|-
|{{flaglist|Australia}}
|-
|{{flaglist|Nepal}}
|-
|{{flaglist|Brazil}}
|-
|{{flaglist|Iran}}
|-
|{{flaglist|Switzerland}}
|-
|{{flaglist|Qatar}}
|-
|{{flaglist|China}}
|-
|{{flaglist|Niger}}
|-
|{{flaglist|Bosnia-Herzegovina|table=yes}}
|-
|
{{flaglist|Socialist Republic of Romania|1948|table=yes}}
|-
|
{{flaglist|USSR|table=yes}}{{flaglist|Hungarian People's Republic|table=yes}}{{UKR}}
|}
|
*{{flaglist|Paraguay}}
*{{flaglist|San Marino}}
*{{flaglist|Palau}}
*{{flaglist|Australia}}
*{{flaglist|Nepal}}
*{{flaglist|Brazil}}
*{{flaglist|Iran}}
*{{flaglist|Switzerland}}
*{{flaglist|Qatar}}
*{{flaglist|China}}
*{{flaglist|Niger}}
*{{flaglist|Bosnia-Herzegovina}}
*{{flaglist|Socialist Republic of Romania|1948}}
|
*{{flag|Paraguay}}
*{{flag|San Marino}}
*{{flag|Palau}}
*{{flag|Australia}}
*{{flag|Nepal}}
*{{flag|Brazil}}
*{{flag|Iran}}
*{{flag|Switzerland}}
*{{flag|Qatar}}
*{{flag|China}}
*{{flag|Niger}}
*{{flag|Bosnia-Herzegovina}}
*{{flag|Socialist Republic of Romania|1948}}
|}

{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{flaglist|Georgia (U.S. state)|name=Georgia}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{flaglist|Germany}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{flaglist|Germany|empire}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{flaglist|Romania}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{flaglist|Romania|1948}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{flaglist|Socialist Republic of Romania}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{flaglist|Socialist Republic of Romania|short=yes}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{flaglist|UN}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{flaglist|World}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{flaglist|ITA}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{flaglist|SUI}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{flaglist|Switzerland}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{flaglist|Union of Soviet Socialist Republics|table=yes}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{flaglist|ITA|size=46x30px}}</nowiki>}}
{{nowiki template demo|format=inline|output=nowiki+|code=<nowiki>{{flaglist|SUI|size=46x30px}}</nowiki>}}

== How it works ==
{{Lua|Module:Flaglist}}

{{tl|Flag}} generates a flag icon, a non-breaking space and the country link, which means the alignment of the link depends on the width of the flag image. The default size for flag icons is 23x15px, so the icon width is 23px for long flags but smaller for more squarish flags such as those of [[Flag of San Marino|San Marino]] and [[Flag of Niger|Niger]] (any flag with an [[List of national flags by aspect ratio|aspect ratio]] less than {{math|{{sfrac|23|15}} &asymp; 1.53}}), misaligning the country links next to them. The {{tl|Flag/core}} template, used internally by {{((}}flag{{))}}, compensates for this for Nepal, Vatican City and Switzerland by inserting some extra spaces, though for several other countries the link is still shifted too far to the left, as seen above.

{{tl|Flaglist}} puts a flag icon inside an invisible &lt;[[Span tag|span]]&gt; box with a fixed width calculated by [[Module:Flaglist]]. The width does not depend on the exact dimensions of the image, but does vary with the maximum width and height specified using [[WP:EIS|extended image syntax]]. The default size for most countries' flags is 23x15px; the {{para|size}} parameter can be used if a different size is wanted. [[:Category:Country data templates with distinct default size|Some entities]] have different defaults specified within their data templates and may output misaligned links even if {{para|size}} is not used.

If a maximum width is specified (whether both width and height, e.g. <kbd>20x10px</kbd>, or width only, e.g. <kbd>20px</kbd>), either using the {{para|size}} parameter or the data template default, the box size is equal to this width plus seven pixels. If a height is specified but a width is not (<kbd>x10px</kbd>), a box width of 2.2 times the height plus seven pixels is used. In the latter case, flags with an aspect ratio greater than 2.2 (the only such current national flag being [[Flag of Qatar|that of Qatar]]) may extend beyond the invisible box and overlap the country link at certain sizes, as seen in the table below. For this reason, if an icon size different from the default is wanted, it is best to always specify both a width and a height. This also ensures that neither squarish nor long flags are rendered much bigger than other flags.

<templatedata>
{
	"params": {
		"1": {
			"label": "Country",
			"description": "Display the small flag icon of this country. A flag will only be displayed if the related template {{country data ⟨1⟩}} exists with the ⟨flag alias⟩ parameter (otherwise a transparent placeholder is used to preserve text alignment inside lists).",
			"example": "Germany",
			"type": "string",
			"required": true
		},
		"2": {
			"aliases": [
				"variant"
			],
			"label": "Flag variant",
			"description": "Name of a variant that is configured in the country data template to display a flag variation, such as a historical flag.",
			"example": "empire",
			"type": "string"
		},
		"name": {
			"description": "Custom name to be displayed instead of ⟨1⟩.",
			"type": "string",
			"label": "Custom name"
		},
		"size": {
			"description": "Custom size of the flag icon.",
			"example": "x25px",
			"type": "string",
			"default": "23x15px",
			"label": "Custom flag size"
		},
		"short": {
			"label": "Short name",
			"description": "Display the ⟨shortname alias⟩ that is configured in the country data template, instead of the name given with ⟨1⟩ or ⟨name⟩. If there is no shortname alias, then ⟨alias⟩ from the country data template is used.",
			"example": "yes",
			"type": "boolean",
			"default": "no",
			"suggested": true
		},
		"table": {
			"label": "Table alignment",
			"description": "Align country names that wrap across multiple lines next to the flag icon (by creating a table). Currently only for use within tables.",
			"example": "yes",
			"type": "boolean",
			"default": "no",
			"suggested": false
		}
	},
	"paramOrder": [
		"1",
		"name",
		"short",
		"2",
		"size",
        "table"
	],
	"description": " "
}
</templatedata>

== Usage with custom size ==
{| class="wikitable" style="width:65%"
|-
! width="10%" | {{para|size}} value
! width="20%" | {{tl|flag}} output
! width="20%" | {{tl|flaglist}} output
! width="20%" | {{tl|flaglist}} with table=yes output
|-
! 10px
|
*{{flag|Qatar|size=10px}}
*{{flag|Palau|size=10px}}
*{{flag|Switzerland|size=10px}}
*{{flag|Union of Soviet Socialist Republics|size=10px}}
|
*{{flaglist|Qatar|size=10px}}
*{{flaglist|Palau|size=10px}}
*{{flaglist|Switzerland|size=10px}}
*{{flaglist|Union of Soviet Socialist Republics|size=10px}}
|
{|
|-
|{{flaglist|Qatar|size=10px}}
|-
|{{flaglist|Palau|size=10px}}
|-
|{{flaglist|Switzerland|size=10px|table=yes}}
|-
|{{flaglist|Union of Soviet Socialist Republics|size=10px|table=yes}}
|}
|-
! x8px
|
*{{flag|Qatar|size=x8px}}
*{{flag|Palau|size=x8px}}
*{{flag|Switzerland|size=x8px}}
*{{flag|Union of Soviet Socialist Republics|size=x8px}}
|
*{{flaglist|Qatar|size=x8px}}
*{{flaglist|Palau|size=x8px}}
*{{flaglist|Switzerland|size=x8px}}
*{{flaglist|Union of Soviet Socialist Republics|size=x8px}}
|
{|
|-
|{{flaglist|Qatar|size=x8px}}
|-
|{{flaglist|Palau|size=x8px}}
|-
|{{flaglist|Switzerland|size=x8px|table=yes}}
|-
|{{flaglist|Union of Soviet Socialist Republics|size=x8px|table=yes}}
|}
|-
! 10x8px
|
*{{flag|Qatar|size=10x8px}}
*{{flag|Palau|size=10x8px}}
*{{flag|Switzerland|size=10x8px}}
*{{flag|Union of Soviet Socialist Republics|size=10x8px}}
|
*{{flaglist|Qatar|size=10x8px}}
*{{flaglist|Palau|size=10x8px}}
*{{flaglist|Switzerland|size=10x8px}}
*{{flaglist|Union of Soviet Socialist Republics|size=10x8px}}
|
{|
|-
|{{flaglist|Qatar|size=10x8px}}
|-
|{{flaglist|Palau|size=10x8px}}
|-
|{{flaglist|Switzerland|size=10x8px|table=yes}}
|-
|{{flaglist|Union of Soviet Socialist Republics|size=10x8px|table=yes}}
|}
|-
! 35px
|
*{{flag|Qatar|size=35px}}
*{{flag|Palau|size=35px}}
*{{flag|Switzerland|size=35px}}
*{{flag|Union of Soviet Socialist Republics|size=35px}}
|
*{{flaglist|Qatar|size=35px}}
*{{flaglist|Palau|size=35px}}
*{{flaglist|Switzerland|size=35px}}
*{{flaglist|Union of Soviet Socialist Republics|size=35px}}
|
{|
|-
|{{flaglist|Qatar|size=35px}}
|-
|{{flaglist|Palau|size=35px}}
|-
|{{flaglist|Switzerland|size=35px|table=yes}}
|-
|{{flaglist|Union of Soviet Socialist Republics|size=35px|table=yes}}
|}
|-
! x25px
|
*{{flag|Qatar|size=x25px}}
*{{flag|Palau|size=x25px}}
*{{flag|Switzerland|size=x25px}}
*{{flag|Union of Soviet Socialist Republics|size=x25px}}
|
*{{flaglist|Qatar|size=x25px}}
*{{flaglist|Palau|size=x25px}}
*{{flaglist|Switzerland|size=x25px}}
*{{flaglist|Union of Soviet Socialist Republics|size=x25px}}
|
{|
|-
|{{flaglist|Qatar|size=x25px}}
|-
|{{flaglist|Palau|size=x25px}}
|-
|{{flaglist|Switzerland|size=x25px|table=yes}}
|-
|{{flaglist|Union of Soviet Socialist Republics|size=x25px|table=yes}}
|}
|-
! 35x25px
|
*{{flag|Qatar|size=35x25px}}
*{{flag|Palau|size=35x25px}}
*{{flag|Switzerland|size=35x25px}}
*{{flag|Union of Soviet Socialist Republics|size=35x24px}}
|
*{{flaglist|Qatar|size=35x24px}}
*{{flaglist|Palau|size=35x24px}}
*{{flaglist|Switzerland|size=35x24px}}
*{{flaglist|Union of Soviet Socialist Republics|size=35x24px}}
|
{|
|-
|{{flaglist|Qatar|size=35x24px}}
|-
|{{flaglist|Palau|size=35x24px}}
|-
|{{flaglist|Switzerland|size=35x24px|table=yes}}
|-
|{{flaglist|Union of Soviet Socialist Republics|size=35x24px|table=yes}}
|}
|}

<includeonly>{{Sandbox other||
[[Category:Flag template system]]

}}</includeonly>