Difference between revisions of "Template:Country alias/doc"

From blackwiki
Jump to navigation Jump to search
imported>BrownHairedGirl
imported>WOSlinker
m (change source to syntaxhighlight)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Lua|Module:Country alias}}
+
{{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.
 
This template returns either a country name or the flag associated with that country, depending on the input parameters.
  
Line 16: Line 16:
 
==Examples==
 
==Examples==
 
Here are some examples based on the entry for Italy (ITA)
 
Here are some examples based on the entry for Italy (ITA)
<source lang="Lua">
+
<syntaxhighlight lang="Lua">
 
ITA = {
 
ITA = {
 
name = "Italy",
 
name = "Italy",
Line 26: Line 26:
 
[1980] = "Olympic flag.svg",
 
[1980] = "Olympic flag.svg",
 
},
 
},
</source>
+
</syntaxhighlight>
  
 
*<code><nowiki>{{Country alias|ITA}}</nowiki></code> → {{Country alias|country=ITA}}
 
*<code><nowiki>{{Country alias|ITA}}</nowiki></code> → {{Country alias|country=ITA}}
Line 46: Line 46:
 
*{{tlc|Country alias|EXZ|3=error=ERROR}} → {{Country alias|EXZ|error=ERROR}}
 
*{{tlc|Country alias|EXZ|3=error=ERROR}} → {{Country alias|EXZ|error=ERROR}}
  
== See also ==
 
* [[:Template:CountryPrefixThe]]
 
 
<includeonly>{{sandbox other||
 
<includeonly>{{sandbox other||
 
<!-- Categories below this line, please; interwikis at Wikidata -->
 
<!-- Categories below this line, please; interwikis at Wikidata -->

Latest revision as of 12:58, 7 July 2020

This template returns either a country name or the flag associated with that country, depending on the input parameters.

Template:T 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.

country/1
The three-letter country code used by IOC, CGF, or FINA. This parameter can be an unnamed parameter.
flag
If set to yes, will return the flag of the country.
year
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".
games
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)

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",
	},
  • {{Country alias|ITA}} → Italy
  • {{Country alias|ITA|flag=yes}} → Flag of Italy.svg
  • {{Country alias|ITA|flag=yes|year=1946}} → Flag of Italy (1861-1946).svg
  • {{Country alias|ITA|flag=yes|year=1947}} → Flag of Italy.svg
  • {{Country alias|ITA|flag=yes|year=1980|games=Summer Olympics}} → Olympic flag.svg
  • {{Country alias|ITA|flag=yes|year=2006|games=Summer Olympics}} → Flag of Italy (2003–2006).svg

Note that in the last example games 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:

  • {{Country alias}}Lua error in Module:Country_alias at line 148: Invalid country alias: {{{country}}}.
  • {{Country alias|}}Lua error in Module:Country_alias at line 148: Invalid country alias: nil.
  • {{Country alias|EXZ}}Lua error in Module:Country_alias at line 148: Invalid country alias: EXZ.
  • {{Country alias|country=EXZ}}Lua error in Module:Country_alias at line 148: Invalid country alias: EXZ.

To avoid generating a script error, use |error=value.

  • {{Country alias|EXZ|error=ERROR}} → ERROR