Template:Flag entry/doc

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

Usage[edit source]

A flag entry consists of a flag image, an optional second flag image below it, and a caption below that. This template relies on data from the country data templates (for example Template:Country data France), though an image can be set manually if such a template does not exist. A full listing of country data templates can be found at Category:All country data templates.

This template should be placed between {{Begin flag gallery}} and {{End flag gallery}} tags. To create a multi-row gallery, the {{New flag row}} template should be used.

General parameters[edit source]

Country: Name of the country or other entity

Optional parameters[edit source]

Image: Name of the flag image (without Image: prefix), to replace the image given by the country data template, or if a relevant country data template doesn't exist
Caption: Text for the caption. Default value is [[Flag of <alias>|Flag of]] [[<alias>|<shortname alias>]], where the article title <alias> and shorthand name <shortname alias> are supplied by the country data template.
Variant: A variant of the state flag. See the relevant country data template for a list of variants.
Width: Width of the entry in pixels (default: 120, suitable for five-across rows). The image height will be limited to half its width.
Alt: Alternative text for the image
Image2: Name of the second flag image (without Image: prefix)
Alt2: Alternative text for the second image
Doublewide: If set, use two columns for flag (use if the flag ratio exceeds 1:2, such as for the flag of Qatar)
NoBorder: If set, don't put a border around image (use for non-rectangular flags such as that of Nepal)
the: If set, add "the" between "Flag of" and the country name in the default caption (parameter name must be lowercase)

Examples[edit source]

Wikicode:

<!-- Start gallery -->
{{Begin flag gallery}}

<!-- Flag and standard caption based on the respective country data template -->
{{Flag entry|Country=Australia}}

<!-- Country subdivisions and other entities not considered countries work too, if a country data template exists -->
{{Flag entry|Country=Texas}}

<!-- Variant image; adding definite article (note the lowercase "the") -->
{{Flag entry|Country=United Kingdom|Variant=naval|the=yes}}

<!-- Custom image and caption, if a country data template does not exist -->
{{Flag entry|Country=Amsterdam|Image=Flag of Amsterdam.svg|Caption=[[Flag of Amsterdam|Flag of]] [[Amsterdam]]}}

<!-- New row in gallery -->
{{New flag row}}

<!-- No border; custom width (height will be half the width, i.e. 80px) -->
{{Flag entry|Country=Nepal|NoBorder=true|Width=160}}

<!-- Double wide (occupies two columns); custom alt text (visible on hover) -->
{{Flag entry|Country=Qatar|Doublewide=true|Alt=National flag of Qatar}}

<!-- Two images with custom widths -->
{{Flag entry|Country=New Caledonia|Image=Flag of New Caledonia.svg|Width=80|Image2=Flag of France.svg|Width2=100}}

<!-- End gallery -->
{{End flag gallery}}

Result: