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

From blackwiki
Jump to navigation Jump to search
imported>Nardog
imported>Nardog
Line 8: Line 8:
 
== 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}}|gb}}</code> → {{{{BASEPAGENAME}}|gb}}
  
 
'''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 an audio 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}}|tt}}</code> → {{{{BASEPAGENAME}}|tt}}
  
 
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}}|tt|errortext=Custom error message}}</code> → {{{{BASEPAGENAME}}|tt|errortext=Custom error message}}
* <code><nowiki>{{IPA link|tt|errortext=blank}}</nowiki></code> → {{IPA link|tt|errortext=blank}}
+
* <code><nowiki>{{</nowiki>{{BASEPAGENAME}}|tt|errortext=blank}}</code> → {{{{BASEPAGENAME}}|tt|errortext=blank}}
  
 
{{IPA templates}}
 
{{IPA templates}}

Revision as of 04:02, 31 January 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.

{{IPAalink}}, {{IPAblink}} and {{IPAslink}} are versions with defined angular "⟨...⟩", square "[...]" or slash "/.../" brackets, respectively.

Usage

First parameter (required): any IPA symbol.

  • {{IPA link|m}}m
  • {{IPA link|gb}}gb

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}}

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|tt}}Error using {{IPA symbol}}: "tt" 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|tt|errortext=Custom error message}} → Custom error message
  • {{IPA link|tt|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