Module:Flags/doc: Difference between revisions

Revision as of 02:46, 24 June 2013

Latest revision as of 21:24, 29 August 2024

(12 intermediate revisions by one other user not shown)

Line 1:

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

== Features ==

Line 5:

Functionality implemented:

* Full name in English or the locale language: "Andorra". {{FlagiconLuaFlags|Andorra}}

* 2 letter code - link points to full name: "GBAD" {{FlagiconLuaFlags|GBAD}}

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

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

* When a name is not found in the list, attempts to offer a Commons image and a link e.g. "Berlin" or "WHO". {{FlagiconLuaFlags|Berlin}} {{FlagiconLuaFlags|WHO}}

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

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

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

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

* Variant / label flags not found in FlagTranslations return the Flag of None but still point to the right article: "whatever" {{FlagiconLuaFlags|Ohio|whatever}} - "quatsch" {{FlagiconLuaFlags|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]]:

* 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 [[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>