Template:IPA/documentation

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. To turn off syllable counting, add the parameter 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 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  for an example of this. Note that semicolons do not count for the purposes of indexed parameters; thus, an example like en is correct and will result in the  accent qualifier being displayed directly before the pronunciation, while en 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.


 * q N
 * Specifies a qualifier to be placed before pronunciation N . This is formatted with the q/qualifier template. The parameter qual N 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.


 * qq N
 * Specifies a qualifier to be placed after pronunciation N . This is formatted with the q/qualifier template.


 * a N
 * 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.


 * aa N
 * 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.


 * ref N
 * Specifies one or more reference notes to be placed after pronunciation N . The reference is placed in the  section at the bottom of the language's entry. See below for the format of this parameter. The parameter n N is a deprecated synonym; please do not use.


 * 1
 * Turns off syllable counting.


 * sort
 * Manual sortkey. Use sparingly; the lua method in Module:languages can usually generate the correct sortkey.

Inline modifiers
The q N, qq N, a N, aa N and ref N parameters have corresponding inline modifiers, , , and  that can be attached directly to a pronunciation argument. Example:

which produces

It is allowed, and common, to combine a with a N, or equivalently, with. An example:

which produces

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: ¹ ² ³ ⁴ ⁵ 𝆏 𝆑 ⁻

TemplateData
{	"params": { "1": {			"label": "language", "description": "The language code (see Wiktionary:Languages) for the current language section.", "example": "en", "type": "string", "required": true },		"2": {			"description": "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.", "example": "/aɪ piː ˈeɪ/", "type": "string", "required": true, "label": "IPA 1" },		"3": {			"description": "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.", "type": "string", "label": "IPA 2" },		"4": {			"description": "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.", "type": "string", "label": "IPA 3" },		"q": { "label": "overall left qualifier", "description": "Specifies a qualifier to be placed at the very beginning. This is formatted with the / template.", "type": "string" },		"qq": { "label": "overall right qualifier", "description": "Specifies a qualifier to be placed at the very end. This is formatted with the / template.", "type": "string" },		"a": { "label": "overall left accent qualifier(s)", "description": "Specifies one or more comma-separated accent qualifiers to be placed at the very beginning. These are formatted with the / template.", "type": "string" },		"aa": { "label": "overall right accent qualifier(s)", "description": "Specifies one or more comma-separated accent qualifiers to be placed at the very end. These are formatted with the / template.", "type": "string" },		"q1": { "label": "left qualifier 1", "description": "Specifies a qualifier to be placed before pronunciation 1. This is formatted with the / template.", "type": "string" },		"q2": { "label": "left qualifier 2", "description": "Specifies a qualifier to be placed before pronunciation 2. This is formatted with the / template.", "type": "string" },		"q3": { "label": "left qualifier 3", "description": "Specifies a qualifier to be placed before pronunciation 3. This is formatted with the / template.", "type": "string" },		"qq1": { "label": "right qualifier 1", "description": "Specifies a qualifier to be placed after pronunciation 1. This is formatted with the / template.", "type": "string" },		"qq2": { "label": "right qualifier 2", "description": "Specifies a qualifier to be placed after pronunciation 2. This is formatted with the / template.", "type": "string" },		"qq3": { "label": "right qualifier 3", "description": "Specifies a qualifier to be placed after pronunciation 3. This is formatted with the / template.", "type": "string" },		"a1": { "label": "left accent qualifier(s) 1", "description": "Specifies one or more comma-separated accent qualifiers to be placed before pronunciation 1. These are formatted with the / template.", "type": "string" },		"a2": { "label": "left accent qualifier(s) 2", "description": "Specifies one or more comma-separated accent qualifiers to be placed before pronunciation 2. These are formatted with the / template.", "type": "string" },		"a3": { "label": "left accent qualifier(s) 3", "description": "Specifies one or more comma-separated accent qualifiers to be placed before pronunciation 3. These are formatted with the / template.", "type": "string" },		"aa1": { "label": "right accent qualifier(s) 1", "description": "Specifies one or more comma-separated accent qualifiers to be placed after pronunciation 1. These are formatted with the / template.", "type": "string" },		"aa2": { "label": "right accent qualifier(s) 2", "description": "Specifies one or more comma-separated accent qualifiers to be placed after pronunciation 2. These are formatted with the / template.", "type": "string" },		"aa3": { "label": "right accent qualifier(s) 3", "description": "Specifies one or more comma-separated accent qualifiers to be placed after pronunciation 3. These are formatted with the / template.", "type": "string" },		"ref1": { "label": "reference 1", "description": "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.", "type": "string" },		"ref2": { "label": "reference 2", "description": "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.", "type": "string" },		"ref3": { "label": "reference 3", "description": "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.", "type": "string" }	},	"description": "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.", "format": "inline", "paramOrder": [ "1",		"2",		"3",		"4",		"q", "qq", "a", "aa", "q1", "q2", "q3", "qq1", "qq2", "qq3", "a1", "a2", "a3", "aa1", "aa2", "aa3", "ref1", "ref2", "ref3" ] }

fa:الگو:آی‌پی‌ای