Difference between revisions of "Template:IPAc-en/doc"

From blackwiki
Jump to navigation Jump to search
imported>SUM1
(Fixed TemplateData)
(Blanked the page)
Line 1: Line 1:
{{documentation subpage}}
 
{{High use|36865}}
 
{{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 {{tl|IPA-endia}} or {{tl|IPA-all}} instead.
 
 
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|/aɪ.ər/}}, {{IPA|/iːər/}} and {{IPA|/iə/}}, which need to be input as <code>aɪ|.|ər</code>, <code>iː|ər</code> and <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> to separate the variants which will appear as a comma. 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 collapsed 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 [[SAMPA chart|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 ==
 
{{TemplateData header}}
 
<templatedata>
 
{
 
"format": "inline",
 
"params": {}
 
}
 
</templatedata>
 
 
== 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>
 

Revision as of 16:16, 20 September 2020