View source for Template:Country data Ireland/doc

{{documentation subpage}}
This template is intended to be used for all-Ireland instances, usually resulting in a wikilink to [[Ireland]] (article about the island) instead of [[Republic of Ireland]] (article about the sovereign nation).

However, it is often convenient to use <tt><nowiki>{{flagicon|Ireland}}</nowiki></tt> and <tt><nowiki>{{flag|Ireland}}</nowiki></tt> instead of <tt><nowiki>{{flagicon|Republic of Ireland}}</nowiki></tt> and <tt><nowiki>{{flag|Republic of Ireland}}</nowiki></tt> respectively, so this template differs from the standard format in order to accommodate that usage.  The <tt>alias</tt> parameter changes depending on whether or not a flag variant is used by the parent template call:
<pre>
alias = {{#if:{{{variant|}}}|Ireland|Ireland (state)}}
</pre>
This results in
*<tt><nowiki>{{flag|Ireland|1783}}</nowiki></tt> → {{flag|Ireland|1783}} ''(use for Ireland as part of [[United Kingdom of Great Britain and Ireland]])''
*<tt><nowiki>{{flag|Ireland}}</nowiki></tt> → {{flag|Ireland}} ''(use for current state)''

=== Sporting teams ===
Also, several sport-specific flag variants are maintained here, and these are automatically used by the respective sport team templates:
* <tt><nowiki>{{fb|Ireland}}</nowiki></tt> → {{fb|Ireland}} ''(football, 1882–1922)''
* <tt><nowiki>{{fh|Ireland}}</nowiki></tt> → {{fh|Ireland}} ''(field hockey)''
* <tt><nowiki>{{rl|Ireland}}</nowiki></tt> → {{rl|Ireland}} ''(rugby league)''
* <tt><nowiki>{{ih|Ireland}}</nowiki></tt> → {{ih|Ireland}} ''(ice hockey)'' — all-Ireland team that uses the tri-colour
*<tt><nowiki>{{ru|Ireland}}</nowiki></tt> → {{ru|Ireland}} ''(rugby union)''
*<tt><nowiki>{{cr|Ireland}}</nowiki></tt> → {{cr|Ireland}}  ''(cricket)'' — renders no flag because the flag used by [[Cricket Ireland]] is non-free

Note that this template does not include flag images for cricket and rugby union, as those flags are copyrighted images and cannot be used in templates per [[WP:Non-free content criteria]].

===Use of country code aliases===
The standard country code for the Republic of Ireland is '''IRL''', so it can be used as an alias for [[Template:Country data Republic of Ireland]].  The non-standard country code '''IRE''' is used as an alias for this template to provide similar convenience.  For example:
*<tt><nowiki>{{flagicon|IRL}}</nowiki></tt> → {{flagicon|IRL}}
*<tt><nowiki>{{flagicon|IRE|1783}}</nowiki></tt> → {{flagicon|IRE|1783}}
*<tt><nowiki>{{flagicon|IRE|4prov}}</nowiki></tt> → {{flagicon|IRE|4prov}}
*<tt><nowiki>{{fb|IRL}}</nowiki></tt> → {{fb|IRL}} ''(links to [[Republic of Ireland national football team]])''
*<tt><nowiki>{{fb|IRE}}</nowiki></tt> → {{fb|IRE}} ''(links to [[Ireland national football team (1882–1950)]])''


====Incorrect usage====
Do not use the IRL alias for all-Ireland sports team, and do not use the IRE alias without a flag variant specified.  The following examples should not be used.
*<tt><nowiki>{{flagicon|IRE}}</nowiki></tt> → {{flagicon|IRE}}  (''Works, but better to use the standard country code for IRL.'')
*<tt><nowiki>{{fh|IRL}}</nowiki></tt> → <s>{{fh|IRL}}</s>  (''Use'' <tt><nowiki>{{fh|IRE}}</nowiki></tt> ''instead'')



==Other flags==
<tt>Country_data</tt> templates are also available for each of the four traditional [[provinces of Ireland]]:
{| style="background-color:#ecfcf4"
| [[Template:Country data Connacht]] || {{flag|Connacht}}
|-
| [[Template:Country data Leinster]] || {{flag|Leinster}}
|-
| [[Template:Country data Munster]] || {{flag|Munster}}
|-
| [[Template:Country data Ulster]] || {{flag|Ulster}}
|}