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