Lihimi Tɛmplet:CountryPrefixThe/doc ni yi shɛli na

{{Documentation subpage}}
{{High use|54622 }}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
This is a helper template, use by other templates.

Takes a country name, and returns the name prefixed by "the" if that is required in running text.  Otherwise just returns the country name.

Optionally, returns just the word "the", if applicable.

In either case, the word "the" may optionally be returned in capitalised form.

== Usage ==
<code><nowiki>{{CountryPrefixThe|Countryname}}</nowiki></code> 

<code><nowiki>{{CountryPrefixThe|Countryname|onlythe=yes}}</nowiki></code> 

<code><nowiki>{{CountryPrefixThe|Countryname|onlythe=yes}}</nowiki></code> 

<code><nowiki>{{CountryPrefixThe|Countryname|capitalised=yes}}</nowiki></code> 

<code><nowiki>{{CountryPrefixThe|Countryname|capitalised=yes|onlythe=yes}}</nowiki></code> 

=== Examples ===

; No parameters
# <code><nowiki>{{CountryPrefixThe|Kenya}}</nowiki></code> → {{CountryPrefixThe|Kenya}}
# <code><nowiki>{{CountryPrefixThe|Philippines}}</nowiki></code> → {{CountryPrefixThe|Philippines}}

; with "onlythe=yes"
# <code><nowiki>{{CountryPrefixThe|Kenya|onlythe=yes}}</nowiki></code> → {{CountryPrefixThe|Kenya|onlythe=yes}}
# <code><nowiki>{{CountryPrefixThe|Philippines|onlythe=yes}}</nowiki></code> → {{CountryPrefixThe|Philippines|onlythe=yes}}

; with "capitalised=yes"
# <code><nowiki>{{CountryPrefixThe|Kenya|capitalised=yes}}</nowiki></code> → {{CountryPrefixThe|Kenya|capitalised=yes}}
# <code><nowiki>{{CountryPrefixThe|Philippines|capitalised=yes}}</nowiki></code> → {{CountryPrefixThe|Philippines|capitalised=yes}}
''Note that the alternative spelling "capitalized=yes" has the same effect''

; with both "onlythe=yes" and "capitalised=yes"
# <code><nowiki>{{CountryPrefixThe|Kenya|onlythe=yes|capitalised=yes}}</nowiki></code> → {{CountryPrefixThe|Kenya|onlythe=yes|capitalised=yes}}
# <code><nowiki>{{CountryPrefixThe|Philippines|onlythe=yes|capitalised=yes}}</nowiki></code> → {{CountryPrefixThe|onlythe=yes|Philippines|capitalised=yes}}

==== Only "the" ====
The optional parameter "onlythe=yes" allow control of whether the countryname is included in the returned value.

There are some situations where the definite article is needed alone, e.g. when the countryname is to be linked but the word "the" should not be linked.

e.g.: <code><nowiki>products were exported to [[{{{country}}}]]</nowiki></code>

If <code><nowiki>{{{country}}}=United States</nowiki></code>, then we get a grammatically incorrect result:
:<code><nowiki>products were exported to [[{{{country}}}]]"</nowiki></code> → products were exported to [[United States]]

Alternatively, if <code><nowiki>{{{country}}}=United States</nowiki></code> and we use {{tl|CountryPrefixThe}}, then then word the is incorrectly part of the linked text
:<code><nowiki>products were exported to [[{{CountryPrefixThe|{{{country}}}}}]]</nowiki></code> → products were exported to [[the United States]]

The solution is to use the <code><nowiki>onlythe=yes</nowiki></code> parameter:
<code><nowiki>"products were exported to {{CountryPrefixThe|{{{country}}}|onlythe=yes}} [[{{country}}]]"</nowiki></code>  → products were exported to the [[United States]]
== Full parameter list ==
Unnamed parameter 1= the input value to be evaluated. The other parameters (all named, all optional), set options. The value of the options is calculated by {{tl|Yesno}}, which interprets as "yes" case-insensitive forms of <code><nowiki>Yes</nowiki></code>, <code><nowiki>y</nowiki></code>, <code><nowiki>true</nowiki></code>, and <code><nowiki>1</nowiki></code>

<pre>
{{yesno
|
| capitalised =
| onlythe = 
}}
</pre>

== TemplateData ==
{{TemplateDataHeader}}
<templatedata>
{
        "description": "This template takes a country name, and returns the name prefixed by 'the' if that is required in running text. Otherwise just returns the country name.",
        "params": {
                "1": {
                        "label": "Input value",
                        "description": "The value to be evaluated",
                        "type": "string",
                        "required": true
                },
                "onlythe": {
                        "label": "Output only the word 'the'",
                        "description": "Outputs only the word 'the' when the input value is a case-insensitive forms of 'Yes', 'Y', 'True' or '1'",
                        "type": "string",
                        "required": false
                },
                "capitalised": {
                        "label": "Capitalise 'the'?",
                        "description": "Capitalises the word 'the' as 'The' when the input value is a case-insensitive forms of 'Yes', 'Y', 'True' or '1'",
                        "type": "string",
                        "required": false
                },
                "capitalized": {
                        "label": "Capitalize 'the'?",
                        "description": "Synonym of 'capitalised'. Capitalises the word 'the' as 'The' when the input value is a case-insensitive forms of 'Yes', 'Y', 'True' or '1'",
                        "type": "string",
                        "required": false
                }
        }
}
</templatedata>
==Tracking categories==
*{{clc|Template Year in country category with prefix available though CountryPrefixThe}}
*{{clc|Template Year in country category with prefix parameter matching that in CountryPrefixThe}}
*{{clc|Template Year in country category with prefix parameter NOT matching that in CountryPrefixThe}}

==See also==
* {{ml|ustring|gsub}} can be used to strip the "the" :
** <code><nowiki>{{#invoke:ustring|gsub|the United Kingdom|^the ?|}}</nowiki></code> → {{#invoke:ustring|gsub|the United Kingdom|^the ?|}}
** <code><nowiki>{{#invoke:ustring|gsub|France|^the ?|}}</nowiki></code> → {{#invoke:ustring|gsub|France|^the ?|}}
<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Wikipedia classification templates]]
[[Category:Wikipedia formatting and function templates]]
[[Category:Country templates]]
}}</includeonly>