Template:IPA/documentation

Definition from Wiktionary, the free dictionary
Jump to: navigation, search
Edit-copy green.svg Documentation for Template:IPA. [edit]
This page contains usage information, categories, interwiki links and other content describing the template.

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 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[edit]

|lang=
The language code (see Wiktionary:Languages) for the current language section.
|1=, |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. They will be displayed separated by commas.
|qualN=
Specifies a qualifier to be placed before pronunciation N. This is formatted with the {{qualifier}} template.
|nN=
Specifies a reference note to be placed after pronunciation N. The reference is placed in the ===References=== section at the bottom of the language's entry.
|nocount=1
Turns off syllable counting.
|sort=
Manual sortkey. Use sparingly; the makeSortKey method in Module:languages can usually generate the correct sortkey.

See also[edit]

TemplateData[edit]

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

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.

Template parameters

This template has custom formatting.

Parameter Description Type Status
IPA 1 1

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.

Default
empty
Example
/aɪ piː ˈeɪ/
Auto value
empty
String required
IPA 2 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.

Default
empty
Example
empty
Auto value
empty
String optional
IPA 3 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.

Default
empty
Example
empty
Auto value
empty
String optional
language lang

The language code (see Wiktionary:Languages) for the current language section.

Default
empty
Example
en
Auto value
empty
String required
qualifier 1 qual1

Specifies a qualifier to be placed before pronunciation 1. This is formatted with the {{qualifier}} template

Default
empty
Example
empty
Auto value
empty
String optional
qualifier 2 qual2

Specifies a qualifier to be placed before pronunciation 2. This is formatted with the {{qualifier}} template

Default
empty
Example
empty
Auto value
empty
String optional
qualifier 3 qual3

Specifies a qualifier to be placed before pronunciation 3. This is formatted with the {{qualifier}} template

Default
empty
Example
empty
Auto value
empty
String optional
note 1 n1

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.

Default
empty
Example
empty
Auto value
empty
String optional
note 2 n2

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.

Default
empty
Example
empty
Auto value
empty
String optional
note 3 n3

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.

Default
empty
Example
empty
Auto value
empty
String optional