Editing Template:IPAc-en/doc

{{documentation subpage}}
{{High-use}}
{{lua|Module:IPAc-en}}
'''Note: Per [[WP:LEAD]], do not use this template in the lead section for common English words (e.g., ''[[pub]]'', ''[[rose]]'', ''[[pencil]]'', ''[[bus]]'', ''[[Monday]]'', ''[[Earth]]'', etc.).'''

This template is used to display English [[International Phonetic Alphabet]] (IPA). The pronunciation is broken into individual [[diaphoneme]]s so that they will have tooltips (mouse-over text) to indicate pronunciation. All diaphonemes from [[Help:IPA/English]] are available.

The transcription system of [[Help:IPA/English]], upon which this template relies, is diaphonemic, i.e. meant to cover multiple major varieties of English at once. If you wish to give a narrow transcription of a pronunciation in a certain variety of English, use {{tlx|IPA|2=en{{pipe}}...{{pipe}}generic=yes}}.

The initial argument (entry after |) can be used to indicate a pronunciation prescript; link to IPA. The codes are:
{| class="wikitable mw-collapsible mw-collapsed"
|+ class="nowrap" | Pronunciation & IPA link codes
! Code !! Output
|-
| <code>lang</code> || English:
|-
| <code>local</code> || locally
|-
| <code>ipa</code> || [[International Phonetic Alphabet|IPA]]:
|-
| <code>also</code> || also
|-
| <code>uk</code> || [[British English|UK]]:
|-
| <code>us</code> || [[American English|US]]:
|-
| <code>uklang</code> || [[British English]]:
|-
| <code>uslang</code> || [[American English]]:
|-
| <code>ukalso</code> || [[British English|UK]] also
|-
| <code>usalso</code> || [[American English|US]] also
|-
| <code>alsouk</code> || also [[British English|UK]]:
|-
| <code>alsous</code> || also [[American English|US]]:
|}

The first argument that is not a code above will be treated as a diaphoneme. All diaphonemes listed at [[Help:IPA/English]] are available (except the ones that span two syllables such as {{IPA|/iə/}}, which need to be input as <code>i|ə</code>). Also available are {{IPA|/ɪəˈr/}}, {{IPA|/ɛəˈr/}}, {{IPA|/ʊəˈr/}}, {{IPA|/ɪəˌr/}}, {{IPA|/ɛəˌr/}}, and {{IPA|/ʊəˌr/}}, preserved for when a centering diphthong precedes a stress.

;Separator codes
:Use an underscore <code>_</code> to separate words. When multiple pronunciations for the same word(s) are possible, use a comma and an underscore <code>,_</code>, which will appear as a comma, to separate the variants. As necessary, use a hyphen <code>-</code> to indicate omitted syllables. Diaphonemes are underlined, but separators are not, and separators do not have any tooltip text.

See the table below for a full list of diaphoneme codes.

{{collapse top|Diaphoneme codes|expand=yes}}
Note that the aliases include ones that are kept merely for compatibility reasons and therefore not recommended for further use, as they might not accurately represent the sound represented by the output.
{{#invoke:IPAc-en/documentation|phonemes}}
{{collapse bottom}}

The named parameter {{para|audio}} may be used to link to an audio file.

== Examples ==
* <code><nowiki>{{IPAc-en|ˌ|æ|l|ə|ˈ|b|æ|m|ə}}</nowiki></code> → {{IPAc-en|ˌ|æ|l|ə|ˈ|b|æ|m|ə}}
* <code><nowiki>{{IPAc-en|audio=en-us-Alabama.ogg|ˌ|æ|l|ə|ˈ|b|æ|m|ə}}</nowiki></code> → {{IPAc-en|audio=en-us-Alabama.ogg|ˌ|æ|l|ə|ˈ|b|æ|m|ə}}
* <code><nowiki>{{IPAc-en|US|audio=en-us-Alabama.ogg|ˌ|æ|l|ə|ˈ|b|æ|m|ə}}</nowiki></code> → {{IPAc-en|US|audio=en-us-Alabama.ogg|ˌ|æ|l|ə|ˈ|b|æ|m|ə}}

Examples using [[X-SAMPA]] spelling for individual diaphonemes:
* <code><nowiki>{{IPAc-en|,|{|l|@|'|b|{|m|@}}</nowiki></code> → {{IPAc-en|,|{|l|@|'|b|{|m|@}}
* <code><nowiki>{{IPAc-en|lang|audio=en-us-Alabama.ogg|,|{|l|@|'|b|{|m|@}}</nowiki></code> → {{IPAc-en|lang|audio=en-us-Alabama.ogg|,|{|l|@|'|b|{|m|@}}

If "[invalid input]" is displayed, it means that an unsupported input was used. Such instances are tallied at [[:Category:Ill-formatted IPAc-en transclusions]], where they can be reviewed and fixed.

Notations with audio links will appear under [[:Category:Pages including recorded pronunciations]].

== TemplateData ==
{{collapse top|TemplateData}}
{{TemplateData header}}
<templatedata>
{
	"format": "inline",
	"params": {
		"1": {
			"label": "1st input",
			"type": "string",
			"required": true
		},
		"2": {
			"label": "2nd input",
			"type": "string",
			"required": false
		},
		"3": {
			"label": "3rd input",
			"type": "string",
			"required": false
		},
		"4": {
			"label": "4th input",
			"type": "string",
			"required": false
		},
		"5": {
			"label": "5th input",
			"type": "string",
			"required": false
		},
		"6": {
			"label": "6th input",
			"type": "string",
			"required": false
		},
		"7": {
			"label": "7th input",
			"type": "string",
			"required": false
		},
		"8": {
			"label": "8th input",
			"type": "string",
			"required": false
		},
		"9": {
			"label": "9th input",
			"type": "string",
			"required": false
		},
		"10": {
			"label": "10th input",
			"type": "string",
			"required": false
		},
		"11": {
			"label": "11th input",
			"type": "string",
			"required": false
		},
		"12": {
			"label": "12th input",
			"type": "string",
			"required": false
		},
		"13": {
			"label": "13th input",
			"type": "string",
			"required": false
		},
		"14": {
			"label": "14th input",
			"type": "string",
			"required": false
		},
		"15": {
			"label": "15th input",
			"type": "string",
			"required": false
		},
		"16": {
			"label": "16th input",
			"type": "string",
			"required": false
		},
		"17": {
			"label": "17th input",
			"type": "string",
			"required": false
		},
		"18": {
			"label": "18th input",
			"type": "string",
			"required": false
		},
		"19": {
			"label": "19th input",
			"type": "string",
			"required": false
		},
		"20": {
			"label": "20th input",
			"type": "string",
			"required": false
		},
		"21": {
			"label": "21st input",
			"type": "string",
			"required": false
		},
		"22": {
			"label": "22nd input",
			"type": "string",
			"required": false
		},
		"23": {
			"label": "23rd input",
			"type": "string",
			"required": false
		},
		"24": {
			"label": "24th input",
			"type": "string",
			"required": false
		},
		"25": {
			"label": "25th input",
			"type": "string",
			"required": false
		},
		"26": {
			"label": "26th input",
			"type": "string",
			"required": false
		},
		"27": {
			"label": "27th input",
			"type": "string",
			"required": false
		},
		"28": {
			"label": "28th input",
			"type": "string",
			"required": false
		},
		"29": {
			"label": "29th input",
			"type": "string",
			"required": false
		},
		"30": {
			"label": "30th input",
			"type": "string",
			"required": false
		},
		"31": {
			"label": "31st input",
			"type": "string",
			"required": false
		},
		"32": {
			"label": "32nd input",
			"type": "string",
			"required": false
		},
		"33": {
			"label": "33rd input",
			"type": "string",
			"required": false
		},
		"34": {
			"label": "34th input",
			"type": "string",
			"required": false
		},
		"35": {
			"label": "35th input",
			"type": "string",
			"required": false
		},
		"36": {
			"label": "36th input",
			"type": "string",
			"required": false
		},
		"37": {
			"label": "37th input",
			"type": "string",
			"required": false
		},
		"38": {
			"label": "38th input",
			"type": "string",
			"required": false
		},
		"39": {
			"label": "39th input",
			"type": "string",
			"required": false
		},
		"40": {
			"label": "40th input",
			"type": "string",
			"required": false
		},
		"41": {
			"label": "41st input",
			"type": "string",
			"required": false
		},
		"42": {
			"label": "42nd input",
			"type": "string",
			"required": false
		},
		"43": {
			"label": "43rd input",
			"type": "string",
			"required": false
		},
		"44": {
			"label": "44th input",
			"type": "string",
			"required": false
		},
		"45": {
			"label": "45th input",
			"type": "string",
			"required": false
		},
		"46": {
			"label": "46th input",
			"type": "string",
			"required": false
		},
		"47": {
			"label": "47th input",
			"type": "string",
			"required": false
		},
		"48": {
			"label": "48th input",
			"type": "string",
			"required": false
		},
		"49": {
			"label": "49th input",
			"type": "string",
			"required": false
		},
		"50": {
			"label": "50th input",
			"type": "string",
			"required": false
		},
		"51": {
			"label": "51st input",
			"type": "string",
			"required": false
		},
		"52": {
			"label": "52nd input",
			"type": "string",
			"required": false
		},
		"53": {
			"label": "53rd input",
			"type": "string",
			"required": false
		},
		"54": {
			"label": "54th input",
			"type": "string",
			"required": false
		},
		"55": {
			"label": "55th input",
			"type": "string",
			"required": false
		},
		"56": {
			"label": "56th input",
			"type": "string",
			"required": false
		},
		"57": {
			"label": "57th input",
			"type": "string",
			"required": false
		},
		"58": {
			"label": "58th input",
			"type": "string",
			"required": false
		},
		"59": {
			"label": "59th input",
			"type": "string",
			"required": false
		},
		"60": {
			"label": "60th input",
			"type": "string",
			"required": false
		},
		"61": {
			"label": "61st input",
			"type": "string",
			"required": false
		},
		"62": {
			"label": "62nd input",
			"type": "string",
			"required": false
		},
		"63": {
			"label": "63rd input",
			"type": "string",
			"required": false
		},
		"64": {
			"label": "64th input",
			"type": "string",
			"required": false
		},
		"65": {
			"label": "65th input",
			"type": "string",
			"required": false
		},
		"66": {
			"label": "66th input",
			"type": "string",
			"required": false
		},
		"67": {
			"label": "67th input",
			"type": "string",
			"required": false
		},
		"68": {
			"label": "68th input",
			"type": "string",
			"required": false
		},
		"69": {
			"label": "69th input",
			"type": "string",
			"required": false
		},
		"70": {
			"label": "70th input",
			"type": "string",
			"required": false
		},
		"71": {
			"label": "71st input",
			"type": "string",
			"required": false
		},
		"72": {
			"label": "72nd input",
			"type": "string",
			"required": false
		},
		"73": {
			"label": "73rd input",
			"type": "string",
			"required": false
		},
		"74": {
			"label": "74th input",
			"type": "string",
			"required": false
		},
		"75": {
			"label": "75th input",
			"type": "string",
			"required": false
		},
		"76": {
			"label": "76th input",
			"type": "string",
			"required": false
		},
		"77": {
			"label": "77th input",
			"type": "string",
			"required": false
		},
		"78": {
			"label": "78th input",
			"type": "string",
			"required": false
		},
		"79": {
			"label": "79th input",
			"type": "string",
			"required": false
		},
		"80": {
			"label": "80th input",
			"type": "string",
			"required": false
		},
		"81": {
			"label": "81st input",
			"type": "string",
			"required": false
		},
		"82": {
			"label": "82nd input",
			"type": "string",
			"required": false
		},
		"83": {
			"label": "83rd input",
			"type": "string",
			"required": false
		},
		"84": {
			"label": "84th input",
			"type": "string",
			"required": false
		},
		"85": {
			"label": "85th input",
			"type": "string",
			"required": false
		},
		"86": {
			"label": "86th input",
			"type": "string",
			"required": false
		},
		"87": {
			"label": "87th input",
			"type": "string",
			"required": false
		},
		"88": {
			"label": "88th input",
			"type": "string",
			"required": false
		},
		"89": {
			"label": "89th input",
			"type": "string",
			"required": false
		},
		"90": {
			"label": "90th input",
			"type": "string",
			"required": false
		},
		"91": {
			"label": "91st input",
			"type": "string",
			"required": false
		},
		"92": {
			"label": "92nd input",
			"type": "string",
			"required": false
		},
		"93": {
			"label": "93rd input",
			"type": "string",
			"required": false
		},
		"94": {
			"label": "94th input",
			"type": "string",
			"required": false
		},
		"95": {
			"label": "95th input",
			"type": "string",
			"required": false
		},
		"96": {
			"label": "96th input",
			"type": "string",
			"required": false
		},
		"97": {
			"label": "97th input",
			"type": "string",
			"required": false
		},
		"98": {
			"label": "98th input",
			"type": "string",
			"required": false
		},
		"99": {
			"label": "99th input",
			"type": "string",
			"required": false
		},
		"100": {
			"label": "100th input",
			"type": "string",
			"required": false
		},
		"audio": {
			"label": "Audio file",
			"description": "The audio file without the \"File:\" prefix",
			"example": "En-us-Foobar.ogg",
			"type": "wiki-file-name"
		}
	}
}
</templatedata>
{{collapse bottom}}

== See also ==
* {{tl|Respell}}, for [[Help:Pronunciation respelling key|pronunciation respelling]]s, which may be used for English words in addition to the IPA

{{IPA templates}}

<includeonly>{{Sandbox other||
[[Category:IPA language templates|c]]
[[Category:Templates that add a tracking category]]

}}</includeonly>