Difference between revisions of "Template:IPA link/doc"

From blackwiki
Jump to navigation Jump to search
imported>Nardog
imported>Nardog
 
(8 intermediate revisions by the same user not shown)
Line 4: Line 4:
 
The template {{tl|IPA link}} takes an IPA symbol and turns it into a link to the respective article which discusses the sound the symbol represents.
 
The template {{tl|IPA link}} takes an IPA symbol and turns it into a link to the respective article which discusses the sound the symbol represents.
  
−
{{tl|IPAalink}}, {{tl|IPAblink}} and {{tl|IPAslink}} are versions with defined [[Bracket#Angle brackets or chevrons|angular]] "{{angle bracket|...}}", [[Bracket#Square brackets|square]] "[...]" or [[Slash (punctuation)|slash]] "/.../" brackets, respectively.
+
Versions with defined brackets are also available:
 +
* For phonetic representations, {{tl|IPAblink}} encloses the link in square brackets: {{IPAblink|a}}
 +
* For phonemic representations, {{tl|IPAslink}} encloses the link in slashes: {{IPAslink|a}}
 +
* For orthographic representations, {{tl|IPAalink}} encloses the link in angle brackets: {{IPAalink|a}}
 +
 
 +
Another version is {{tl|IPAplink}}, which encloses the link in neither brackets nor {{tag|span|attribs=class="IPA"}}, which is useful if the link is already inside {{tl|IPA}}, avoiding superfluous nesting of the same class.
  
 
== Usage ==
 
== Usage ==
 
'''First parameter''' (required): any IPA symbol.
 
'''First parameter''' (required): any IPA symbol.
−
* <code><nowiki>{{IPA link|m}}</nowiki></code> → {{IPA link|m}}
+
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|m}}</code> → {{{{BASEPAGENAME}}|m}}
−
* <code><nowiki>{{IPA link|gb}}</nowiki></code> → {{IPA link|gb}}
+
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|ɡb}}</code> → {{{{BASEPAGENAME}}|ɡb}}
  
 
'''Second parameter''': changes the label of the wikilink.
 
'''Second parameter''': changes the label of the wikilink.
−
* <code><nowiki>{{IPA link|m|Any text}}</nowiki></code> → {{IPA link|m|Any text}}
+
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|m|Any text}}</code> → {{{{BASEPAGENAME}}|m|Any text}}
  
 
'''Audio link'''
 
'''Audio link'''
  
 
{{para|audio|yes}} adds a link to the corresponding audio file:
 
{{para|audio|yes}} adds a link to the corresponding audio file:
−
* <code><nowiki>{{IPA link|ɽ|audio=yes}}</nowiki></code> → {{IPA link|ɽ|audio=yes}}
+
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|ɽ|audio=yes}}</code> → {{{{BASEPAGENAME}}|ɽ|audio=yes}}
  
−
If the value in {{para|audio}} is not "yes", "y", "true", etc., it is treated as the name of a sound file:
+
If the value in {{para|audio}} is not "yes", "y", "true", etc., it is treated as the name of an audio file:
−
* <code><nowiki>{{IPA link|ɽ|audio=Retroflex flaps.ogg}}</nowiki></code> → {{IPA link|ɽ|audio=Retroflex flaps.ogg}}
+
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|ɽ|audio=Retroflex flaps.ogg}}</code> → {{{{BASEPAGENAME}}|ɽ|audio=Retroflex flaps.ogg}}
  
 
If the audio file is not specified at [[Module:IPA symbol/data]], the link will not appear:
 
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> → {{IPA link|s̬|audio=yes}}
+
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|s̬|audio=yes}}</code> → {{{{BASEPAGENAME}}|s̬|audio=yes}}
  
 
'''Errors'''
 
'''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]].
 
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]].
−
* <code><nowiki>{{IPA link|tt}}</nowiki></code> → {{IPA link|tt}}
+
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|xyz}}</code> → {{{{BASEPAGENAME}}|xyz}}
  
 
The error message can be customized in {{para|errortext}}. This cancels the addition of the error category. If set to <code>blank</code>, the message will not appear at all.
 
The error message can be customized in {{para|errortext}}. This cancels the addition of the error category. If set to <code>blank</code>, the message will not appear at all.
−
* <code><nowiki>{{IPA link|tt|errortext=Custom error message}}</nowiki></code> → {{IPA link|tt|errortext=Custom error message}}
+
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|xyz|errortext=Custom error message}}</code> → {{{{BASEPAGENAME}}|xyz|errortext=Custom error message}}
−
* <code><nowiki>{{IPA link|tt|errortext=blank}}</nowiki></code> → {{IPA link|tt|errortext=blank}}
+
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|xyz|errortext=blank}}</code> → {{{{BASEPAGENAME}}|xyz|errortext=blank}}
  
 
{{IPA templates}}
 
{{IPA templates}}
  
 +
{{collapse top|TemplateData}}
 
<templatedata>
 
<templatedata>
 
{
 
{
Line 52: Line 58:
 
},
 
},
 
"audio": {
 
"audio": {
−
"label": "Sound file",
+
"label": "Audio",
 
"description": "Adds a link to sound if available",
 
"description": "Adds a link to sound if available",
 
"example": "yes",
 
"example": "yes",
Line 65: Line 71:
 
}
 
}
 
</templatedata>
 
</templatedata>
 +
{{collapse bottom}}
 
<includeonly>{{sandbox other||
 
<includeonly>{{sandbox other||
 
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
 
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->

Latest revision as of 23:06, 11 February 2019

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.

  • {{IPA link|m}} → m
  • {{IPA link|ɡb}} → ɡb

Second parameter: changes the label of the wikilink.

Audio link

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

  • {{IPA link|ɽ|audio=yes}} → ɽ (Audio file "Retroflex flap.ogg" not found)

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

  • {{IPA link|ɽ|audio=Retroflex flaps.ogg}} → ɽ (Audio file "Retroflex flaps.ogg" not found)

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

  • {{IPA link|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.

  • {{IPA link|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.

  • {{IPA link|xyz|errortext=Custom error message}} → Custom error message
  • {{IPA link|xyz|errortext=blank}} →
TemplateData

No description.

Template parameters

ParameterDescriptionTypeStatus
IPA symbol1

IPA symbol whose article to link to

Example
ʉː
Stringrequired
Display text2

Text to show instead of the IPA symbol

Stringoptional
Audioaudio

Adds a link to sound if available

Example
yes
Stringoptional
Error texterrortext

no description

Example
blank
Stringoptional
Retrieved from "https://blackwiki.org/index.php?title=Template:IPA_link/doc&oldid=5951244"