Template:Respell/doc

This is the current revision of this page, as edited by Alex (talk | contribs) at 00:44, 17 October 2024 (Created page with "{{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 m..."). The present address (URL) is a permanent link to this version.

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
This is a documentation subpage for Template:Respell.
It contains usage information, categories, and other content that is not part of the original template page.
Template:Respell invokes function main in Module:Respell using Lua.

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 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 (IPA: /prəˌnʌnsiˈʃən/) is respelled prə-NUN-see-AY-shən; using this template, the formatting is:

  • {{Respell|prə|NUN|see|AY|shən}}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 lead section or introductory paragraph of an article. Per the style guide, respelling may only follow and augment a corresponding International Phonetic Alphabet template (e.g., {{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 (/ɑːrˈdɔɪn/ arr-DOYN) is a city in the realm of Kandarin...
    '''Ardougne''' ({{IPAc-en|ɑːr|ˈ|d|ɔɪ|n|}} {{Respell|arr|DOYN}}) is a city in the realm of [[Kandarin]]...

Common practice is to put no punctuation except one space between the IPA and the respelling for clarity, as in:

  • Falador (/ˈfɑːlədɔːr/ FAH-lə-dor, /fæ-/ FA-) is the capital of Asgarnia.
    *'''Falador''' ({{IPAc-en|ˈ|f|ɑ|l|ə|d|ɔːr}} {{Respell|FAH|lə|dor}}, {{IPAc-en|f|æ|-}} {{Respell|FA-}}) is the capital of [[Asgarnia]].

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:

  • {{Respell|SIH|rəl|_|kar|NEE|lee|ən}}SIH-rəl kar-NEE-lee-ən
  • {{Respell|kar|NEE|lee|ən|,_-|NIH|-}}}kar-NEE-lee-ən, -⁠NIH-

An argument beginning in (- or ending in -) will also suppress the extra hyphen, so that optional syllables can be indicated.

  • {{Respell|COOP|(-ay)}}COOP(-ay)

Examples

Documentation

link=no cancels the link to Pronunciation respelling for English. This is for documentation outside the main namespace only.

  • {{Respell|prə|NUN|see|AY|shən|link=no}}prə-NUN-see-AY-shən

Template data

Show/hide template's data

The following information is used by extensions and applications, such as VisualEditor, to help users implement this template onto pages. Please ensure that it is up-to-date.

This template formats pronunciation respellings of English words.

Template parameters

ParameterDescriptionTypeStatus
No parameters specified

See also

  • {{IPAc-en}}, for broad English IPA transcriptions