View source for Template:IPA/doc

{{documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{High-use}}
{{Lua|Module:IPA}}
{{Language templates}}

This template ensures proper display of a transcription in the [[International Phonetic Alphabet]] (IPA). It can also automatically provide a label indicating the language being transcribed and link to an explanatory guide. Its behavior changes drastically depending on whether more than one unnamed parameter is given. For broad transcriptions of English, use {{tl|IPAc-en}} instead.

==Usage==
The behavior of this template changes significantly depending on whether more than one unnamed parameter is given.

{{automarkup
|{{IPA{{!}}/ˌlɔːrəm ˈɪpsəm/}}
|{{IPA{{!}}la{{!}}ˌloːrɛm ˈɪpsʊm}}
}}

===Basic mode===
The basic usage of this template is just to pass an IPA transcription as the first argument, as in:

{{automarkup|{{IPA{{!}}/ˌlɔːrəm ˈɪpsəm/}}}}

Which might not look different from just the transcription without the template (/ˌlɔːrəm ˈɪpsəm/), but it actually outputs:

{{#tag:syntaxhighlight|{{IPA|/ˌlɔːrəm ˈɪpsəm/}}|lang=mediawiki}}

That is, it adds
* the <code>IPA</code> class, allowing registered users to assign a typeface of their choice (see {{section link|Help:IPA|Rendering issues}} for how);
* an [[IETF language tag]] indicating IPA as the writing system (see {{section link|Template:Lang|Rationale}} for more);
* a title attribute, which appears as a tooltip when the mouse hovers over the transcription;
* the <code>nowrap</code> class, preventing [[Line wrap and word wrap|line wrapping]] at inappropriate places like after <code>/</code> or <code>ˌ</code>;
* the <code>wrap</code> class to whitespace characters, allowing wrapping to occur at appropriate places.

All IPA text should be placed in the template, even if it consists entirely of ASCII characters, as in {{tlc|IPA|/mi/}}. This allows users to format all examples of IPA text consistently, and software like screen readers to interpret them accurately. If a substantial portion of a page uses IPA, post notice of that fact with {{tl|IPA notice}}.

====Issue with linking====
If the template is inside a wikilink, the link may not display correctly in certain namespaces (including the mainspace):

{{markup
|<nowiki>[[Lorem ipsum|{{IPA|/ˌlɔːrəm ˈɪpsəm/}}]]</nowiki>
|<nowiki>[[Lorem ipsum|</nowiki>{{IPA|/ˌlɔːrəm ˈɪpsəm/}}<nowiki>]]</nowiki>
}}

This is because the template by default inserts a category. To prevent it, add {{para|cat|no}}, as in:

{{automarkup|[[Lorem ipsum|{{IPA{{!}}/ˌlɔːrəm ˈɪpsəm/{{!}}cat=no}}]]}}

====Optional parameters====
{{see also|#Common parameters}}

; <code>lang</code>
: [[IETF language tag]] (e.g. <code>ar</code>, <code>pt-BR</code>) to be followed by <code>-Latn-fonipa</code>, replacing <code>und</code> (undetermined).
; <code>tooltip</code>
: Replaces the default tooltip "Representation in the International Phonetic Alphabet (IPA)". Leaving it blank means no tooltip.

===Guide-linking mode===
If more than one unnamed parameter is given, the first one is recognized as a language code and the second as the transcription. The transcription is automatically linked to one of the [[#List of keys|language-specific keys]] if a corresponding one exists, or to [[Help:IPA]] if not, and preceded by a label with the name of the language, as in {{tl|langx}}. Unlike in the basic mode, brackets are automatically added so need not be included in the input.

{{automarkup
|{{IPA{{!}}la{{!}}ˌloːrɛm ˈɪpsʊm}}
|{{IPA{{!}}pt-BR{{!}}sɐ̃w̃ ˈpawlu{{!}}lang{{!}}Br-SaoPaulo.ogg}}
|{{IPA{{!}}ki{{!}}ɣēkōjó{{!}}link{{=}}yes}}
}}

Notice the transcriptions are linked to language-specific keys in the first two examples, and to the generic guide in the rest. The language name and article link are automatically taken from [[Module:Lang]] by passing the language tag, unless overridden in [[Module:IPA/data]].

The behavior in this mode mimics {{tlc|IPA-xx}} templates that were created for a number of languages. {{tlf|IPA}} consolidates and replaces those templates for better maintenance and consistency.

====Parameters====
{{see also|#Common parameters}}

; First unnamed parameter
: [[IETF language tag]] (e.g. <code>ar</code>, <code>pt-BR</code>). See [[Template:Lang]] for more.
; Second unnamed parameter
: Transcription, without brackets.
; Third unnamed parameter
: Label code. Leave it blank to have no label at all. The label "[language name] pronunciation:" is used if the input is not empty but none of the below.
:* <code>lang</code>: "[language name]:"
:* <code>ipa</code>: "IPA:"
:* <code>pron</code>: "pronounced"
:* <code>also</code>: "also"
:* <code>alsolang</code>: "also [language name]:"
:* <code>langalso</code>: "[language name] also"
:* <code>local</code>: "locally"
:* <code>localpron</code>: "local pronunciation:"
; Fourth unnamed parameter
: Name of an audio file to accompany the transcription. Ignored if {{para|audio}} is given.
; <code>label</code>
: Text that precedes the transcription. Takes precedence over the third unnamed parameter.
; <code>link</code>
: If set to <code>yes</code>, the language name in the label will be linked to the article about the language.
; <code>small</code>
: If set to <code>no</code>, the label appears in the same size as the surrounding text. Be sure to use this where the text is already smaller, per [[MOS:SMALLTEXT]] (references, infoboxes, and navboxes are excluded by default).
; <code>generic</code>
: If set to <code>yes</code>, the transcription is linked not to the language-specific key but to the generic [[Help:IPA]]. This is [[MOS:PRON|required]] if the transcription does not adhere to the conventions laid out in the language-specific key, such as with non-standard dialects.

====List of keys====
These are defined in [[Module:IPA/data{{#ifeq:{{SUBPAGENAME}}|sandbox|/sandbox}}]].

{{#invoke:IPA/overview|keys}}

===Common parameters===
These parameters can be used in either mode.

; <code>audio</code>
: Name of an audio file to accompany the transcription. Takes precedence over the fourth unnamed parameter.
; <code>wrap</code>
: If set to <code>none</code>, wrapping is prevented for the entire transcription (i.e. the <code>wrap</code> class is not added to spaces). If set to <code>all</code>, no wrapping prevention takes place (i.e. the <code>nowrap</code> class is not added to the transcription).
; <code>class</code>
: HTML class(es) added to the span element containing the transcription.
; <code>cat</code>
: If set to <code>no</code>, the page will not be categorized under [[:Category:Pages with plain IPA]] (basic mode) or a language-specific subcategory of [[:Category:Pages with IPA]] (guide-linking mode).

==Tracking categories==
* A subcategory of [[:Category:Pages with IPA]] (if this is a red link, create it with the content {{tlx|IPA language category}})
* [[:Category:IPA template errors]] – added if more than one parameter is given and the first is an invalid language tag
* [[:Category:Pages including recorded pronunciations]] – added if the transcription has audio

These are added only in [[Module:Category handler]]'s default namespaces. If {{para|debug|yes}} is given, the categories that would be added are shown as links, no matter the namespace. This is for testcases only.

== TemplateData ==
{{collapse top|TemplateData}}
<templatedata>{
	"description": "This template ensures proper display of transcriptions using the International Phonetic Alphabet (IPA). Its behavior changes drastically depending on whether more than one unnamed parameter is given. For dialect-neutral transcriptions of English, use IPAc-en instead.",
	"params": {
		"1": {
			"label": "Transcription or language code",
			"description": "Transcription including brackets ([...] for a phonetic transcription and /.../ for a phonemic one) if this template is being used just for formatting. IETF language tag if used for linking the transcription to a language-specific key or introductory guide.",
			"type": "string",
			"required": true,
			"example": "[ɛɡzɑ̃pl], en"
		},
		"2": {
			"label": "Transcription",
			"description": "Without brackets.",
			"example": "ɛɡzɑ̃pl",
			"type": "string"
		},
		"3": {
			"label": "Label code",
			"description": "Replaces the default label \"[language name] pronunciation:\" with another canned one. Leave it blank to have no label.",
			"type": "string",
			"suggestedvalues": [
				"lang",
				"ipa",
				"pron",
				"also",
				"alsolang",
				"langalso",
				"local",
				"localpron"
			]
		},
		"audio": {
			"aliases": [
				"4"
			],
			"label": "Audio file",
			"description": "Name of an audio file to accompany the transcription.",
			"type": "wiki-file-name"
		},
		"label": {
			"label": "Label",
			"description": "Text that precedes the transcription. Unlike \"Label code\", this displays any wikitext as entered.",
			"type": "line"
		},
		"link": {
			"description": "\"yes\" links the language name in the label to the article about the language.",
			"type": "string",
			"suggestedvalues": [
				"yes"
			]
		},
		"small": {
			"description": "\"no\" cancels the reduction of the label size.",
			"type": "string",
			"suggestedvalues": [
				"no"
			]
		},
		"generic": {
			"description": "\"yes\" links the transcription to [[Help:IPA]] instead of a language-specific key. Required if the transcription does not adhere to the conventions of the language-specific key.",
			"type": "string",
			"suggestedvalues": [
				"yes"
			]
		},
		"wrap": {
			"description": "\"none\" prevents wrapping anywhere in the transcription. \"all\" cancels the prevention of wrapping after non-space characters in the transcription.",
			"type": "string",
			"suggestedvalues": [
				"none",
				"all"
			]
		},
		"class": {
			"description": "Additional HTML class(es) for the transcription.",
			"type": "string"
		},
		"lang": {
			"label": "Language code",
			"description": "IETF language tag when the first parameter is a transcription.",
			"example": "en",
			"type": "string"
		},
		"tooltip": {
			"label": "Tooltip",
			"description": "Tooltip to replace the default one with. Leave it blank to have no tooltip.",
			"type": "string"
		},
		"cat": {
			"description": "\"no\" cancels the categorization of the page into \"Pages with [language name] IPA\".",
			"type": "string",
			"suggestedvalues": [
				"no"
			]
		}
	},
	"paramOrder": [
		"1",
		"2",
		"3",
		"audio",
		"label",
		"link",
		"small",
		"generic",
		"wrap",
		"class",
		"lang",
		"tooltip",
		"cat"
	],
	"format": "inline"
}</templatedata>
{{collapse bottom}}

== Conversion templates ==
Some language-specific templates allow you to enter ordinary letters (or conventional ASCII equivalents) in place of IPA characters, and convert them to the phonetic symbols used to transcribe the language.

{| class="wikitable sortable"
! Language
! Template
! class="unsortable" | Code example
! class="unsortable" | Result
|-
| Cantonese
| class="nowrap" | {{tldep|IPAc-yue}}
| <code><nowiki>{{IPAc-yue|h|ung|2|.|z|i|2}}</nowiki></code>
| {{IPAc-yue|h|ung|2|.|z|i|2}}
|-
| Hungarian
| class="nowrap" | {{tldep|IPAc-hu}}
| <code><nowiki>{{IPAc-hu|'|m|a|gy|a|r}}</nowiki></code>
| {{IPAc-hu|'|m|a|gy|a|r}}
|-
| Mandarin
| class="nowrap" | {{tldep|IPAc-cmn}}
| <code><nowiki>{{IPAc-cmn|zh|ong|1|h|ua|2}}</nowiki></code>
| {{IPAc-cmn|zh|ong|1|h|ua|2}}
|-
| Polish
| class="nowrap" | {{tldep|IPAc-pl}}
| <code><nowiki>{{IPAc-pl|'|sz|cz|e|ć|i|n}}</nowiki></code>
| {{IPAc-pl|'|sz|cz|e|ć|i|n}}
|}

Some other conversion templates have also been created (see list at [[Special:PrefixIndex/Template:IPAc-]]), but they haven't been vetted by the community and may not produce output complying with the respective keys.

{{IPA templates}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:International Phonetic Alphabet templates| ]]
[[Category:Character templates]]
[[Category:Templates that add a tracking category]]

}}</includeonly>