විකිපීඩියා:WikiProject Flag Template සඳහා මුලාශ්‍රය නරඹන්න

{{Shortcut|[[WP:WPFT]]}}
<div class="boilerplate metadata" style="background-color:beige; margin:1em 0 0 0; padding:0 10px 0 10px; border:1px solid #AAAAAA; font-size:95%;">
This WikiProject is responsible for the template system used to create flag icons, with or without associated wikilinks.  This project is '''only''' concerned with the '''implementation''' of these templates.
*''See'' [[Wikipedia:WikiProject Heraldry and vexillology]] ''for issues regarding the flag images themselves.''
*''See'' [[Wikipedia:Manual of Style (flags)]] ''for guidelines about flag icon usage.''
</div>

==Main templates==
===[[Template:Flagicon]]===
Produces a small image of the named flag.
:'''Example:''' <code><nowiki>{{flagicon|Japan}}</nowiki></code> → {{flagicon|Japan}}

===[[Template:Flag]]===
Produces a small image of the named flag, plus a wikilink to the associated article.
:'''Example:''' <code><nowiki>{{flag|United Kingdom}}</nowiki></code> → {{flag|United Kingdom}}
{| class="messagebox"
|[[Image:Information icon.svg|40px]]
|Note that this wikicode sequence: <code><nowiki>{{flagicon|</nowiki>''name''<nowiki>}} [[</nowiki>''name'']]</code><br/>can be (and should be) replaced by the simpler: <code><nowiki>{{flag|</nowiki>''name''<nowiki>}}</nowiki></code>.
|}

===[[Template:Flagcountry]]===
Similar to <code>flag</code>, but always uses the preferred display text for the wikilinked article, even if alias names (e.g. country codes) are used.
:'''Example:''' <code><nowiki>{{flagcountry|USA}}</nowiki></code> → {{flagcountry|USA}}

==="Shortcut" flag templates===
Many countries also have individual flag templates, named using standard three letter country codes so as to offer "shortcut" alternatives to the standard templates.  This is a mixed blessing; some country codes (like "USA") are widely known and the corresponding shortcut templates (i.e. <code><nowiki>{{USA}}</nowiki></code>) offer convenience, but some country codes are relatively obscure, so wiki markup would likely be clearer if the country names were spelled out in full.  Also, the shortcut templates do not offer the ability to use historical flag variants (described below), and are therefore less flexible.
:'''Example:''' <code><nowiki>{{AFG}}</nowiki></code> → {{AFG}} ''(equivalent to <code><nowiki>{{flag|Afghanistan}}</nowiki></code>''
See [[Wikipedia:Inline templates linking countries]] for a complete list.

==Flag names==
The first (positional) parameter for these templates specifies the country (or other entity) to be used for the flag image.  These actually identify ''additional'' templates that individually store information specific to that country.  For example, the image name and main article name used by <code><nowiki>{{flag|Cuba}}</nowiki></code> (to produce {{flag|Cuba}}) is stored in [[Template:Country data Cuba]].  The complete set of these "country data" templates is found in [[:Category:Country data templates]].

Note that there are country data templates for many entities that are not considered ''countries'', such as international organizations or sub-national entities.  The use of "country" in these template names is only because the original implementation of the flag template system was built upon [[Template:Country]]  A better name might have been "flag data", but it is likely too late for that change now.

Some examples of non-country flag templates are:
*<code><nowiki>{{flag|United Nations}}</nowiki></code> → {{flag|United Nations}}
*<code><nowiki>{{flag|European Union}}</nowiki></code> → {{flag|European Union}}
*<code><nowiki>{{flag|Texas}}</nowiki></code> → {{flag|Texas}}
*<code><nowiki>{{flag|Bavaria}}</nowiki></code> → {{flag|Bavaria}}

Many country data templates also exist for historical nations, and these can be used to produce the historical flags with wikilinks to the appropriate articles.  Some examples are:
*<code><nowiki>{{flag|Austria-Hungary}}</nowiki></code> → {{flag|Austria-Hungary}}
*<code><nowiki>{{flag|Qing Dynasty}}</nowiki></code> → {{flag|Qing Dynasty}}
*<code><nowiki>{{ධජය|නාසි ජර්මනිය}}</nowiki></code> → {{ධජය|නාසි ජර්මනිය}}

==Alias names==
For added convenience, many flags can be identified by an ''alias name'', typically a three-letter country code.  For example, instead of <code><nowiki>{{flagicon|United States}}</nowiki></code>, you could simply use <code><nowiki>{{flagicon|USA}}</nowiki></code> to produce {{flagicon|USA}}.

Alias names are available for almost every nation listed in [[ISO 3166-1 alpha-3]], the [[list of IOC country codes]], and the [[list of FIFA country codes]].  For example, <code><nowiki>{{flagicon|DEU}}</nowiki></code> (ISO) and <code><nowiki>{{flagicon|GER}}</nowiki></code> (IOC and FIFA) both produce {{flagicon|DEU}}.  A small handful of other well-known abbreviations are also available (such as <code>UK</code>, <code>EU</code>, and <code>USSR</code>).

Alias names are implemented as redirects in the template namespace.  For example, [[Template:Country data FRA]] is a redirect to [[Template:Country data France]].  The complete set of these redirects is listed in [[:Category:Country data redirects]], and the available alias redirect(s) for a given country data template (if any) are also documented on that template's page.

{| class="messagebox"
|[[Image:Nuvola apps important.svg|40px]]
|Please do not create redirect aliases with uncommon abbreviations, especially for countries or regions that do not have standard country codes.  Wikicode is much easier to read if the full name is used.  Even some of the standard country codes are not widely known!
|}

When using country code aliases, template <code>flag</code> will display this value for the wikilink's display text.  For example:
*<code><nowiki>{{flag|USA}}</nowiki></code> → {{flag|USA}}
*<code><nowiki>{{flag|UK}}</nowiki></code> → {{flag|UK}}
*<code><nowiki>{{flag|CHN}}</nowiki></code> → {{flag|CHN}}

Note that in each case, the target wikilink points to the correct article name (i.e. [[United States]], [[United Kingdom]], and [[People's Republic of China]], respectively) but the display text matches the input parameter to template <code>flag</code>.  This may be the desired effect, such as in column headings of a large table, but if the full name is wanted, then use [[Template:Flagcountry]] instead:

*<code><nowiki>{{flagcountry|USA}}</nowiki></code> → {{flagcountry|USA}}
*<code><nowiki>{{flagcountry|UK}}</nowiki></code> → {{flagcountry|UK}}
*<code><nowiki>{{flagcountry|CHN}}</nowiki></code> → {{flagcountry|CHN}}

Alias names have a second purpose, which is to provide alternate display text for target wikilinks.  For example, the main article linked by [[සැකිල්ල:රටේ දත්ත නැගෙනහිර ජර්මනිය]] is [[නැගෙනහිර ජර්මනිය]], but [[Template:Country data German Democratic Republic]] is a redirect alias.  Therefore, you can use <code><nowiki>{{flag|German Democratic Republic}}</nowiki></code> for {{flag|German Democratic Republic}}.  Again, note that the target article name for the generated wikilink is still [[නැගෙනහිර ජර්මනිය]].

==Flag variants==
Many countries have had different flag variations at various periods in their history.  The flag template system can accomodate this by storing multiple flag variants inside country data templates.  A specific flag variant is selected by specifying an additional parameter to any of the standard flag templates.  This parameter is usually given as the second positional parameter to the template, but may also be given as the <code>variant</code> named parameter.

;Examples
*<code><nowiki>{{ධජය|ජර්මනිය|අධිරාජ්‍යය}}</nowiki></code> → {{ධජය|ජර්මනිය|අධිරාජ්‍යය}}
*<code><nowiki>{{ධජය|ජර්මනිය|variant=අධිරාජ්‍යය}}</nowiki></code> → {{ධජය|ජර්මනිය|variant=අධිරාජ්‍යය}}
*<code><nowiki>{{flagcountry|CAN|1921}}</nowiki></code> → {{flagcountry|CAN|1921}}
*<code><nowiki>{{flagicon|CAN|1921}}</nowiki></code> → {{flagicon|CAN|1921}}

The set of available flag variants (if any) for a specific country data template are documented on the country data template page itself.  Each variant is identified by a short text label, such as <code>empire</code> or <code>1921</code> in the examples above.  Usually, the label identifies the year in which the flag was introduced, but this is not a mandatory style convention.

{| class="messagebox"
|[[Image:Nuvola apps important.svg|40px]]
|Do not change the name of an existing flag variant label unless you are absolutely certain it is not in use.  These labels are not like article names, where redirects are created when an article is renamed.  Changing a flag variant label will instantly break any current usage of that label.
|}

==Other common parameters==
===Size===
The default size for all flag icons created by these templates is 22x20px, with a one pixel border.  That is, the icon will be no more than 22 pixels wide, and no more than 20 pixels tall.  Most flags have a horizontal orientation, so the 22 pixel width is usually the limiting dimension.  These dimensions were carefully chosen to generate the best results when flagicons are used in a bulleted list with the default browser text size.

In certain situations, it might be desirable to use a larger (or smaller) size, and this is enabled with the <code>size</code> named parameter, available with all standard templates.

;Examples:
*<code><nowiki>{{flagicon|Brazil|size=40px}}</nowiki></code> → {{flagicon|Brazil|size=40px}}
*<code><nowiki><small>{{flag|Italy|size=15px}}</small></nowiki></code> → </small>{{flag|Italy|size=15px}}</small>

===Name===
The display text of the target wikilink is usually automatically generated, but can always be over-ridden with the <code>name</code> parameter. 

;Examples:
*<code><nowiki>{{ධජය|දකුණු කොරියාව|name=Korea}}</nowiki></code> → {{flag|දකුණු කොරියාව|name=Korea}} ''(this name is used in several sports)''
*<code><nowiki>{{flag|ROC|name=China}}</nowiki></code> → {{flag|ROC|name=China}} ''(China from 1912 to 1949)''


{| class="messagebox"
|[[Image:Information icon.svg|40px]]
|Note that if the <code>name</code> parameter is used, then the <code>flagcountry</code> and <code>flag</code> templates are functionally identical.  Use template <code>flag</code> for shorter wikicode.
|}

==Other flag templates==
===[[Template:Flaglink]]===
Similar to <code>flagcountry</code>, but extends the wikilink by adding a suffix after the country name.  This is useful when a series of per-country articles exist for a main topic.
;Examples:
*<code><nowiki>{{flaglink|Serbia|in the Eurovision Song Contest 2007}}</nowiki></code> → {{flaglink|Serbia|in the Eurovision Song Contest 2007}}
*<code><nowiki>{{flaglink|AUS|at the 2002 Commonwealth Games}}</nowiki></code> → {{flaglink|AUS|at the 2002 Commonwealth Games}}

===[[Template:Navy]]===
Displays the naval ensign of the named country (identified as the <code>naval</code> variant in the corresponding country data template) plus a wikilink to the main article for the country's navy.
:'''Example:''' <code><nowiki>{{navy|UK}}</nowiki></code> → {{navy|UK}}

==National sport team flag templates==
One of the most common instances of flag icon usage on Wikipedia is for national sport teams.  Several sets of sport-specific templates have been developed to also use this flag template system:
* [[Template:bd]] for [[badminton]]
* [[Template:bk]] for [[basketball]]
* [[Template:cr]] for [[cricket]]
* [[Template:fb]] for [[පාපන්දු ක්‍රීඩාව]]
* [[Template:fh]] for [[field hockey]]
* [[Template:hb]] for [[handball]]
* [[Template:ih]] for [[ice hockey]]
* [[Template:nb]] for [[netball]]
* [[Template:rl]] for [[rugby league]]
* [[Template:ru]] for [[rugby union]]
* [[Template:ru7]] for [[rugby sevens]]
* [[Template:vb]] for [[volleyball]]
* [[Template:davis]] and [[Template:fed]] for [[tennis]] ([[Davis Cup]] and [[Fed Cup]])
* [[Template:bandy]] for [[bandy]]
* [[Template:korf]] for [[korfball]]

These templates have intentionally been given terse names because they tend to be used many, many times on individual pages for match results. They completely supersede a set of previously used national team-specific templates.  For example, <code><nowiki>{{fb|ITA}}</nowiki></code> replaced <code><nowiki>{{ITAf}}</nowiki></code>, <code><nowiki>{{ru|NZL}}</nowiki></code> replaced <code><nowiki>{{NZLru}}</nowiki></code>, etc.

There are often several template variations available for a given sport:
*with a "w" suffix, links to women's national team articles instead
*with a "-rt" suffix, renders the flag icon to the right of the nation's name instead of to the left.  This formatting style is often used in match results
*with a -big" suffix, renders the flag icon in larger size and the team name underneath the flag.  This formatting style is often used in tables of tournament results.

For example, for football, the following templates are used:
{| class="wikitable"
!Team !! Standard !! Right flag !! Big flag 
|-
|Men's national teams || [[Template:fb]] || [[Template:fb-rt]] || [[Template:fb-big]]
|-
|Examples || {{fb|Italy}} ||align=right| {{fb-rt|France}} ||align=center| {{fb-big|Italy}}
|-
|Women's national teams || [[Template:fbw]] || [[Template:fbw-rt]] || [[Template:fbw-big]]
|-
|Examples || {{ධජය|ජර්මනිය}} ||align=right| {{fbw-rt|Brazil}} ||align=center| {{fbw-big|ජර්මනිය}}
|}

==Implementation==
Three types of templates are used by the flag template system, each with a different function:
#User-transcluded templates
#Country data templates (internal)
#Formatting templates (internal)

For example, <code><nowiki>{{flag|Spain}}</nowiki></code>, uses:
#[[Template:Flag]], to accept input parameters, such as the country name (mandatory) and the optional flag variant, size, and wikilink display name.
#[[Template:Country data Spain]], to supply the image name and article name
#[[Template:Country flag2]], to actually render the image icon and wikilink

This system architecture means that:
*all country-specific data is contained within individual country data templates, improving maintainability
*the formatting wikicode is centralized in a very small number of templates, ensuring consistency

===How it works===
There are three steps in each flag template invocation.
In the previous example of <code><nowiki>{{flag|Spain}}</nowiki></code>, the templates expand as follows:

First, <code>Template:Flag</code> expands to invoke <code>Template:Country data Spain</code>, and ensure that all user-specified parameters are set.  The first parameter to the country data template is actually the ''name of the formatting template''.  This is the mechanism by which the same country data template can be used with multiple different formatting templates.  Therefore, the first step of expansion results in:
<pre>
{{country data Spain | country flag2 | variant = | size = | name = Spain}}
</pre>
If the <code>variant</code> (or second positional parameter), the <code>size</code>, and/or <code>name</code> parameters were specified in the user invocation, these would be set to the desired value.  For example, <code><nowiki>{{flag|Spain|1939|name=España}}</nowiki></code> would expand to:
<pre>
{{country data Spain | country flag2 | variant = 1939 | size = | name = España}}
</pre>

Next, the country data template expands to invoke the formatting template, plus add all the country-specific parameters.  Going back to the simpler example of <code><nowiki>{{flag|Spain}}</nowiki></code>, the second expansion results in:
<pre>
{{country flag2 | alias = Spain | flag alias = Flag of Spain.svg | name = Spain}}
</pre>

Lastly, the formatting template is expanded to produce:
<pre>
[[Image:Flag of Spain.svg|22x20px|border|Flag of Spain]]&amp;nbsp;[[Spain|Spain]]
</pre>

===Basic country data template structure===
The structure of all country data templates follows a standard pattern, which is extended to include additional parameters only when necessary.
The empty boilerplate for all country data templates is as follows:
<pre>
{{ {{{1<noinclude>|country showdata</noinclude>}}}
| alias = 
| flag alias =
| size = {{{size|}}}
| name = {{{name|}}}
}}
</pre>
There are two essential values that must be specified:
#The <code>alias</code> value identifies the name of the main article associated with the flag.
#The <code>flag alias</code> value identifies the image name of the default flag.
The invocation of <code>country showdata</code> on the first line is used to automatically generate the template documentation, as described below.
The <code><nowiki>size = {{{size|}}}</nowiki></code> and <code><nowiki>name = {{{name|}}}</nowiki></code> statements ensure that any user-specified size and/or name values are passed through from the ''outer'' template (<code>flag</code>, <code>flagicon</code>, etc.) to the ''inner'' formatting template.  Omission of these lines from the country data template would cause the size and name functionality to be disabled.

===Adding flag variants===
Additional flag variants are specified by individual <code>flag alias</code> statements.  The unique label for the variant is the suffix of the parameter name, as <code>flag alias-''label''</code> (don't forget the hyphen).  For example, [[Template:Country data Mexico]] has several flag variants, one of which is specified by:
<pre>
| flag alias-1934 = Flag of Mexico (1934-1968).png
</pre>
Therefore, when <code><nowiki>{{flag|Mexico|1934}}</nowiki></code> is transcluded, [[:Image:Flag of Mexico (1934-1968).png]] is rendered.  The selection of the flag variant is coded in the formatting templates.

Country data templates with at least one flag variant (in addition to the default) '''must''' also have the following line:
<pre>
| variant = {{{variant|}}} 
</pre>
Similar to the <code>size</code> and <code>name</code> parameters as described above, this statement is required to pass the variant value (e.g. <code>1934</code>) from the ''outer'' flag template to the ''inner'' formatting template.  Omission of this line will cause the flag variant selection to fail.

===Alt attribute===
By default, the [[alt attribute]] text for each image is set to "Flag of <code>alias</code>".  For example, most browsers will display "Flag of Norway" when the mouse is hovered over the icon image of {{flagicon|Norway}}.

Sometimes it is desirable to override the alt attribute value, perhaps if only to correct the grammar of the phrase.  For example, [[Template:Country data Bahamas]] contains <code>alt attribute = Flag of the Bahamas</code>. Without this line, the alt attribute text would not include the "the".

===Changing the wikilink display text===
The best results are obtained when the template name matches the article wikilink (as specified by the <code>alias</code> value).  For example, [[Template:Country data Russia]] contains <code>alias = Russia</code>, which results in a target wikilink to [[රුසියාව]].

However, there are instances where the main article name contains a disambiguation string.  For example, [[Template:Country data Georgia]] contains <code>alias = Georgia (country)</code>.  Therefore, <code><nowiki>{{flag|Georgia}}</nowiki></code> results in {{flag|Georgia}}.  Note that the wikilink is [[Georgia (country)]], but the display string is "Georgia", as expected.

In these instances, an additional statement is needed to support [[Template:Flagcountry]] properly.  The <code>shortname alias</code> parameter should be set to the desired text string, such as <code>shortname alias = Georgia</code>.  In effect, the resultant wikilink will be generated as <code><nowiki>[[</nowiki>''alias''|''shortname alias'']]</code>, or <code><nowiki>[[Georgia (country)|Georgia]]</nowiki></code> in this specific example.

===National sport team template parameters===
Any country data template that will be used with a national team template must include an additional "pass-through" parameter:
<pre>
| altlink = {{{altlink|}}} 
</pre>
This parameter is used to form the suffix of the associated wikilink.  For example, [[Template:cr]] appends "national cricket team" to the country name (<code>alias</code> value), and this process is enabled by the <code>altlink</code> parameter.

In most cases, the flag and display name for national teams corresponds to the same flag and display name normally used for the nation.  However, in some instances these can be over-ridden by additional parameters within the country data template.  The default wikilink can also be changed in cases where the common naming convention is not used.

Some examples:
* [[දකුණු කොරියාව]] is referred to as "Korea Republic" by [[ෆිෆා (FIFA)]].  Therefore, [[Template:Country data South Korea]] includes <code>name alias-football</code> so that <code><nowiki>{{fb|දකුණු කොරියාව}}</nowiki></code> produces {{fb|දකුණු කොරියාව}}
* In many sports, all-Ireland teams compete with athletes from both the [[Republic of Ireland]] and [[Northern Ireland]], and often under unique flags for each sport.  [[Template:Country data Ireland]] includes unique flags for several sports teams, such as <code><nowiki>flag alias-field hockey = Flag of Ireland hockey team.svg</nowiki></code>, so that <code><nowiki>{{fh|Ireland}}</nowiki></code> produces {{fh|Ireland}}
* The New Zealand netball team is described at the [[Silver Ferns]] article, so to avoid the redirect at [[New Zealand national netball team]], [[Template:Country data New Zealand]] contains <code>link alias-netball = Silver Ferns</code> so that <code><nowiki>{{nb|New Zealand}}</nowiki></code> produces {{nb|New Zealand}}

In each of these examples, the over-ride parameter (<code>name alias-football</code>, <code>flag alias-field hockey</code>, or <code>link alias-netball</code>) is identified by a unique per-sport variable that is passed from the appropriate sport team template.  For example, [[Template:fb]] includes <code>altvar = football</code>.  Therefore, any country data template that utilizes one or more team sport over-ride parameters must also include:
<pre>
| altvar = {{{altvar|}}} 
</pre>

===Template documentation===
Country data templates "self-document" themselves through [[Template:Country showdata]].  Recall that the first line of each country data template is an invocation to a formatting template, defaulting to <code>country showdata</code> if that parameter is missing:
<pre>
</pre>
For simple country data templates, nothing further needs to be done to document them.  If any flag variants, redirect aliases, etc. are used with the template, they are documented by adding parameters specifically for use by <code>country showdata</code>. These extra parameters are enclosed in a <code><nowiki><noinclude>....</noinclude></nowiki></code> section as they should not be present for any other invocation of the country data template.

See [[Template:Country showdata/doc]] for more information about how to document country data templates.

==Future work==
===Use ImageMap for clickable icons===
One idea that has been proposed is to use the [[mw:Extension:ImageMap|ImageMap extension]] so that clicking on the flag icon will go to the article on the country instead of the image page for the flag.  For example,
<pre>
<imagemap>
Image:Flag of Canada.svg|22px|border|Flag of Canada
default [[Canada]]
desc none
</imagemap>
</pre>
results in:
<imagemap>
Image:Flag of Canada.svg|22px|border|Flag of Canada
default [[Canada]]
desc none
</imagemap>
Clicking on this icon brings up the page on [[Canada]] instead of [[:Image:Flag of Canada.svg]].  Unfortunately, the ImageMap syntax currently does not allow for image names, links, etc. to be parameterized, but must be hardcoded to specific values, as in the previous example.  See [[Bugzilla:8835]] for comments.  Also, the imagemap does not seem to support "inline" image placement.

===Add user preference to disable display of flag icons===
Users that do not like flag icons should be able to disable them with a preference setting.  One idea that has been tried is using a CSS class within the internal formatting template, and change the class setting from the user's [[Special:Mypage/monobook.css|monobook.css]] file.

For example, the code for [[Template:Country flagicon2]] was changed to
<pre>
...<span class="flagicon">[[Image:...]]</span>...
</pre>
Flag image rendering would be disabled by:
<pre>
{ .flagicon display:none; }
</pre>

This mechanism ''mostly'' worked, but had to be reverted because it failed if a flag template was itself used as a ''positional'' parameter for another template.  Many sports templates (e.g. [[Template:Round8]]) use positional parameters instead of named parameters, and are frequently used with national teams.  The underlying fault is that the <code>=</code> sign is being interpreted as a template parameter instead of part of the HTML code. [[Bugzilla:5138]] appears to relate to this behaviour.

==See also==
* {{tl|flagIOC}} for a similar template used exclusively for Olympic Games related articles, and uses a different internal mechanism than for these templates.

==Internal project templates==
* {{tl|WikiProject Flag Template}} – banner for talk pages of template and flag-related project pages

==Archives==
* [[/Archive1]] – Archive of project when testing of flag template was completed. [[June 23]] [[2005]]
* [http://en.wikipedia.org/w/index.php?title=Wikipedia:WikiProject_Flag_Template&oldid=99256455 Revision as of 8 January 2007] – description of the previous version of the flag template system
* [http://en.wikipedia.org/w/index.php?title=Wikipedia:WikiProject_Flag_Template&oldid=164777309 Revision as of 3 November 2007] – before this page was completely rewritten

[[Category:Regional WikiProjects|Flag Template]]