Template:Audio/doc
| File:Edit-copy green.svg | 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. |
| File:Ambox warning yellow.svg | This template is used on approximately 27,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
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.
Usage
- Basic
{{Audio|name of sound file|text to use as link to soundfile|help=}}
- Simple
'''Alabama''' ({{Audio|en-us-Alabama.ogg|pronunciation}}) is a state located in...- → Alabama (Template:Error-small) is a state located in...
- Help links
Setting |help=no disables the "help/info" links. If this is done the template {{inline audio}} must be shown on the page.
'''Alabama''' ({{Audio|en-us-Alabama.ogg|pronunciation of "Alabama"|help=no}})- → Alabama (Template:Error-small)
- Todo: add
{{inline audio}}to this page.
Microformat
The HTML mark-up produced by this template includes an hAudio microformat that makes an audio recording's details readily parsable by computer programs. This aids tasks such as the cataloguing of articles and maintenance of databases. For more information about the use of microformats on Wikipedia, please visit the Microformat WikiProject.
- Subtemplates
Date-of-publication ("published") information will only be included in the microformat if {{start date}} (or, where appropriate, {{start date and age}}) is used in a parent infobox/template. Do not, however, use {{start date}} or {{start date and age}} if a date before 1583 CE is involved.
Use {{duration}} to specify the duration/length of a recording. For instance, if the recording's duration is 3 minutes 45 seconds, use {{duration|m=3|s=45}} (which appears as: 3:45). If needed, |h= may be included to specify a number of hours.
Please do not remove instances of these subtemplates.
- Classes used
The HTML classes of this microformat include:
- haudio
- fn
- album
- description
- category
- contributor
- duration
- h
- item
- min
- photo
- position
- price
- published
- s
nor collapse nested elements which use them.
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 |
| Show "(help·info)" links? | help | Enter "no" here to remove the "(help·info)" links.
| Line | optional |
See also
- {{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 (with a help link)
- {{Audio-IPA}} – a variant of this template to be used with IPA notation
- {{Pronunciation}} – a shortcut for
{{small|{{Audio|soundfile.ogg|pronunciation}}}} - {{Audio-nohelp}} – without a help link
- {{Spoken Wikipedia}} – for linking spoken Wikipedia article versions
- {{Multi-listen start}}, {{Multi-listen item}}, and {{Multi-listen end}} – used to list multiple audio files in the same box
- {{Audio icon}} – adds only the small icon with no links
- {{Inline audio}} – adds a notice with link to Wikipedia:Media help