View source for Template:Respell/doc

{{Documentation}}
<!--{{MessageBox
| class = info
| 1 = This template is for English words only.
| 2 = For notating pronunciation of non-English words that have not been assimilated into English, use {{T|IPA-all}} or the IPA template for the respective language. In addition, the template is merely to augment the IPA but never to replace it, and therefore '''should not be used alone without an IPA notation preceding it'''. See [[Runescape:Style guide/Pronunciation]] for more on showing pronunciation on RSWiki. If you need help transcribing the pronunciation into the IPA, please ask at [[User talk:Aikhana/Projects/Pronunciation]].
}}-->

This template formats pronunciation respellings of English words. It puts the input in italics, hyphenates each value so it will represent a syllable, and links to {{WP|Pronunciation respelling for English}}. Stressed syllables are input in uppercase and will appear slightly smaller than usual uppercase letters.

Notation must be spelled accordingly to the respelling key at {WP|Pronunciation respelling for English}}. For example, the word ''pronunciation'' ({{IPAc-en|IPA|p|r|ə|ˌ|n|ʌ|n|s|i|ˈ|eɪ|ʃ|ən}}) is respelled {{Respell|prə|NUN|see|AY|shən|link=no}}; using this template, the formatting is:
*<code><nowiki>{{Respell|prə|NUN|see|AY|shən}}</nowiki></code> → {{Respell|prə|NUN|see|AY|shən}}

==How to use==
Respelling is most commonly used to help clarify the pronunciation of a name or topic in the [[RuneScape:Style guide#Lead sections|lead section]] or introductory paragraph of an article. Per the [[RuneScape:Style guide/Pronunciation|style guide]], respelling may only follow and augment a corresponding {{WP|International Phonetic Alphabet|International Phonetic Alphabet}} template (e.g., {{T|IPAc-en}}) and may never be used in place of one. The template provides a link to a key so that readers may easily discover how to pronounce an easily mispronounced or difficult-to-pronounce word. For example:
*'''Ardougne''' ({{IPAc-en|ɑːr|ˈ|d|ɔɪ|n|}} {{Respell|arr|DOYN}}) is a city in the realm of [[Kandarin]]...
*:<code><nowiki>'''Ardougne''' ({{IPAc-en|ɑːr|ˈ|d|ɔɪ|n|}} {{Respell|arr|DOYN}}) is a city in the realm of [[Kandarin]]...</nowiki></code>

Common practice is to put no punctuation except one space between the IPA and the respelling for clarity, as in:
*'''Falador''' ({{IPAc-en|ˈ|f|ɑː|l|ə|d|ɔr}} {{Respell|FAH|lə|dor}}, {{IPAc-en|f|æ|-}} {{Respell|FA-}}) is the capital of [[Asgarnia]].
*:<code><nowiki>*'''Falador''' ({{IPAc-en|ˈ|f|ɑ|l|ə|d|ɔːr}} {{Respell|FAH|lə|dor}}, {{IPAc-en|f|æ|-}} {{Respell|FA-}}) is the capital of [[Asgarnia]].</nowiki></code>

Any argument containing an underscore or beginning or ending with a hyphen will not generate adjoining hyphens and will instead turn the underscore into a space, allowing for denoting word boundaries, alternate pronunciations, and affix ellipses. For example:
*<code><nowiki>{{Respell|SIH|rəl|_|kar|NEE|lee|ən}}</nowiki></code> → {{Respell|SIH|rəl|_|kar|NEE|lee|ən}}
*<code><nowiki>{{Respell|kar|NEE|lee|ən|,_-|NIH|-}}}</nowiki></code> → {{Respell|kar|NEE|lee|ən|,_-|NIH|-}}

An argument beginning in <code>(-</code> or ending in <code>-)</code> will also suppress the extra hyphen, so that optional syllables can be indicated.
*<code><nowiki>{{Respell|COOP|(-ay)}}</nowiki></code> → {{Respell|COOP|(-ay)}}

==Examples==
*'''Ceres''' {{IPAc-en|ˈ|s|ɪər|iː|z}} {{Respell|SEER|eez}}
*:<code><nowiki>{{Respell|SEER|eez}}</nowiki></code>
*'''Haumea''' {{IPAc-en|h|aʊ|ˈ|m|eɪ|ə}} {{Respell|how|MAY|ə}}
*:<code><nowiki>{{Respell|how|MAY|ə}}</nowiki></code>
*'''algorithm''' {{IPAc-en|ˈ|æ|l|ɡ|ə|r|ɪ|ð|əm}} {{Respell|AL|gə|ridh|əm}}
*:<code><nowiki>{{Respell|AL|gə|ridh|əm}}</nowiki></code>
*'''Makemake''' {{IPAc-en|ˌ|m|ɑː|k|eɪ|ˈ|m|ɑː|k|eɪ}} {{Respell|MAH|kay|MAH|kay}}
*:<code><nowiki>{{Respell|MAH|kay|MAH|kay}}</nowiki></code>
*'''disestablishmentarianism''' {{IPAc-en|d|ɪ|s|ə|ˌ|s|t|æ|b|l|ɪ|ʃ|m|ə|n|ˈ|t|ɛər|i|ə|n|ɪ|z|əm}} {{Respell|dis|ə|STAB|lish|mən|TAIR|ee|ə|niz|əm}}
*:<code><nowiki>{{Respell|dis|ə|STAB|lish|mən|TAIR|ee|ə|niz|əm}}</nowiki></code>
*'''Pan''' {{IPAc-en|p|æ|n}} {{Respell|PAN}}
*:<code><nowiki>{{Respell|PAN}}</nowiki></code>
*'''machine''' {{IPAc-en|m|ə|ˈ|ʃ|iː|n}} {{Respell|mə|SHEEN}}
*:<code><nowiki>{{Respell|mə|SHEEN}}</nowiki></code>
*'''overconsume''' {{IPAc-en|ˌ|oʊ|v|ər|k|ən|ˈ|sj|uː|m}} {{Respell|OH|vər|kən|SEWM}}
*:<code><nowiki>{{Respell|OH|vər|kən|SEWM}}</nowiki></code>
*'''Azerbaijan''' {{IPAc-en|ˌ|æ|z|ər|b|aɪ|ˈ|dʒ|ɑː|n}} {{Respell|AZ|ər|by|JAHN}}
*:<code><nowiki>{{Respell|AZ|ər|by|JAHN}}</nowiki></code>
*'''if you wish upon a star''' {{IPAc-en|ˌ|ɪ|f|_|j|uː|_|ˈ|w|ɪ|ʃ|_|ə|ˌ|p|ɒ|n|_|ə|_|ˈ|s|t|ɑːr}} {{Respell|IF|_|yoo|_|WISH|_|ə|PON|_|ə|_|STAR}}
*:<code><nowiki>{{Respell|IF|_|yoo|_|WISH|_|ə|PON|_|ə|_|STAR}}</nowiki></code>
*'''betting odds''' {{IPAc-en|ˈ|b|ɛ|t|ɪ|ŋ|_|ɒ|d|z}} {{Respell|BET|ing|_|odz}}
*:<code><nowiki>{{Respell|BET|ing|_|odz}}</nowiki></code>
*'''Jazze Pha''' {{IPAc-en|ˈ|dʒ|æ|z|i|_|ˈ|f|eɪ}} {{Respell|JAZ|ee|_|FAY}}
*:<code><nowiki>{{Respell|JAZ|ee|_|FAY}}</nowiki></code>

==Documentation==
<code>link=no</code> cancels the link to {{WP|Pronunciation respelling for English}}. This is for documentation outside the main namespace only.
*<code><nowiki>{{Respell|prə|NUN|see|AY|shən|link=no}}</nowiki></code> → {{Respell|prə|NUN|see|AY|shən|link=no}}

{{TemplateData|<templatedata>
{
	"params": {},
	"description": "This template formats pronunciation respellings of English words."
}
</templatedata>}}

==See also==
* {{T|IPAc-en}}, for broad English IPA transcriptions
<!--* {{T|IPA-all}}, for non-English language or otherwise narrow IPA transcriptions.-->
<!--{{Pronunciation resources}}-->