Template:Audio/doc
Appearance
This is a documentation subpage for Template:Audio. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 30,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
Purpose
[edit]This template links to an audio file for quick listening. It is meant to be used inline with text, for pronunciations and the like. Please note that this just creates a link to the file and does not actually embed the file. If the file is Non-Free and only referenced via this template it is not in compliance with Wikipedia:Non-free content criteria § Policy #7.
The template uses the Phonos MediaWiki extension to create an audio link that plays on click.
Usage
[edit]{{Audio|name of sound file|text to use as link to soundfile}}
- Example
'''Alabama''' ({{Audio|en-us-Alabama.ogg|pronunciation}}) is a state located in...
- → Alabama (ⓘ) is a state located in...
TemplateData
[edit]This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Audio in articles based on its TemplateData.
TemplateData for Audio
Use this template to add an inline link to an audio file, preceded by a speaker icon.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Audio file | 1 | Audio file to link to
| File | required |
Label | 2 | Text to replace the filename in the link
| String | optional |
See also
[edit]- {{Listen}} – sets an audio clip off from the main text
- {{Listen image}} – sets an audio clip and an associated image off from the main text
- {{Audio}} – for inline sounds like pronunciations
- {{Audio-IPA}} – a variant of this template to be used with IPA notation
- {{Pronunciation}} – a shortcut for
{{small|{{Audio|soundfile.ogg|pronunciation}}}}
- {{Spoken Wikipedia}} – for linking spoken Wikipedia article versions
- {{Audio icon}} – adds only the small icon with no links
- {{Inline audio}} – adds a notice with link to Wikipedia:Media help