Module:Flags/doc

This is an old revision of this page, as edited by QuimGil (talk | contribs) at 03:14, 25 June 2013 (Features: Keeping the Andorra examples also for 2 letter codes). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

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

Features

Functionality implemented:

  • Full name in English or the locale language: "Andorra".  
  • 2 letter code: "AD"  
  • 3 letter code: "AND"  
  • Nepal and Ohio flags are shown without border.    
  • When a name is not found in the list, attempts to offer a Commons image and a link e.g. "Berlin" or "WHO".    
  • Size as in "size=44px" or "size=40x44px" can be defined in any position.    
  • Nepal, Switzerland and Vatican City have a default size of 20x17px (for the rest it's 20x22px):      
  • 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"  
  • Localization: "Illes Balears"   - "中華人民共和國" 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

What is missing to reach feature parity with Template:Flagicon:

  • m.fullName table needs key and values to become values and keys... As a way to accept different names (aliases) pointing to a same flag.
  • Possibility of defining the full name of a flag in Commons by using "File:" in the table values.
    • Also by users specifying "File:" in the parameter? Easy to implement but do we want so much freedom for editors?
  • 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.