Jump to content

Template:Flags/doc

From Wikipedia, the free encyclopedia

Description

[edit]

This template provides a clickable icon flag with options to define the size, the link and the label. Its usage is especially recommended in articles with many icon flags.

This project is under development. The functionality is solid but you might miss certain flags. See Where is my flag?

Examples: ca:Estats membres de la Unió Europea - ca:Jocs Olímpics - ca:Futbol Club Barcelona - ca:Temporada 2011 de Fórmula 1 - ca:Torneig de Roland Garros 2009

Usage

[edit]

{{Flags|name|variant|size=|text=|link=}}

name
The first parameter identifies the name of the territory represented by the flag. It is required and must be specified in the first position. It can accept three formats:
  • Full names in English and an optional local language: {{Flags|Andorra}} provides
  • 2 letter codes according to ISO 3166-1 alpha-2: {{Flags|AD}} provides
  • 3 letter codes according to ISO 3166-1 alpha-3: {{Flags|AND}} provides
variant
Optional parameter to define historic flags, militar or with other specific uses. It is possible to combine two types of variants:
  • Year: {{Flags|Andorra|1806}} or {{Flags|Andorra|variant=1806}} provides /
  • Type: {{Flags|Regne Unit|naval-RMAS}} provides
size
Optional parameter to modify the size of the flag. It accepts the usual parameters for maximum sizes of images, keeping the original aspect ratio of the flag:
  • {{Flags|Andorra|size=44px}} provides
text
Optional parameter to define a label including a link. When no specific text is defined then the label is the name of the flag:
  • {{Flags|Andorra|text=}} provides Andorra and {{Flags|Andorra|text=Principat d'Andorra}} provides Principat d'Andorra
link
Optional parameter to define a link. When no specific link is define then the link of the flag (and of the label, if any) is removed:
  • {{Flags|Basque Country|link=Basque Country (autonomous community)}} provides and {{Flags|Basque Country|link=|text=}} provides the Basque Country

Where is my flag?

[edit]

When the template doesn't recognize the name of the flag then it returns 20x22px or

Possible reasons:

In these cases, the template makes a last attempt tryingto find "File:Flag of [name].svg" at Commons.

If you find 20x22px or please report the problem at Module talk:Flags and we will fix it.

You can also contribute adding names and flags to MasterData (and LocaleData in your non-English wiki), keeping the consistency with Category:Country data templates. It's easy and it doesn't require any technical knowledge.

Development

[edit]

This template is based on Wikipedia:Lua and is under development. Feedback and feature requests are welcome at Module talk:Flags.

The functionality is provided by Module:Flags.

Module:Flags/MasterData must be published as is in any other wiki, and any changes must be synced here.

LocaleData is specific to wikis of each language. Here we have only an example.