Difference between revisions of "Template:IPA audio link/doc"
imported>Kaldari |
imported>Kaldari (usage) |
||
| Line 3: | Line 3: | ||
This template formats the audio link used by [[Template:IPA-all]] and similar templates at [[:Category:IPA templates]]. '''It should not be used directly in articles.''' | This template formats the audio link used by [[Template:IPA-all]] and similar templates at [[:Category:IPA templates]]. '''It should not be used directly in articles.''' | ||
| − | == | + | ==Usage== |
| − | + | Usage within an IPA template will typically be something similar to:<br> | |
| − | *:<code> | + | <code><nowiki>{{#if:{{{3|}}}|{{IPA audio link|{{{3}}}|attribution={{{attribution|}}} }} }}</nowiki></code> |
| − | * | + | Where "3" is the parameter for the file name (e.g. "Fr-Avignon.ogg") and "attribution" is an optional parameter specifying whether or not to create an attribution link (i.e. a link to the file page). |
| − | *:<code> | + | |
| + | ==Example output== | ||
| + | Note that this template is not intended for use directly in articles. The following examples are purely to show variations in output. | ||
| + | ; Basic | ||
| + | *[aviɲɔ̃]{{IPA audio link|Fr-Avignon.ogg}} | ||
| + | *:<code>[aviɲɔ̃]<nowiki>{{IPA audio link|Fr-Avignon.ogg}}</nowiki></code> | ||
| + | |||
| + | ; Without attribution link | ||
| + | Audio files which are licensed as CC0 or public domain may be linked to without an attribution link: | ||
| + | *[aviɲɔ̃]{{IPA audio link|Fr-Avignon.ogg|attribution=no}} | ||
| + | *:<code>[aviɲɔ̃]<nowiki>{{IPA audio link|Fr-Avignon.ogg|attribution=no}}</nowiki></code> | ||
==TemplateData== | ==TemplateData== | ||
Revision as of 16:21, 30 October 2020
| 40px | This is a documentation subpage for Template:IPA audio link. It contains usage information, categories and other content that is not part of the original template page. |
This template formats the audio link used by Template:IPA-all and similar templates at Category:IPA templates. It should not be used directly in articles.
Usage
Usage within an IPA template will typically be something similar to:
{{#if:{{{3|}}}|{{IPA audio link|{{{3}}}|attribution={{{attribution|}}} }} }}
Where "3" is the parameter for the file name (e.g. "Fr-Avignon.ogg") and "attribution" is an optional parameter specifying whether or not to create an attribution link (i.e. a link to the file page).
Example output
Note that this template is not intended for use directly in articles. The following examples are purely to show variations in output.
- Basic
- [aviɲɔ̃] (Audio file "Fr-Avignon.ogg" not found)
[aviɲɔ̃]{{IPA audio link|Fr-Avignon.ogg}}
- Without attribution link
Audio files which are licensed as CC0 or public domain may be linked to without an attribution link:
- [aviɲɔ̃] Audio file "Fr-Avignon.ogg" not found
[aviɲɔ̃]{{IPA audio link|Fr-Avignon.ogg|attribution=no}}
TemplateData
Formats the audio link used by IPA-all and similar templates
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Audio file | 1 | The audio file with the "FIle:" prefix
| Unknown | optional |
| Attribution link | attribution | If you set this to "no" the template will only display a speaker icon that links directly to the audio file (with no link to the File page).
| Unknown | optional |
