Template:IPAalink/doc

This is a documentation subpage for Template:IPAalink.
It may contain usage information, categories and other content that is not part of the original template page.

This template uses Lua:

Module:IPA symbol (sandbox)

The template {{IPA link}} takes an IPA symbol and turns it into a link to the respective article which discusses the sound the symbol represents.

Versions with defined brackets are also available:

For phonetic representations, {{IPAblink}} encloses the link in square brackets: [a]
For phonemic representations, {{IPAslink}} encloses the link in slashes: /a/
For orthographic representations, {{IPAalink}} encloses the link in angle brackets: ⟨a⟩

Another version is {{IPAplink}}, which encloses the link in neither brackets nor <span class="IPA">...</span>, which is useful if the link is already inside {{IPA}}, avoiding superfluous nesting of the same class.

Usage

First parameter (required): any IPA symbol.

{{IPAalink|m}} → ⟨m⟩
{{IPAalink|ɡb}} → ⟨ɡb⟩

Second parameter: changes the label of the wikilink.

{{IPAalink|m|Any text}} → ⟨Any text⟩

Audio link

|audio=yes adds a link to the corresponding audio file:

{{IPAalink|ɽ|audio=yes}} → ⟨ɽ⟩ (listen)

If the value in |audio= is not "yes", "y", "true", etc., it is treated as the name of an audio file:

{{IPAalink|ɽ|audio=Retroflex flaps.ogg}} → ⟨ɽ⟩ (listen)

If the audio file is not specified at Module:IPA symbol/data, the link will not appear:

{{IPAalink|s̬|audio=yes}} → ⟨s̬⟩

Errors

If the IPA symbol is not defined at Module:IPA symbol/data, then an error message is returned and the page will be categorized into Category:International Phonetic Alphabet pages needing attention.

{{IPAalink|xyz}} → Error using {{IPA symbol}}: "xyz" not found in list

The error message can be customized in |errortext=. This cancels the addition of the error category. If set to blank, the message will not appear at all.

{{IPAalink|xyz|errortext=Custom error message}} → Custom error message
{{IPAalink|xyz|errortext=blank}} →

TemplateData

No description.

Template parameters
Parameter		Description	Type	Status
IPA symbol	`1`	IPA symbol whose article to link to Example ʉː	String	required
Display text	`2`	Text to show instead of the IPA symbol	String	optional
Audio	`audio`	Adds a link to sound if available Example yes	String	optional
Error text	`errortext`	no description Example blank	String	optional