Template:CountryPrefixThe

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search
Documentationview · edit · history · purge ]
This documentation is transcluded from Template:CountryPrefixThe/doc.

Template:High use 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[edit]

{{CountryPrefixThe|Countryname}}

{{CountryPrefixThe|Countryname|onlythe=yes}}

{{CountryPrefixThe|Countryname|onlythe=yes}}

{{CountryPrefixThe|Countryname|capitalised=yes}}

{{CountryPrefixThe|Countryname|capitalised=yes|onlythe=yes}}

Examples[edit]

No parameters
  1. {{CountryPrefixThe|Kenya}} → Kenya
  2. {{CountryPrefixThe|Philippines}} → the Philippines
with "onlythe=yes"
  1. {{CountryPrefixThe|Kenya|onlythe=yes}} → Kenya
  2. {{CountryPrefixThe|Philippines|onlythe=yes}} → the Philippines
with "capitalised=yes"
  1. {{CountryPrefixThe|Kenya|capitalised=yes}} → Kenya
  2. {{CountryPrefixThe|Philippines|capitalised=yes}} → the Philippines

Note that the alternative spelling "capitalized=yes" has the same effect

with both "onlythe=yes" and "capitalised=yes"
  1. {{CountryPrefixThe|Kenya|onlythe=yes|capitalised=yes}} → Kenya
  2. {{CountryPrefixThe|Philippines|onlythe=yes|capitalised=yes}} → the Philippines

Only "the"[edit]

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.: products were exported to [[{{{country}}}]]

If {{{country}}}=United States, then we get a grammatically incorrect result:

products were exported to [[{{{country}}}]]" → products were exported to United States

Alternatively, if {{{country}}}=United States and we use {{CountryPrefixThe}}, then then word the is incorrectly part of the linked text

products were exported to [[{{CountryPrefixThe|{{{country}}}}}]] → products were exported to the United States

The solution is to use the onlythe=yes parameter: "products were exported to {{CountryPrefixThe|{{{country}}}|onlythe=yes}} [[{{country}}]]" → products were exported to the United States

Full parameter list[edit]

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 {{Yesno}}, which interprets as "yes" case-insensitive forms of Yes, y, true, and 1

{{yesno
|
| capitalised =
| onlythe = 
}}

TemplateData[edit]

<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.


Wikipedia's help about TemplateDataCommons-specific information

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.

Template parameters

ParameterDescriptionTypeStatus
Input value1

The value to be evaluated

Stringrequired
Output only the word 'the'onlythe

Outputs only the word 'the' when the input value is a case-insensitive forms of 'Yes', 'Y', 'True' or '1'

Stringoptional
Capitalise 'the'?capitalised

Capitalises the word 'the' as 'The' when the input value is a case-insensitive forms of 'Yes', 'Y', 'True' or '1'

Stringoptional
Capitalize 'the'?capitalized

Synonym of 'capitalised'. Capitalises the word 'the' as 'The' when the input value is a case-insensitive forms of 'Yes', 'Y', 'True' or '1'

Stringoptional

See also[edit]