Template:IPA symbol/doc

This template provides a simple conversion table from an IPA symbol to a Wikipedia article name. Its direct use is probably not too meaningful, but it can be useful inside other templates, e.g. IPA link. It is a meta-template.

The resulting article name should exist. The input symbol may be multiple characters.

Usage
This template has one parameter that is mandatory. The parameter must be an IPA symbol or a sequence of IPA symbols. A formatting template like IPA is not necessary.



Use  to specify the type of the output: "name", "symbol", "article", or "audio".
 * → (returns the primarily defined symbol)
 * → (returns the primarily defined symbol)
 * → (returns the primarily defined symbol)
 * → (returns the primarily defined symbol)

Certain symbols such as the tie bars, length marks, and dotted circle in the input are ignored so long as the rest of the input matches a definition, so that the below do not result in errors even though these individual combinations are not defined in the data.

If no direct match is found, the template will then look for the earliest instance of a diacritic in the input string.

A two-character diacritic takes precedence over a one-character one should they be found at the same position.

Some symbols in the input are automatically replaced by the more suitable counterparts.
 * (right single quotation mark) → (modifier letter apostrophe)

Data
The data is stored at Module:IPA symbol/data. It is divided into two groups: "sounds" and "diacritics". If no "article" is specified, the value for "name" will substitute it. A diacritic must be one or two Unicode characters. The data also stores substitution patterns for the input string.

Errors
If the input matches no definition in the data, an error message is returned and the page will be categorized into Category:International Phonetic Alphabet pages needing attention.

Optionally, an error text can be altered from the default message to any text by using the second parameter (if set to, the message will not appear at all). This cancels the addition of the error category.