ମଡ୍ୟୁଲ:Flagg/doc

{{Flagg}} (flag general) is a flag template with variable output format. Using Lua instead of the standard mechanism, it allows overriding the image name and link target, and works even if a country data template for an entity does not exist (without using any expensive functions).

The template is not intended to fully supersede any specific flag templates it can simulate (see below), but can be useful for formats for which no template exists, or if its additional options are needed.

Parameters

Aliases (alternatives) for each parameter or value are given in square brackets.

Format (first unnamed parameter)

The first parameter is an alphabetic code specifying the output format. The first letter concerns the image, the second the separator, and the third the country name. The parameter is fully case-insensitive.

If any position in the parameter value is missing or has a character not corresponding to an option below, the options marked as default will be used; e.g. a first parameter equal to i, i** or izz will be read as isc.

First letter: Image

Letter	Meaning	Description	Example
u	unlinked	Image is not linked (default).	{{flagg|uxx|France}} →
c	country	Image links to country/entity page.	{{flagg|cxx|France}} →
p [f]	prefix/suffix	Image links to country name with prefixed and/or suffixed text (default "Flag of ..."), set using |pref= and |suff= (see below).	{{flagg|pxx|France}} →
i	image page	Image links to file description page; use this for non-public-domain images, for which attribution is required.	{{flagg|ixx|France}} →
d	data template	Image links to the used country data template, for use in discussion/documentation. Automatically adds redirect=no if link is a redirect.	{{flagg|dxx|France}} →
x	X mark	No image is displayed. If the second letter is anything other than x, and o is not set, an unlinked transparent image is actually used to preserve the spacing.	{{flagg|xnx|France}} →

Second letter: Separator

Letter	Meaning	Description	Example
s	span box	The flag image is put in a fixed-width <span> tag, meaning the country names are aligned in vertical lists; see documentation of {{Flaglist}} (default).	{{flagg|usu|Niger}} →  Niger
n	non-breaking space	A non-breaking space (&nbsp;) is used, like in most flag templates, including {{flag}}. Note that &nbsp; does not actually prevent wrapping between image and text in all browsers; use w as described below if needed.	{{flagg|unu|Niger}} → Niger
l	line break	A line break (<br/>) is used as separator.	{{flagg|ulu|Niger}} → Niger
t	table cell	A table cell separator (two pipes) is used.		Niger
x	X mark	No separator is used.	{{flagg|uxu|Niger}} → Niger

Third letter: Name

Letter	Meaning	Description	Example
c	country	The country name links to the main country/entity page (default).	{{flagg|xxc|Chile}} → Chile
p	prefix/suffix	The country name links to the country page with prefixed or suffixed text (default "Flag of ..."), set using |pref= and |suff= (see below).	{{flagg|xxp|Chile}} → Chile
f	full prefix/suffix	Same as p, except that the prefix and/or suffix is/are displayed.	{{flagg|xxf|Chile}} → Flag of Chile
b	both country and prefix/suffix	Combined country link and prefix/suffix link: country name links to country page, while prefix and/or suffix link(s) to prefixed/suffixed title.	{{flagg|xxb|Chile}} → Flag of Chile
u	unlinked (cf. {{flagu}})	The country name is displayed as plain text, without link.	{{flagg|xxu|Chile}} → Chile
d	data template	Country name is linked to the used country data template, for use in discussion/documentation. Automatically adds redirect=no if a redirect is used.	{{flagg|xxd|Chile}} → Chile
x	X mark	No text is displayed.	{{flagg|xxx|Chile}} →

Some additional options can be enabled by appending the following letters to the three-letter code in any order:

Letter	Description	Example
a	Adds the country name (the "name" parameter, or if unset the second unnamed parameter) as alt text and mouseover for the image. If |alt= is used for a custom alt/mouseover text, this does not need to be separately set.	{{flagg|uxxa|Pakistan}} →
b	Blanks the text portion if a flag is not found.	{{flagg|uncb|Xanadu}} → Compare with: {{flagg|unc|Xanadu}} → Xanadu
e	Uses the name set in the country data template (rather than the first parameter) as display name, like in {{flagcountry}} (i.e. expands abbreviated forms).	{{flagg|unue|PAK}} → Pakistan
f	If the prefixed/suffixed article name doesn't exist, fallback to linking to the non-prefixed/suffixed page. This may be expensive, and the number of time it can be used on single page is limited.	{{flagg|psff|Egypt|pref=Flag templates in}} →  Flag templates in Egypt Compare with: {{flagg|psf|Egypt|pref=Flag templates in}} →  Flag templates in Egypt
l	Adds the link name (as defined by the "image" parameter) as alt text and mouseover for the image. If |alt= is used for a custom alt/mouseover text, this does not need to be separately set.	{{flagg|cxxl|PAK}} → Compare with: {{flagg|cxxa|PAK}} →
o	Omits the image and spacing in case the image is an invisible placeholder, i.e., only include the spacing if a flag is displayed. Useful for inline/standalone usages or horizontal lists, where name alignment is not needed.	{{flagg|unuo|Pakistan|image=}} → Pakistan Compare with: {{flagg|unu|Pakistan|image=}} → Pakistan
r	Reverses the order of the elements, putting the image to the right of the name; cf. {{flagright}}. Doesn't affect the order of letters in the format code.	{{flagg|uncr|Pakistan}} → Pakistan
w	Avoids wrapping by adding <span class="nowrap">...</span> around the output.	{{flagg|unuw|Pakistan}} → Pakistan

Entity (second unnamed parameter)

The second parameter is the country or entity name. The template attempts to read the flag and link data from "Template:Country data country"; if that does not exist, the same parameter will be used as default country link and no automatic image will be displayed. The parameter also defines the default displayed country name, if the e option above is not used.

Image parameters

|variant= [third unnamed parameter]

Specifies a variant flag image, as defined and documented in each entity's data template. For example, {{flagg|ixx|Germany|naval}} → uses the "naval" variant of Template:Country data Germany.

|image=

Custom image name, with or without the "File:" namespace prefix. Can be used if the wanted image is not available as variant for the entity (you can alternatively request it be added at the respective data template's talk page), or if no data template exists. Set to "none" ["blank", empty string] to use an unlinked transparent image (functionally identical to the x format).

|size= [|sz=]

Sets the image size; default is 23×15 pixels (larger for some entities). You can use an explicit size in pixels (e.g. 30x20px; the "px" suffix is optional) or one of the relative sizes "xs" (half the default dimensions), "s", "m", "l" and "xl" (twice the default size).

|border=

By default, the flag icon includes a border, except if it is disabled in the entity's country data template. |border= can be set to "yes" ["y", "1"] to force a border when excluded by default, or "no" ["n", "0", empty string] to prevent one.

|align= [|al=]

Set to "left" ["l"], "center" ["centre", "c", "middle", "m"] or "right" ["r"] to set the alignment of the image for the span box (s) and table cell (t) formats. For t, the default is center; for s, it is right-aligned if r is set, else left-aligned.

|width= [|w=]

Sets the width of the span box surrounding the image for the span box (s) format, in pixels, without the "px" suffix. The default is calculated by Module:Flaglist and depends on the image size.

|alt=

Sets alt text and mouseover text for the flag image, if it is for information rather than just decoration. If the wanted text is equal to the entity name, use the a option described above.

|ilink=

Overrides the link target of the image (only use if none of the image formats above allow linking to the desired page).

|noredlink=no

Displays a red link to the missing country data template instead of a placeholder image. Defaults to "yes" (no red link displayed).

|missingcategory=category name

Adds the page to category name if the image if the country data is missing.

Text and link parameters

|name=

Changes the displayed country name. Note that with the f format, this includes the prefix and/or suffix.

|clink= [|link=]

Overwrites the link to the country article; this is also used to construct the prefix/suffix link for the f, p and b options.

|pref=, |suff=, |plink=

|pref= and |suff= set the prefix and suffix to use for the prefix/suffix links (format letters f, p and b). The default, if neither is specified, is "Flag of" as prefix (cf. {{flagof}}) and no suffix. |plink= can be used to override the combined link.

|the=

Set to "yes" ["y", "1"] to include the article "the" before the country name in the prefix/suffix links. Example: {{flagg|usf|Philippines|the=1}} →  Flag of the Philippines. Use |pthe= if the link needs "the" but the name doesn't, and |nthe= if the name needs it but the link doesn't.

|section=

Links to a section of the linked article without displaying the section name. If both a country link and a prefix/suffix link are used, use |csection= for a section of the country article, and |psection= for a section of the prefixed/suffixed article.

|altvar= [|avar=], |age=

Enables using one of a set of standard suffixes for linking to sports teams and militaries. The altvar and suffix data is loaded from Module:Flagg/Altvar data. The possible parameter values are the base names of the corresponding specialized templates; alias values from full sports names exist (see examples below and data page). For some entities this also changes the image to a variant specific to a sport or military branch; for example, {{flagg|usp|Ireland|avar=ru}} →  Ireland uses the IRFU flag to represent the Irish rugby union team. For youth teams in some sports (see the data page), the age limit must be additionally set using |age=.

|nalign= [|nal=]

Sets the alignment of the text in table cell format (t). The default is left; the possible values are the same as for |align=.

|text=

Overrides the entire text; only use when necessary for any nonstandard formats. Alternatively, you can set the third letter of the format parameter to x (no text) and add custom text outside the template.

|nodata=y

Overrides attempts to use the corresponding {{country data ...}} template, which is useful when the corresponding data template doesn't exist.

Examples

Formats:

• {{flagg|usc|Fiji}} →  Fiji (default format)
• {{flagg||Fiji}} →  Fiji (default format)
• {{flagg|pnbr|Fiji}} → Flag of Fiji
• <span style="display:inline-block;text-align:center;">{{flagg|ilf|Fiji|sz=xl}}</span> → Flag of Fiji

Table format & alignment:

{{flagg|utu|Jamaica}}		Jamaica
{{flagg|utur|Jamaica}}	Jamaica
{{flagg|utu|Jamaica|al=l|nal=l}}		Jamaica
{{flagg|utu|Jamaica|al=c|nal=c}}		Jamaica
{{flagg|utu|Jamaica|al=r|nal=r}}		Jamaica

• {{flagg|usu|Switzerland}} →  Switzerland
• {{flagg|usu|Switzerland|al=l}} →  Switzerland
• {{flagg|usu|Switzerland|al=c}} →  Switzerland
• {{flagg|usu|Switzerland|al=r}} →  Switzerland

Standard image & name parameters:

• {{flagg|isc|Myanmar}} →  Myanmar
• {{flagg|isc|Myanmar|border=}} →  Myanmar
• {{flagg|isc|Myanmar|1974}} →  Myanmar
• {{flagg|isc|Myanmar|variant=1974}} →  Myanmar
• {{flagg|isc|Myanmar|name=Burma|variant=1974}} →  Burma
• {{flagg|isc|Burma|variant=1974}} →  Burma
• {{flagg|isc|Myanmar|sz=30}} →  Myanmar
• {{flagg|isc|Myanmar|size=30}} →  Myanmar
• {{flagg|isc|Myanmar|size=30px}} →  Myanmar
• {{flagg|isc|Myanmar|size=30x18px}} →  Myanmar
• {{flagg|isc|Myanmar|size=xs}} →  Myanmar
• {{flagg|isc|Myanmar|size=xl}} →  Myanmar
• {{flagg|isc|Myanmar|width=30|size=xs}} →  Myanmar
• {{flagg|isc|Myanmar|image=}} →  Myanmar
• {{flagg|isc|Myanmar|image=Flag of None.svg}} →  Myanmar
• {{flagg|isc|Myanmar|image=File:Flag of None.svg}} →  Myanmar

Links and altvars:

• {{flagg|psp|Egypt}} →  Egypt
• {{flagg|psf|Egypt}} →  Flag of Egypt
• {{flagg|psb|Egypt}} →  Flag of Egypt
• {{flagg|psb|Philippines|the=1}} →  Flag of the Philippines
• {{flagg|csc|Egypt|section=History}} →  Egypt
• {{flagg|csb|Egypt|csection=History}} →  Flag of Egypt
• {{flagg|psb|Egypt|psection=Kingdom of Egypt (1922–1953)|variant=1922}} →  Flag of Egypt
• {{flagg|psb|Egypt|plink=List of Egyptian flags}} →  Flag of Egypt
• {{flagg|psf|Egypt|pref=History of}} →  History of Egypt
• {{flagg|psp|Egypt|suff=at the Olympics}} →  Egypt
• {{flagg|psp|Egypt|avar=fb}} →  Egypt
• {{flagg|psp|Egypt|avar=football}} →  Egypt
• {{flagg|psp|Egypt|avar=fbu|age=20}} →  Egypt
• {{flagg|psf|Egypt|avar=navy}} →  Egypt Navy

Non-existing data template:

• {{flagg|isc|Belfast|nodata=1}} →  Belfast
• {{flagg|isc|Belfast|image=Flag of Belfast.svg|nodata=1}} →  Belfast

Comparison with other templates

These "specialized" templates predate Flagg, and while most do not have options for custom links and images, they are probably faster because they only do two transclusions without invoking Lua.

General templates

Template	Corresponding {{flagg}} syntax	Example
{{flag|country}}	{{flagg|uncb|country}}	{{flag|China}} → China {{flagg|unc|China}} → China
{{flagbig|country}}	{{flagg|ulc|country|sz=l}}	{{flagbig|China}} → ଚୀନ {{flagg|ulc|China|sz=l}} → China
{{flagc|country}}	{{flagg|inc|country}}	{{flagc|China}} → China {{flagg|inc|China}} → China
{{flagcountry|country}}	{{flagg|unce|country}}	{{flagcountry|CHN}} → ଚୀନ {{flagg|unce|CHN}} → ଚୀନ
{{flagdeco|country}}	{{flagg|uxxo|country}}	{{flagdeco|China}} → {{flagg|uxx|China}} →
{{flagicon|country}}	{{flagg|cxxlo|country}}	{{flagicon|China}} → {{flagg|cxxlo|China}} →
{{flagicon image|image}}	{{flagg|uxx|image=image}}	{{flagicon image|Flag of China.svg}} → {{flagg|uxx|image=Flag of China.svg}} →
{{flaglink|country|suffix}}	{{flagg|unp|country|suff=suffix}}	{{flaglink|China|at the Hopman Cup}} → ଚୀନ {{flagg|unp|China|suff=at the Hopman Cup}} → China
{{flag+link|prefix|country}}	{{flagg|unp|country|pref=prefix}} (no existence check)	{{flag+link|Agriculture in|China}} →  ଚୀନ {{flagg|unp|China|pref=Agriculture in}} → China
{{flaglist|country}}	{{flagg|usc|country}}	{{flaglist|China}} →  China {{flagg|usc|China}} →  China
{{flagof|country}}	{{flagg|unp|country|sz=l}}	{{flagof|China}} → China {{flagg|unp|China|sz=l}} → China
{{flagright|country}}	{{flagg|uncr|country}}	{{flagright|China}} → China  {{flagg|uncr|China}} → China
{{flagu|country}}	{{flagg|unu|country}}	{{flagu|China}} → China {{flagg|unu|China}} → China
{{noflag|country}}	{{flagg|xnu|country}}	{{noflag|China}} → China {{flagg|xnu|China}} → China
{{noflag|[[country]]}}	{{flagg|xnc|country}}	{{noflag|[[China]]}} → China {{flagg|xnc|China}} → China

Sports/military templates

The football templates are used as examples here; other sports that have separate templates work correspondingly.

See also

• User:SiBr₄/Flagg tests — extensive tests of the template's functions, which may also serve as additional examples