View source for Template:IPA link/doc

{{Documentation subpage}}
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
{{SpecialChars}}
The template {{tlb|IPA link}} creates a [[Hyperlink#Hyperlinks in wikis|wikilink]] from an IPA symbol to the respective phonetic article. IPA link displays the bare IPA symbol. Showing IPA defined brackets like "/…/" is an input option.

The conversion list, from symbol to article name, is not defined in this template, but inherited from {{tl|IPA symbol}}.

{{tlb|IPAalink}}, {{tlb|IPAblink}} and {{tlb|IPAslink}} are versions with defined [[Bracket#Angle brackets or chevrons|angular]] "{{angle bracket|…}}", [[Bracket#Square brackets|square]] "[…]" or [[Slash (punctuation)|slash]] "/…/" brackets, respectively.
__NOTOC__
== Usage ==
* '''First parameter''' or '''<code>ipa symbol=</code>''' (required): any IPA symbol or its IPA number, respectively.
* {{tlx|IPA link|m}} &rarr; {{IPA link|m}}
* {{tlx|IPA link|ɡb}} &rarr; {{IPA link|ɡb}}
* {{tlx|IPA link|301}} &rarr; {{IPA link|301}}

'''Brackets'''
* '''{{code|1=bracket=}}''', or '''second''' or '''third parameter''': set IPA bracket. Options are: <code>/</code>, <code>[</code>, and <code><</code>. Default is none. The angle bracket input can be input as {{Key press|<}} from a regular keyboard; the output displayed is the opening {{Unichar|27E8|MATHEMATICAL LEFT ANGLE BRACKET|html=}} and the closing {{Unichar|27E9|MATHEMATICAL RIGHT ANGLE BRACKET|html=}}.
* {{tlx|IPA link|m<nowiki>|<</nowiki>}} &rarr; {{IPA link|m|<}}
* {{tlx|IPA link|m<nowiki>||<</nowiki>}} &rarr; {{IPA link|m||<}}
* {{tlx|IPA link|301<nowiki>||<</nowiki>}} &rarr; {{IPA link|301||<}}
* {{tlx|IPA link|m<nowiki>||[</nowiki>}} &rarr; {{IPA link|m||[}}
* {{tlx|IPA link|ɡb<nowiki>||[</nowiki>}} &rarr; {{IPA link|ɡb||[}}
* {{tlx|IPA link|ɡb<nowiki>||/</nowiki>}} &rarr; {{IPA link|ɡb||/}}

'''Label'''
* '''<code>label=</code>''', or '''second''' or '''third parameter''': adds a label to the wikilink.
* {{tlx|IPA link|m<nowiki>|label=Any text</nowiki>}} &rarr; {{IPA link|m|label=Any text}}
* {{tlx|IPA link|m<nowiki>|Any text</nowiki>}} &rarr; {{IPA link|m|Any text}}
* {{tlx|IPA link|m<nowiki>||Any text</nowiki>}} &rarr; {{IPA link|m||Any text}}
* {{tlx|IPA link|ɡb<nowiki>|label=</nowiki>}} &rarr; {{IPA link|ɡb|label=}}
(Note: '''<code>showsymbol=</code>''' does the same, but it is deprecated.)

'''Combined:'''
* {{tlx|IPA link|ɡb<nowiki>|bracket=<|label=Any text</nowiki>}} &rarr; {{IPA link|ɡb|brackett=<|label=Any text}}
* {{tlx|IPA link|ɡb<nowiki>|Any text|/</nowiki>}} &rarr; {{IPA link|ɡb|Any text|/}}
* {{tlx|IPA link|ɡb<nowiki>|<|Any text</nowiki>}} &rarr; {{IPA link|ɡb|<|Any text}}

'''Direct page:'''

The target page can be set (overridden) by using '''{{code|1=direct page=}}''':
:<code><nowiki>{{IPA link|ʘ|<}}</nowiki></code> &rarr; {{IPA link|ʘ|<}}
:<code><nowiki>{{IPA link|ʘ|direct page=Bilabial clicks|<}}</nowiki></code> &rarr; {{IPA link|ʘ|direct page=Bilabial clicks|<}}

'''Audio link:'''

'''{{code|1=audio=yes}}''' adds a link to the corresponding audio file:
:<code><nowiki>{{IPA link|ɽ|[|audio=yes}}</nowiki></code> &rarr; {{IPA link|ɽ|[|audio=yes}}

If the value in '''{{code|1=audio=}}''' is a media file that exists, it will then link to that file instead:
:<code><nowiki>{{IPA link|ɽ|[|audio=Retroflex flaps.ogg}}</nowiki></code> &rarr; {{IPA link|ɽ|[|audio=Retroflex flaps.ogg}}

If the audio file is not specified at [[Module:IPA symbol/data]], the link will not appear:
:<code><nowiki>{{IPA link|s̬|[|audio=yes}}</nowiki></code> &rarr; {{IPA link|s̬|[|audio=yes}}

'''Error situation'''

If the IPA symbol is not defined in the {IPA symbol} table, then an error message is returned.
:<code><nowiki>{{IPA link|pʰɪk}}</nowiki></code> &rarr; {{IPA link|pʰɪk}}

The latter is normally more an example of accidental misuse than intentional use, or it could be a sign that a symbol is missing from the {{tl|IPA symbol}} table.

'''Option "showsymbol" deprecated (use <code>label=</code> or a second unnamed parameter, preferably)'''

The template can take the extra input like <code>showsymbol=A</code>, and then display that symbol, while also ''linking'' to the appropriate article. The symbol to be shown can also be the second unnamed parameter.
:<code><nowiki>{{IPA link|m|showsymbol=Anytext}}</nowiki></code> &rarr; {{IPA link|m|showsymbol=Anytext}}
:<code><nowiki>{{IPA link|ɽ͡r|showsymbol=*}}</nowiki></code> &rarr; {{IPA link|ɽ͡r|showsymbol=*}}

'''Option name'''

The '''<code>name=yes</code>''' parameter provides a display of the name of the phoneme (a function of {{tl|IPA symbol}}) to the right of the displayed symbol for the phoneme, as shown in the example below:
* {{tlx|IPA link|m<nowiki>|/|name=yes</nowiki>}} &rarr; {{IPA link|m|/|name=yes}}

==Full parameter list==
In the short form:
<pre>
{{IPA link
|
|
|
| name      =
| errortext =
| showsymbol=
}}
</pre>
Equally, the longer including optional names:
<pre>
{{IPA link
| ipa symbol= <!-- or 1st unnamed parameter-->
| label     = <!-- or 2nd unnamed paramter -->
| bracket   = <!-- or 3rd unnamed parameter -->
| name      = <!-- yes/no -->
| errortext =
| showsymbol= <!-- deprecated, use label= -->
}}
</pre>

==Known issue==
* The output should be enveloped in {{tl|nowrap}}.

== See also ==
* {{tl|IPAalink}} – creates a link in angle brackets: "{{angle bracket|…}}", for showing the IPA symbol, when linking to the named article
* {{tl|IPAblink}} – creates a link in IPA brackets: "[…]"
* {{tl|IPAdblink}} – creates a link in IPA double brackets: "⟦…⟧"
* {{tl|IPAslink}} – creates a link in IPA slashes: "/…/"
{{IPA templates}}

<includeonly>
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
[[Category:IPA symbol templates|IPA symbol]]
</includeonly>