Template:Find demonym/doc

From the AARoads Wiki: Read about the road before you go
Jump to navigation Jump to search

Extracts from string the demonym (adjective) of a continent or country (African, Indian, British etc). Returns nothing if there is no match.

Note that the demonym in the string must properly capitalised. "Indian" will be matched, but "indian" or "INDIAN" will be ignored.

The list of countries is hard-coded in a list in Module:Find demonym, based on the list in {{Iso2nationality}} with a few additions.

Some options allow its behaviour to be configured.

Usage

Basic usage

{{Find demonym|Foo}}

This usage will return the first time in string Foo which matches the correctly-capitalised demonym of a continent or country.

If no match is found, it returns an empty string. This allows its simple use in templates, e.g.

{{#if: {{Find demonym}}|<!-- do nothing if there is a match -->|This string does not include a demonym}}

Optional parameters

One parameter is obligatory, two optional parameters are available:

  • |string=value
This forces the template to use a title other than the current page
  • |nomatch=value
This parameter is used to specify a message to be generate if no match is found. For example
Default output {{Find demonym|The quick brown fox jumps over the lazy dog}}
with nomatch {{Find demonym|The quick brown fox jumps over the lazy dog|nomatch=No demonym!}} → No demonym!
  • |match=number
If multiple demonyms are found, this specifies which match to return, where the first match is match= 1. If a negative number is specified then a match is returned counting from the last match. Hence match = -1 is the same as requesting the last match. Defaults to 1.
Examples:
{{Find demonym|Some Bangladeshi, Indian and Pakistani (and maybe Sri Lankan) cricketers|match=2}} → Indian
{{Find demonym|Some Bangladeshi, Indian and Pakistani (and maybe Sri Lankan) cricketers|match=-2}} → Pakistani

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Find demonym in articles based on its TemplateData.

TemplateData for Find demonym

<templatedata> { "params": { "string": { "label": "Search string", "description": "String to search for demonym. If left blank, the template will return a blank, the bare module will use the page name", "type": "string" }, "match": { "label": "Match Instance", "description": "If multiple demonyms are found, this specifies which match to return, where the first match is match= 1. If a negative number is specified then a match is returned counting from the last match. Hence match = -1 is the same as requesting the last match. Defaults to 1.", "type": "number", "default": "1" }, "nomatch": { "label": "No match text", "description": "If no demonyms are found, output the \"nomatch\" value. Defaults to blank.", "type": "string" } }, "description": "Extracts a demonym from a string. All parameters are optional." } </templatedata>

See also