Module:Flags/doc

All the logics of Template:Flags are handled here. This module works together with Module:Flags/MasterData and Module:Flags/LocaleData, where the flags data is maintained.

Features

Functionality implemented:

• Full name in English or the locale language: "Andorra". Template:Flags
• 2 letter code - link points to full name: "AD" Template:Flags
• 3 letter code - link points to full name: "AND" Template:Flags
• Nepal and Ohio flags are shown without border. Template:Flags Template:Flags
• When a name is not found in the list, attempts to offer a Commons image and a link e.g. "Berlin" or "WHO". Template:Flags Template:Flags
• Size as in "size=44px" or "size=40x44px" can be defined in any position. Template:Flags Template:Flags
• Nepal, Switzerland and Vatican City have a default size of 20x17px (for the rest it's 20x22px): Template:Flags Template:Flags Template:Flags
• Variants for historical flags "1901" Template:Flags or "variant=1901" (for compatibility reasons) Template:Flags
• Variants for labeled flags: "naval", "air force" and any other specified at FlagTranslations: "civil" Template:Flags - "naval-RMAS" Template:Flags
• Variant / label flags not found in FlagTranslations return the Flag of None but still point to the right article: "whatever" Template:Flags - "quatsch" Template:Flags
• Redirects (different names pointing to a same flag) are supported: "GB" Template:Flags - "UK" Template:Flags
• Full Commons filenames can be defined in tables when they don't follow the "Flag of " syntax: "File:Flag Belgium brussels" Template:Flags
• Localization: "Illes Balears" Template:Flags - "中華人民共和國" Template:Flags
• Localization + variants: "Afganistan" + "1901" Template:Flags - "Regne Unit" + "civil" Template:Flags
• Flags listed only in FlagTranslations always link to the local language article: parameter "Native Peoples of Colombia" Template:Flags links to "Pueblos Indígenas de Colombia"

Roadmap

• Performance testing.
• Extensive testing with copies of real pages, also for non-Latin scripts and Right-to-left languages.
• Cover the rest of functionality offered by other flag templates.
• Allow editors to define the year of the event, leaving to the template the task of finding the right flag.