Template:Flaglist/doc

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 documentation of Template:Flag for general documentation and available parameters.

How it works
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 San Marino and Niger (any flag with an aspect ratio less than $23⁄15 &asymp; 1.53$), misaligning the country links next to them. The 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.

Flaglist puts a flag icon inside an invisible &lt;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 extended image syntax. The default size for most countries' flags is 23x15px; the size parameter can be used if a different size is wanted. Some entities have different defaults specified within their data templates and may output misaligned links even if size is not used.

If a maximum width is specified (whether both width and height, e.g. 20x10px, or width only, e.g. 20px ), either using the 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 ( x10px ), 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 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.

{	"params": { "1": {			"label": "Country", "description": "Display the small flag icon of this country. A flag will only be displayed if the related template 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": " " }

Usage with custom size
{| class="wikitable" style="width:65%" ! width="10%" | size value ! width="20%" | flag output ! width="20%" | flaglist output ! width="20%" | flaglist with table=yes output ! 10px ! x8px
 * 🇶🇦 Qatar
 * 🇵🇼 Palau
 * 🇨🇭 Switzerland
 * Union of Soviet Socialist Republics
 * Union of Soviet Socialist Republics
 * 🇶🇦 Qatar
 * 🇵🇼 Palau
 * 🇨🇭 Switzerland
 * Union of Soviet Socialist Republics
 * Union of Soviet Socialist Republics

! 10x8px ! 35px
 * 🇶🇦 Qatar
 * 🇵🇼 Palau
 * 🇨🇭 Switzerland
 * Union of Soviet Socialist Republics
 * Union of Soviet Socialist Republics
 * 🇶🇦 Qatar
 * 🇵🇼 Palau
 * 🇨🇭 Switzerland
 * Union of Soviet Socialist Republics
 * Union of Soviet Socialist Republics

! x25px ! 35x25px
 * 🇶🇦 Qatar
 * 🇵🇼 Palau
 * 🇨🇭 Switzerland
 * Union of Soviet Socialist Republics
 * Union of Soviet Socialist Republics
 * 🇶🇦 Qatar
 * 🇵🇼 Palau
 * 🇨🇭 Switzerland
 * Union of Soviet Socialist Republics
 * Union of Soviet Socialist Republics


 * }