Template:Audio/doc
 | This is a documentation subpage for Template:Audio. It contains usage information, categories and other content that is not part of the original template page. |
Purpose[edit source]
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 Starfleet:Non-free content criteria § Policy #7.
Usage[edit source]
- 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 (
pronunciation (help·info)) 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 ( pronunciation)
- Todo: add
{{inline audio}}to this page.
Microformat[edit source]
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 this microformat uses include:
- haudio
- fn
- album
- description
- category
- contributor
- duration
- h
- item
- min
- photo
- position
- price
- published
- s
nor collapse nested elements which use them.
See also[edit source]
- {{Audio}}, for inline sounds like pronunciations (with a help link)
- {{Audio-nohelp}}, without a help link
- {{Inline audio}}, which adds notice with link to Starfleet:Media help
- {{Audio-IPA}}, a variant of this template to be used with IPA notation.
- {{Listen}}, which sets an audio clip off from the main text
- {{Synthlisten}}, for MIDI files, rendering into Ogg using Fluidsynth.
- {{Listen MIDI}}, for MIDI files, giving a download link only.
- {{Multi-listen start}}, {{Multi-listen item}}, and {{Multi-listen end}}, templates used to list multiple audio files in the same box
- {{Pronunciation}}, a shortcut for
<small>{{Audio|soundfile.ogg|pronunciation}}</small> - {{Spoken}}, which adds only the small icon with no links
External links[edit source]
- Template:Audio/doc at Wikipedia, the free Terran encyclopedia that anyone can edit.