View source for Template:Country alias/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{High-use}}
{{Lua|Module:Country alias|Module:Country alias/data}}
This template returns either a country name or the flag associated with that country, depending on the input parameters.

{{t|Country alias}} is primarily meant to be used for sporting competitions such as the [[Olympics]], [[Commonwealth Games]], [[Asian Games]], etc.

== Usage ==
There is one required parameter and three optional parameters.

;<code>country</code>/<code>1</code>:The three-letter country code used by [[List of IOC country codes|IOC]], [[List of CGF country codes|CGF]], or [[List of FINA member federations|FINA]]. This parameter can be an unnamed parameter.
;<code>flag</code>:If set to <code>yes</code>, will return the flag of the country.
;<code>year</code>:The input year will determine which flag is used. For example, any year before 1999 will give "Pre-1999 Flag of Tunisia.svg" for Tunisia (TUN), while any year after 1999 will give "Flag of Tunisia.svg".
;<code>games</code>:This is another method of determining which flag is used. Some countries, such as Great Britain, used the Olympic flag during the [[1980 Summer Olympics]].

==Examples==
Here are some examples based on the entry for Italy (ITA)
<syntaxhighlight lang="Lua">
ITA = {
	name = "Italy",
	{1946, "Flag of Italy (1861-1946).svg"},
	{2002, "Flag of Italy.svg"},
	{2006, "Flag of Italy (2003-2006).svg"},
	"Flag of Italy.svg",
	["Summer Olympics"] = {
		[1980] = "Olympic flag.svg",
	},
</syntaxhighlight>

*<code><nowiki>{{Country alias|ITA}}</nowiki></code> → {{Country alias|country=ITA}}
*<code><nowiki>{{Country alias|ITA|flag=yes}}</nowiki></code> → {{Country alias|country=ITA|flag=yes}}
*<code><nowiki>{{Country alias|ITA|flag=yes|year=1946}}</nowiki></code> → {{Country alias|country=ITA|flag=yes|year=1946}}
*<code><nowiki>{{Country alias|ITA|flag=yes|year=1947}}</nowiki></code> → {{Country alias|country=ITA|flag=yes|year=1947}}
*<code><nowiki>{{Country alias|ITA|flag=yes|year=1980|games=Summer Olympics}}</nowiki></code> → {{Country alias|country=ITA|flag=yes|year=1980|games=Summer Olympics}}
*<code><nowiki>{{Country alias|ITA|flag=yes|year=2006|games=Summer Olympics}}</nowiki></code> → {{Country alias|country=ITA|flag=yes|year=2006|games=Summer Olympics}}

Note that in the last example <code>games</code> does not factor into the flag image. 

===Lua script error messages===
If the country code is not supplied, or does not exist in the module, an error will be returned:
*{{tlc|Country alias}} → {{error|Lua error in Module:Country_alias at line 181: Invalid country alias: {{{country}}}.}}
*{{tlc|Country alias|}} → {{error|Lua error in Module:Country_alias at line 181: Invalid country alias: nil.}}
*{{tlc|Country alias|EXZ}} → {{error|Lua error in Module:Country_alias at line 181: Invalid country alias: EXZ.}}
*{{tlc|Country alias|2=country=EXZ}} → {{error|Lua error in Module:Country_alias at line 181: Invalid country alias: EXZ.}}
To avoid generating a script error, use {{para|error|value}}.
*{{tlc|Country alias|EXZ|3=error=ERROR}} → {{Country alias|EXZ|error=ERROR}}

<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Wikipedia classification templates]]
[[Category:Wikipedia formatting and function templates]]

}}</includeonly>