Module:Flags/doc: Difference between revisions

Revision as of 22:13, 5 June 2013

Latest revision as of 21:24, 29 August 2024

(32 intermediate revisions by 2 users not shown)

Line 1:

All the logics of [[Template:FlagiconLuaFlags]] are handled here. This module works together with [[Module:SandboxFlags/QuimGilMasterData]] and [[Module:Flags/FlagTranslationsLocaleData]], where the flags data is maintained.

== Features ==

Functionality already implemented:

* Recognition of flags based on the fullFull name parameter in English or the locale language e.g.: "Andorra". {{Flags|Andorra}}

* 2 letter code - link points to full name: "AD" {{Flags|AD}}

* Recognition of flags based on the 3 letter code e.g. "AND".

* 3 letter code - link points to full name: "AND" {{Flags|AND}}

* Nepal and Ohio flags are shown without border. {{Flags|Nepal}} {{Flags|Ohio}}

* When a name is not found in the list, attempts to offer a Commons image and a link e.g. "Berlin" or "[[commons:File:Flag_of_WHO.svg|WHO]]". {{Flags|Berlin}} {{Flags|WHO}}

* Size as in "size=44px" or "size=40x44px" can be defined in any position. {{Flags|Andorra|size=44px}} {{Flags|Nepal|size=26x44px}}

* Nepal, Switzerland and Vatican City have a default size of 20x17px (for the rest it's 20x22px): {{Flags|Nepal}} {{Flags|Switzerland}} {{Flags|the Vatican City}}

* Variants for historical flags "1901" {{Flags|Afghanistan|1901}} or "variant=1901" (for compatibility reasons) {{Flags|Afghanistan|variant=1901}}

* Variants for labeled flags: "naval", "air force" and any other specified at FlagTranslations: "civil" {{Flags|United Kingdom|civil}} - "naval-RMAS" {{Flags|United Kingdom|naval-RMAS}}

* Variant / label flags not found in FlagTranslations return the Flag of None but still point to the right article: "whatever" {{Flags|Ohio|whatever}} - "quatsch" {{Flags|Berlin|quatsch}}

* ''Redirects'' (different names pointing to a same flag) are supported: "GB" {{Flags|GB}} - "UK" {{Flags|UK}}

* Full Commons filenames can be defined in tables when they don't follow the "Flag of " syntax: "File:Flag Belgium brussels" {{Flags|Brussels-Capital Region}}

* Localization: "Illes Balears" {{Flags|Illes Balears}} - "中華人民共和國" {{Flags|中華人民共和國}}

* Localization + variants: "Afganistan" + "1901" {{Flags|Afganistan|1901}} - "Regne Unit" + "civil" {{Flags|Regne Unit|civil}}

* Flags listed only in FlagTranslations always link to the local language article: parameter "Native Peoples of Colombia" {{Flags|Native Peoples of Colombia}} links to "Pueblos Indígenas de Colombia"

== Roadmap ==

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

* <code>size=</code> parameter for different sizes.

* <code>variant=YYYY</code> and its shortcut <code>YYYY</code> for historical flags.

* <code>naval</code> and <code>air force</code> variants.

* 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 [[Wikipedia:WikiProject_Flag_Template|other flag templates]].

* Allow editors to define the year of the event, leaving to the template the task of finding the right flag.<noinclude>

[[Category:Module documentation pages]]

</noinclude>