Template:homophones/documentation

From Wiktionary, the free dictionary
Jump to navigation Jump to search
Documentation for Template:homophones. [edit]
This page contains usage information, categories, interwiki links and other content describing the template.

Use this template under the Pronunciation header to specify homophones for a term.

Parameters

[edit]
|1= (required)
The language code (see Wiktionary:List of languages) for the current language section. The parameter |lang= is a deprecated synonym; please do not use. If this is used, all numbered parameters move down by one.
|2=, |3=, |4= ...
Indicates one or more homophones to be listed. They will be displayed separated by commas, unless a bare semicolon ; is used as an argument, in which case the two surrounding arguments will be separated by a semicolon. See below under #Inline modifiers for an example of this. (Additionally, if any homophone has an embedded comma, all homophones will be separated by semicolons; although in the case of homophones this is unlikely, since they are usually single words.) Note that semicolons do not count for the purposes of indexed parameters; thus, an example like {{homophones|en|torc|torq|torque|aa3=non-rhotic|;|tock|aa4=cot-caught}} is correct and will result in the cot-caught accent qualifier being displayed after the homophone tock, while {{homophones|en|torc|torq|torque|aa3=non-rhotic|;|tock|aa5=cot-caught}} is incorrect and will produce unexpected results. To avoid issues like this, it is recommended to use inline modifiers (see link).
|q=
Specifies a qualifier to be placed at the beginning, before the "Homophone:" or "Homophones:" text that normally precedes the homophone(s). This is formatted with the {{q}}/{{qualifier}} template. NOTE: Currently, use of this parameter is disallowed, since its meaning recently changed; this will change in July 2024.
|qq=
Specifies a qualifier to be placed at the end, after all homophones. This is formatted with the {{q}}/{{qualifier}} template.
|a=
Specifies one or more comma-separated accent qualifiers to be placed at the beginning, before the "Homophone:" or "Homophones:" text that normally precedes the homophone(s). These are formatted with the {{a}}/{{accent}} template. To be recognized as a separator, there must be no space following the comma; otherwise, the comma is treated as an embedded comma within the accent qualifier.
|aa=
Specifies one or more comma-separated accent qualifiers to be placed at the end, after all homophones. These are formatted with the {{a}}/{{accent}} template. To be recognized as a separator, there must be no space following the comma; otherwise, the comma is treated as an embedded comma within the accent qualifier.
|qN=
Specifies a qualifier to be placed before homophone N. This is formatted with the {{q}}/{{qualifier}} template. NOTE: Currently, use of this parameter is disallowed, since its meaning recently changed; this will change in July 2024.
|qqN=
Specifies a qualifier to be placed after homophone N. This is formatted with the {{q}}/{{qualifier}} template.
|aN=
Specifies one or more comma-separated accent qualifiers to be placed before homophone N. These are formatted with the {{a}}/{{accent}} template. To be recognized as a separator, there must be no space following the comma; otherwise, the comma is treated as an embedded comma within the accent qualifier.
|aaN=
Specifies one or more comma-separated accent qualifiers to be placed after homophone N. These are formatted with the {{a}}/{{accent}} template. To be recognized as a separator, there must be no space following the comma; otherwise, the comma is treated as an embedded comma within the accent qualifier.
|refN=
Specifies one or more reference notes to be placed after homophone N. The reference is placed in the ===References=== section at the bottom of the language's entry. This works identically to the corresponding parameter of the {{IPA}} template; see Template:IPA#References for the exact syntax.
|tN= or |glossN=
Gloss (meaning) for homophone N, in case only some meanings of the word are homophonous (as in English wind, bow, lead, etc.).
|altN=
Display text for homophone N, in place of the homophone itself.
|trN=
Manual transliteration for homophone N. Only needed for homophones in a non-Latin script, and only when the automatically generated transliteration is wrong (or if there is no automatically generated transliteration, as with Hebrew).
|tsN=
Transcription for non-Latin-script homophone N, in the case of languages where the transliterations are markedly different from the actual pronunciation (e.g. Sumerian, Akkadian and ancient Egyptian). Should not be used for IPA pronunciations. Same as the |ts= parameter of {{l}} and {{m}}.
|gN=
Gender/number specification(s) for homophone N. See Module:gender and number for more details. Same as the |g= parameter of {{head}}, except that multiple, comma-separated gender/number specs can be given (there should be no space after the comma). Generally only use for disambiguating homophones with multiple pronunciations.
|posN=
Part of speech for homophone N. Same as the |pos= parameter of {{l}} and {{m}}. Generally only use for disambiguating homophones with multiple pronunciations.
|idN=
Sense ID for homophone N. Same as the |id= parameter of {{l}} and {{m}}. Generally only use for disambiguating homophones with multiple pronunciations.
|litN=
Literal meaning of homophone N. Same as the |lit= parameter of {{l}} and {{m}}. Provided for completeness, but you should rarely (if ever) need to use this.
|scN=
Script code for homophone N. This overrides the overall script code specified in |sc=. This is rarely necessary, as the correct script can almost always be autodetected.
|sc=
Override the script code for all homophones. This in turn is overridden by individually specified |scN= script codes. This is rarely necessary, as the correct script can almost always be autodetected.
|caption=1
Override the caption displayed before the homophone(s) (normally "Homophone" or "Homophones", depending on whether there is one or more than one homophone). A colon is automatically added to the end.
|nocaption=1
Disable output of the "Homophone:" or "Homophones:" caption before the homophone(s).
|nocat=1
Disable categorization.
|sort=
Manual sortkey. Use sparingly; the makeSortKey method in Module:languages can usually generate the correct sortkey.

Inline modifiers

[edit]

All indexed parameters have corresponding inline modifiers, e.g. <q:...>, <qq:...>, <a:...>, <aa:...>, <ref:...>, etc. that can be attached directly to a homophonw argument. Example:

* {{homophones|en|wined<aa:wine-whine>|;|wind<aa:wine-whine><pos:verb>}}

which produces

This also shows the use of a bare semicolon argument to cause the separator between two homophones to appear as a semicolon.


Another example showing the use of double angle bracket notation:

* {{hmp|en|currant|;|courant<aa:with both the <<hurry-furry>> and <<cure-fir>>>}}

which produces

Examples

[edit]

In the English entry for two:

* {{homophones|en|to|too}}

gives

When available automatic transliteration will be added, e.g. in the Greek entry βάζο (vázo):

* {{homophones|el|βάζω}}

gives

Alternatively transliteration can be added manually, as well as qualification, for each homophone listed. For in the Hebrew entry עת:

* {{homophones|he|עֵט|tr1=et|qq1=some qualifier}}

gives


TemplateData

[edit]
This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateData for homophones

Use this template under the Pronunciation header to specify homophones for a term.

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
language code1

The language code of the language of the term and its homophones.

Example
en
Stringrequired
homophone2

First homophone to be listed.

Example
too
Stringrequired
link textalt1

Link text for the first homophone, if different from the entry name.

Stringoptional
transliterationtr1

If necessary, transliteration for the first homophone, (some languages are done automatically).

Stringoptional
qualifierq1

If necessary, qualifier for the first homophone.

Stringoptional
homophone 23

Second homophone to be listed.

Stringoptional
link 2alt2

Link text for the second homophone, if different from the entry name.

Stringoptional
transliteration 2tr2

If necessary, transliteration for the second homophone, (some languages are done automatically).

Stringoptional
qualifier 2q2

If necessary, qualifier for the second homophone.

Stringoptional
homophone 34

Third homophone to be listed.

Stringoptional
link 3alt3

Link text for the third homophone, if different from the entry name.

Stringoptional
transliteration 3tr3

If necessary, transliteration for the third homophone (some languages are done automatically).

Stringoptional
qualifier 3q3

If necessary, qualifier for the third homophone.

Stringoptional
langlang

The language code of the language of the term and its homophones.

Example
en
Stringdeprecated