Template:Flag/doc

From Fantasipedia
Jump to navigation Jump to search

Template:Mbox

This template is used to display a small flag icon next to a wikilinked country name. It is related to the {{flagicon}}, {{flagcountry}} and {{flagu}} templates, but offers more options in terms of the text string displayed.

See Wikipedia:WikiProject Flag Template for the main documentation/discussion page for the flag templates system.

Usage[edit]

{{flag|country identifier|optional variant|name=alternative text string|size=maximum width and/or height of the flag image}}

  • country identifier is the common name of the country (e.g. "United States"), a common alias (e.g. "US"), or a standard country code such as those listed at ISO 3166-1 alpha-3
  • variant is an optional second parameter that can be used to display a flag variation, such as a historical flag. The list of variants for each country is documented on the appropriate template page, such as Template:Country data Germany
  • alternative text string, this optional value, specified by the name parameter, is used to display alternative text
  • size, this optional value is specified by the size parameter, and is used to specify the maximum width and/or height of the flag image. This parameter is specified using standard image syntax.

See the prefix index for the templates latently called by this one.

TemplateData[edit]

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly error report for this template.

TemplateData for Flag

<TemplateData> {

       "description": "This template displays a small flag icon next to a wikilinked country name",
       "params": {
               "1": {
                       "label": "Country identifier",
                       "description": "Common name of the country (e.g. 'United States'), a common alias (e.g. 'US'), or a standard country code",
                       "type": "string",
                       "required": true
               },
               "2": {
                       "label": "Variant",
                       "description": "Identifies a flag variant to be used instead of the standard flag, e.g. 1815",
                       "type": "string",
                       "required": false
               },
               "name": {
                       "label": "Alternative text",
                       "description": "Display alternative text instead of the standard country name",
                       "type": "string",
                       "required": false
               },
               "size": {
                       "label": "Maximum dimension",
                       "description": "The maximum width or height, specified via standard 'extended image syntax' (e.g. x30px)",
                       "type": "string",
                       "required": false
               }
       }

} </TemplateData>

See: Wikipedia:Extended image syntax.

See also[edit]

Template Description Example
{{Coat of arms}} displays coat of arms image  Evergreen
{{Flagcountry}} always expands the link text to the full country name  Evergreen
{{Flagu}} does not link the country name  Evergreen
{{Flagicon}} displays the flag only, linked to the country name Evergreen
{{Flagdeco}} displays an unlinked flag icon only
{{Flagc}} links the flag image to its description page flag Evergreen
{{Flaglist}} aligns country names correctly in vertical lists (see that template's documentation)  Evergreen
{{Flagteam}} adds country code in parentheses after linked country name  Evergreen (EVG)
{{Flagathlete}} displays the flag and another name, followed country name or code  Someone (EVG)
{{Flagmedalist}} displays the flag and a name, above linked country name and code Someone
 Evergreen

Multi-sport templates[edit]

Output style → Country name Country (code) Athlete (country) Athlete
Country
Country code
Olympic Games {{FlagIOC}} {{FlagIOCteam}} {{FlagIOCathlete}} {{FlagIOCmedalist}} {{FlagIOCshort}}
Other games {{FlagIOC2}} {{FlagIOC2team}} {{FlagIOC2athlete}} {{FlagIOC2medalist}} {{FlagIOC2short}}
Paralympic Games {{FlagIPC}} {{FlagIPCteam}} {{FlagIPCathlete}} {{FlagIPCmedalist}} {{FlagIPCshort}}
Pan American {{FlagPASO}} {{FlagPASOteam}} {{FlagPASOathlete}} {{FlagPASOmedalist}}
Parapan American {{FlagPPASO}}
Commonwealth {{FlagCGF}} {{FlagCGFteam}} {{FlagCGFathlete}} {{FlagCGFmedalist}}
Southeast Asian {{FlagSEAGF}} {{FlagSEAGFteam}} {{FlagSEAGFathlete}} {{FlagSEAGFmedalist}}
World Games {{FlagIWGA}}
Central American and Caribbean Games {{FlagCAC}}
Asian Games {{FlagOCA}}
"Nation at Championships"-style {{Flaglinkteam}} {{FlagATHCHathlete}}
Generic {{Flag}} {{Flagteam}} {{Flagathlete}} {{Flagmedalist}}
Generic (variant) {{Flaglink}} {{Flaglinkmedalist}}