Template:Flaglist/doc

This is a documentation subpage for Template:Flaglist.
It may contain usage information, categories and other content that is not part of the original template page.

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

Examples

Example country table using {{flaglist}} and table=yes parameter

Example country list using {{flaglist}}

Example country list using {{flag}}

Paraguay

San Marino

Palau

Australia

Nepal

Brazil

Iran

Switzerland

Qatar

China

Niger

Bosnia-Herzegovina

Socialist Republic of Romania

Soviet Union

Hungarian People's Republic

Ukraine

{{flaglist|Georgia (U.S. state)|name=Georgia}} →

Georgia

<span class="flagicon" style="display:inline-block;width:25px;">[[File:Flag of Georgia (U.S. state).svg|23x15px|border |alt=|link=]]</span>&nbsp;[[Georgia (U.S. state)|Georgia]]

{{flaglist|Germany}} →

Germany

<span class="flagicon" style="display:inline-block;width:25px;">[[File:Flag of Germany.svg|23x15px|border |alt=|link=]]</span>&nbsp;[[Germany|Germany]]

{{flaglist|Germany|empire}} →

Germany

<span class="flagicon" style="display:inline-block;width:25px;">[[File:Flag of the German Empire.svg|23x15px|border |alt=|link=]]</span>&nbsp;[[Germany|Germany]]

{{flaglist|Romania}} →

Romania

<span class="flagicon" style="display:inline-block;width:25px;">[[File:Flag of Romania.svg|23x15px|border |alt=|link=]]</span>&nbsp;[[Romania|Romania]]

{{flaglist|Romania|1948}} →

Romania

<span class="flagicon" style="display:inline-block;width:25px;">[[File:Flag of Romania (1948-1952).svg|23x15px|border |alt=|link=]]</span>&nbsp;[[Romania|Romania]]

{{flaglist|Socialist Republic of Romania}} →

Socialist Republic of Romania

<span class="flagicon" style="display:inline-block;width:25px;">[[File:Flag of Romania (1965–1989).svg|23x15px|border |alt=|link=]]</span>&nbsp;[[Socialist Republic of Romania|Socialist Republic of Romania]]

{{flaglist|Socialist Republic of Romania|short=yes}} →

Romania

<span class="flagicon" style="display:inline-block;width:25px;">[[File:Flag of Romania (1965–1989).svg|23x15px|border |alt=|link=]]</span>&nbsp;[[Socialist Republic of Romania|Romania]]

{{flaglist|UN}} →

UN

<span class="flagicon" style="display:inline-block;width:25px;">[[File:Flag of the United Nations.svg|23x15px|border |alt=|link=]]</span>&nbsp;[[United Nations|UN]]

{{flaglist|World}} →

World

<span class="flagicon" style="display:inline-block;width:25px;">[[File:Flag placeholder.svg|23x15px| |alt=|link=]]</span>&nbsp;[[World|World]]

{{flaglist|ITA}} →

ITA

<span class="flagicon" style="display:inline-block;width:25px;">[[File:Flag of Italy.svg|23x15px|border |alt=|link=]]</span>&nbsp;[[Italy|ITA]]

{{flaglist|SUI}} →

SUI

<span class="flagicon" style="display:inline-block;width:25px;">[[File:Flag of Switzerland (Pantone).svg|23x16px|border |alt=|link=]]</span>&nbsp;[[Switzerland|SUI]]

{{flaglist|Switzerland}} →

Switzerland

<span class="flagicon" style="display:inline-block;width:25px;">[[File:Flag of Switzerland (Pantone).svg|23x16px|border |alt=|link=]]</span>&nbsp;[[Switzerland|Switzerland]]

{{flaglist|Union of Soviet Socialist Republics|table=yes}} →

Union of Soviet Socialist Republics

{| style="margin-left:-3px"
|-
| <span class="flagicon" style="display:inline-block;width:25px;">[[File:Flag of the Soviet Union.svg|23x15px|border |alt=|link=]]</span> 
| style="padding-left:2px;" | [[Soviet Union|Union of Soviet Socialist Republics]]

|}

{{flaglist|ITA|size=46x30px}} →

ITA

<span class="flagicon" style="display:inline-block;width:48px;">[[File:Flag of Italy.svg|46x30px|border |alt=|link=]]</span>&nbsp;[[Italy|ITA]]

{{flaglist|SUI|size=46x30px}} →

SUI

<span class="flagicon" style="display:inline-block;width:48px;">[[File:Flag of Switzerland (Pantone).svg|46x30px|border |alt=|link=]]</span>&nbsp;[[Switzerland|SUI]]

How it works

This template uses Lua:

Module:Flaglist

{{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 $.mw-parser-output .sfrac{white-space:nowrap}.mw-parser-output .sfrac.tion,.mw-parser-output .sfrac .tion{display:inline-block;vertical-align:-0.5em;font-size:85%;text-align:center}.mw-parser-output .sfrac .num{display:block;line-height:1em;margin:0.0em 0.1em;border-bottom:1px solid}.mw-parser-output .sfrac .den{display:block;line-height:1em;margin:0.1em 0.1em}.mw-parser-output .sr-only{border:0;clip:rect(0,0,0,0);clip-path:polygon(0px 0px,0px 0px,0px 0px);height:1px;margin:-1px;overflow:hidden;padding:0;position:absolute;width:1px}⁠23/15⁠ ≈ 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 <span> 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.

Template parameters
Parameter		Description	Type	Status
Country	`1`	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	String	required
Custom name	`name`	Custom name to be displayed instead of ⟨1⟩.	String	optional
Short name	`short`	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. Default no Example yes	Boolean	suggested
Flag variant	`2` `variant`	Name of a variant that is configured in the country data template to display a flag variation, such as a historical flag. Example empire	String	optional
Custom flag size	`size`	Custom size of the flag icon. Default 23x15px Example x25px	String	optional
Table alignment	`table`	Align country names that wrap across multiple lines next to the flag icon (by creating a table). Currently only for use within tables. Default no Example yes	Boolean	optional