Template:IPA
- The following documentation is located at Template:IPA/documentation. [edit]
- Useful links: subpage list • links • redirects • transclusions • errors (parser/module) • sandbox (diff)
This template adds the proper formatting and links to a pronunciation transcription in the International Phonetic Alphabet. It applies proper formatting and adds links to the language's IPA key using Module:IPA/templates. It should be used in pronunciation sections only. If the language has a template that automatically generates pronunciation from spelling, that template should be used instead of this one.
By default, the module counts the syllables in every phonemic transcription of a language that has diphthongs listed in Module:syllables, and a category is added based on the count, such as English 1-syllable words. To turn off syllable counting, add the parameter |nocount=1.
The module also tracks various IPA and some non-IPA symbols in particular languages' transcriptions (see Module:IPA/tracking). It gives a preview-only message in red if any symbols are invalid, based on the list in Module:IPA/data/symbols, and offers suggestions to correct some common substitutions.
Parameters
|1=- 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 pronunciations. These should be formatted in correct IPA and be surrounded by slashes
/ /for phonemic representations, and square brackets[ ]for phonetic representations. 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. Note that semicolons do not count for the purposes of indexed parameters; thus, an example like{{IPA|en|/ˈpɪŋˌpɔŋ/|;|/ˈpɪŋˌpɑŋ/|a2=cot-caught}}is correct and will result in thecot-caughtaccent qualifier being displayed directly before the pronunciation /ˈpɪŋˌpɑŋ/, while{{IPA|en|/ˈpɪŋˌpɔŋ/|;|/ˈpɪŋˌpɑŋ/|a3=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 "IPA:" text that normally precedes the pronunciation(s). This is formatted with the
{{q}}/{{qualifier}}template. |qq=- Specifies a qualifier to be placed at the end, after all pronunciations. 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 "IPA:" text that normally precedes the pronunciation(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 pronunciations. 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 pronunciation N. This is formatted with the
{{q}}/{{qualifier}}template. The parameter|qualN=is a deprecated synonym; please do not use. Currently, for compatibility,|qual=is accepted as a synonym for|qual1=, but this should not be relied on as it will be changing in the future. |qqN=- Specifies a qualifier to be placed after pronunciation N. This is formatted with the
{{q}}/{{qualifier}}template. |aN=- Specifies one or more comma-separated accent qualifiers to be placed before pronunciation 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 pronunciation 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 pronunciation N. The reference is placed in the
===References===section at the bottom of the language's entry. See below for the format of this parameter. The parameter|nN=is a deprecated synonym; please do not use. |nocount=1- Turns off syllable counting.
|sort=- Manual sortkey. Use sparingly; the
makeSortKeymethod in Module:languages can usually generate the correct sortkey.
Inline modifiers
The |qN=, |qqN=, |aN=, |aaN= and |refN= parameters have corresponding inline modifiers <q:...>, <qq:...>, <a:...>, <aa:...> and <ref:...> that can be attached directly to a pronunciation argument. Example:
* {{IPA|en|/wʌt/|/wɑt/<a:sometimes also in <<GA>>>}}
which produces
- IPA(key): /wʌt/, (sometimes also in General American) /wɑt/
It is allowed, and common, to combine |a= with |aN=, or equivalently, with <a:...>. An example:
* {{IPA|en|a=GA|/ˈpɪŋˌpɔŋ/|;|/ˈpɪŋˌpɑŋ/<a:cot-caught>}}
which produces
- (General American) IPA(key): /ˈpɪŋˌpɔŋ/; (cot–caught merger) /ˈpɪŋˌpɑŋ/
This also shows the use of a bare semicolon argument to cause the separator between two pronunciations to appear as a semicolon.
Accepted symbols
Besides the official IPA, the following extensions are accepted:
‼ ᶑ ᵻ ᵿ ͈ ¡ ʬ ʭ ˭ ↑ ↓ ꟸ ᷽
as well as the following common substitutes:
¹ ² ³ ⁴ ⁵ 𝆏 𝆑 ⁻
References
The |refN= parameter is used to specify one or more references for a given pronunciation and works similarly to the <ref> tag. For example, specifying |ref={{R:it:DiPI|bendo}} is similar to placing <ref>{{R:it:DiPI|bendo}}</ref> after the call to {{IPA}}, except that it can be used to insert references directly after a given pronunciation when there are several.
To specify multiple references, separate them with !!! (optionally with spaces around it). For example, the following:
{{IPA|it|/ˈben.do/|/ˈbɛn.do/|ref2={{R:it:DiPI|bendo}} !!! {{R:it:Olivetti}}}}
is similar to the following:
{{IPA|it|/ˈben.do/|/ˈbɛn.do/}}<ref>{{R:it:DiPI|bendo}}</ref><ref>{{R:it:Olivetti}}</ref>
To specify the equivalent of the <ref name="NAME" group="GROUP">...</ref>, use <<name:NAME>> and/or <<group:GROUP>> directly following the reference text. For example, the following:
{{IPA|it|/ˈben.do/|/ˈbɛn.do/|ref2={{R:it:DiPI|bendo}}<<name:bendo>> !!! {{R:it:Olivetti}}}}
is similar to the following:
{{IPA|it|/ˈben.do/|/ˈbɛn.do/}}<ref name="bendo">{{R:it:DiPI|bendo}}</ref><ref>{{R:it:Olivetti}}</ref>
Similarly, the following:
{{IPA|it|/ˈben.do/|/ˈbɛn.do/|ref2={{R:it:DiPI|bendo}}<<name:bendo>><<group:pron>>}}
is similar to the following:
{{IPA|it|/ˈben.do/|/ˈbɛn.do/}}<ref name="bendo" group="pron">{{R:it:DiPI|bendo}}</ref>
To reference a prior name, as in <ref name="bendo"/>, leave the reference text blank:
{{IPA|it|/ˈben.do/|/ˈbɛn.do/|ref2=<<name:bendo>>}}
Similarly, to reference a prior name in a particular group, as in <ref name="bendo" group="pron"/>, use:
{{IPA|it|/ˈben.do/|/ˈbɛn.do/|ref2=<<name:bendo>><<group:pron>>}}
See also
TemplateData
TemplateData for IPA
This template adds the proper formatting and links to a pronunciation transcription in the International Phonetic Alphabet. It applies proper formatting and adds links to the language's IPA key using Module:IPA/templates. It should be used in pronunciation sections only. If the language has a template that automatically generates pronunciation from spelling, that template should be used instead of this one.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| language | 1 | The language code (see Wiktionary:Languages) for the current language section.
| String | required |
| IPA 1 | 2 | Indicates one or more pronunciations. These should be formatted in correct IPA and be surrounded by slashes / / for phonemic representations, and square brackets [ ] for phonetic representations.
| String | required |
| IPA 2 | 3 | Indicates one or more pronunciations. These should be formatted in correct IPA and be surrounded by slashes / / for phonemic representations, and square brackets [ ] for phonetic representations. | String | optional |
| IPA 3 | 4 | Indicates one or more pronunciations. These should be formatted in correct IPA and be surrounded by slashes / / for phonemic representations, and square brackets [ ] for phonetic representations. | String | optional |
| overall left qualifier | q | Specifies a qualifier to be placed at the very beginning. This is formatted with the {{q}}/{{qualifier}} template. | String | optional |
| overall right qualifier | qq | Specifies a qualifier to be placed at the very end. This is formatted with the {{q}}/{{qualifier}} template. | String | optional |
| overall left accent qualifier(s) | a | Specifies one or more comma-separated accent qualifiers to be placed at the very beginning. These are formatted with the {{a}}/{{accent}} template. | String | optional |
| overall right accent qualifier(s) | aa | Specifies one or more comma-separated accent qualifiers to be placed at the very end. These are formatted with the {{a}}/{{accent}} template. | String | optional |
| left qualifier 1 | q1 | Specifies a qualifier to be placed before pronunciation 1. This is formatted with the {{q}}/{{qualifier}} template. | String | optional |
| left qualifier 2 | q2 | Specifies a qualifier to be placed before pronunciation 2. This is formatted with the {{q}}/{{qualifier}} template. | String | optional |
| left qualifier 3 | q3 | Specifies a qualifier to be placed before pronunciation 3. This is formatted with the {{q}}/{{qualifier}} template. | String | optional |
| right qualifier 1 | qq1 | Specifies a qualifier to be placed after pronunciation 1. This is formatted with the {{q}}/{{qualifier}} template. | String | optional |
| right qualifier 2 | qq2 | Specifies a qualifier to be placed after pronunciation 2. This is formatted with the {{q}}/{{qualifier}} template. | String | optional |
| right qualifier 3 | qq3 | Specifies a qualifier to be placed after pronunciation 3. This is formatted with the {{q}}/{{qualifier}} template. | String | optional |
| left accent qualifier(s) 1 | a1 | Specifies one or more comma-separated accent qualifiers to be placed before pronunciation 1. These are formatted with the {{a}}/{{accent}} template. | String | optional |
| left accent qualifier(s) 2 | a2 | Specifies one or more comma-separated accent qualifiers to be placed before pronunciation 2. These are formatted with the {{a}}/{{accent}} template. | String | optional |
| left accent qualifier(s) 3 | a3 | Specifies one or more comma-separated accent qualifiers to be placed before pronunciation 3. These are formatted with the {{a}}/{{accent}} template. | String | optional |
| right accent qualifier(s) 1 | aa1 | Specifies one or more comma-separated accent qualifiers to be placed after pronunciation 1. These are formatted with the {{a}}/{{accent}} template. | String | optional |
| right accent qualifier(s) 2 | aa2 | Specifies one or more comma-separated accent qualifiers to be placed after pronunciation 2. These are formatted with the {{a}}/{{accent}} template. | String | optional |
| right accent qualifier(s) 3 | aa3 | Specifies one or more comma-separated accent qualifiers to be placed after pronunciation 3. These are formatted with the {{a}}/{{accent}} template. | String | optional |
| reference 1 | ref1 | Specifies a reference note to be placed after pronunciation 1. The reference is placed in the ===References=== section at the bottom of the language's entry. | String | optional |
| reference 2 | ref2 | Specifies a reference note to be placed after pronunciation 2. The reference is placed in the ===References=== section at the bottom of the language's entry. | String | optional |
| reference 3 | ref3 | Specifies a reference note to be placed after pronunciation 2. The reference is placed in the ===References=== section at the bottom of the language's entry. | String | optional |