Module:Flags/doc

From blackwiki
Jump to navigation Jump to search

This is the documentation page for Module:Flags

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". Flag of Andorra.svg
  • 2 letter code - link points to full name: "AD" Flag of Andorra.svg
  • 3 letter code - link points to full name: "AND" Flag of Andorra.svg
  • Nepal and Ohio flags are shown without border. Flag of Nepal.svg 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". Flag of Berlin.svg Flag of WHO.svg
  • Size as in "size=44px" or "size=40x44px" can be defined in any position. Flag of Andorra.svg Flag of Nepal.svg
  • Nepal, Switzerland and Vatican City have a default size of 20x17px (for the rest it's 20x22px): Flag of Nepal.svg Flag of Switzerland.svg Flag of the Vatican City.svg
  • Variants for historical flags "1901" Flag of Afghanistan (1901–1919).svg or "variant=1901" (for compatibility reasons) Flag of Afghanistan (1901–1919).svg
  • Variants for labeled flags: "naval", "air force" and any other specified at FlagTranslations: "civil" Civil Ensign of the United Kingdom.svg - "naval-RMAS" British Royal Maritime Auxiliary Ensign.svg
  • Variant / label flags not found in FlagTranslations return the Flag of None but still point to the right article: "whatever" Flag of None.svg - "quatsch" Flag of None.svg
  • Redirects (different names pointing to a same flag) are supported: "GB" Flag of the United Kingdom.svg - "UK" Flag of the United Kingdom.svg
  • Full Commons filenames can be defined in tables when they don't follow the "Flag of " syntax: "File:Flag Belgium brussels" Flag Belgium brussels.svg
  • Localization: "Illes Balears" Flag of the Balearic Islands.svg - "中華人民共和國" 23px
  • Localization + variants: "Afganistan" + "1901" Flag of None.svg - "Regne Unit" + "civil" Flag of None.svg
  • Flags listed only in FlagTranslations always link to the local language article: parameter "Native Peoples of Colombia" 23px 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.