Template:Listen/doc

{{Listen/doc}} allows audio files to be embedded in articles. It should be used for audio files that are set off from the text, like music clips or sound recordings.

Simple usage

{{Listen
| filename    = 
| title       = 
| description = 
| pos         = 
}}

• filename (Required): the pagename of the media file, without the File: (formerly Image:) prefix
• title (Required): the title of the audio file, to be displayed. Do not use quote marks around song titles. Do not use wikilinks in the title – they will not work.
• description: a description of the audio file
• pos = left or right

Multiple files

Additional files can be embedded in an article with one template by appending a number to each parameter. Up to ten files can be included.

{{Listen
| filename     = 
| title        = 
| alt          = 
| description  = 
| filename2    = 
| title2       = 
| alt2         = 
| description2 = 
| filename3    = 
| title3       = 
| alt3         = 
| description3 = 
}}

• filename (Required): the pagename of the media file, without the File: (formerly Image:) prefix
• title (Required): the title of the audio file, to be displayed. Do not use quote marks around song titles.
• alt: alt text for the image displayed for the file, for visually impaired readers; see Wikipedia:Alternative text for images. This is needed for file formats such as Ogg's .ogv format that include video as well as sound. The alt text should describe just the initial static image, not the entire video or its sound.
• description: a description of the audio file

Style parameters

The template also takes a number of style parameters to control its appearance:

• type: can be used to alter the image displayed at the left depending on the type of audio content being embedded. Acceptable values are music, speech and sound (default)
• header: can be used to add a header to the box.
• help: if set Template:Para, suppresses the help text that normally appears at the bottom of the box. Only do this if there are other audio files on the page which do have the help link; it must be provided on at least the first file on the article.
• pos: by default the box floats to the right side of the screen. Setting this to left will cause the box to instead float on the left-hand side.
• image: define a different image. Eg Template:Para. You can set Template:Para to disable the image entirely.
• style: can be used to pass specific style instructions to the box. Setting this to float:none will anchor the box when this is convenient. Setting this to float:none; clear:none will enable the anchored box to co-exist gracefully beside another floating box.
• play#: some media files cannot be displayed inline; if this is the case set Template:Para to prevent the broken inline link from displaying.
• plain: if set Template:Para, removes most of the ornamentation (table border, image, and help links) to give a minimalist version. This also removes the left/right float and positioning, to allow the box to be manually positioned as desired using the Template:Para (e.g., Template:Para) parameter and surrounding markup.

Examples

Basic example

{{Listen
| filename    = Accordion chords-01.ogg
| title       = Accordion chords
| description = Chords being played on an accordion
}}

Example with video

{{Listen
| header      = Inaugural Address
| filename    = Barack Obama inaugural address.ogv
| alt         = A black man in a black coat gestures and talks at a lecturn surrounded by teleprompters. Behind him, in the background, are about a dozen warmly-dressed onlookers.
| title       = Inaugural address of Barack Obama
| description = Barack Obama delivers his [[inaugural address]] on January 20, 2009.<br>(Duration: 21 minutes, 21 seconds)
| help        = no
| type        = sound
}}

Example with header

{{Listen
| filename    = Frase de Neil Armstrong.ogg
| title       = "One small step for a man..."
| description = First words spoken on the [[moon]].
| type        = speech
| pos         = left
| header      = Recordings of this phrase:
}}

Plain example

{{Listen
| filename = Accordion chords-01.ogg
| title    = Accordion chords
| plain    = yes
| style    = float:left
}}

Multiple files

{{Listen
| filename     = Accordion chords-01.ogg
| title        = Accordion chords
| description  = Chords being played on an accordion
| type         = music
| filename2    = Moonlight.ogg
| title2       = ''Moonlight Sonata''
| description2 = [[Beethoven]]'s "Sonata in C-sharp minor"
| filename3    = Au_clair_de_la_lune_mode_do.mid
| title3       = Au Clair de la Lune
| description3 = The traditional French children's song
| play3        = no
}}

Microformat

The HTML mark up produced by this template includes an hAudio microformat, which makes the recording's details parsable by computers, either acting automatically to catalogue articles across Wikipedia, or via a browser tool operated by a person, to (for example) add the subject to a playlist or database. For more information about the use of microformats on Wikipedia, please see the microformat project.

Sub-templates

Date-of-publication ("published") information will only be included in the microformat if Template:Tlx (or Template:Tlx where appropriate) is used in a parent template or infobox (but do not use these if the date is before 1583 CE).

For the length or duration of a recording, say 3 minutes 45 seconds, use {{Duration}} thus: {{Duration|m=3|s=45}}, which renders as Template:Error. An optional h parameter can be used for hours.

Please do not remove instances of these sub-templates.

Classes

hAudio uses HTML classes including:

• haudio
• fn
• album
• description
• category
• contributor
• duration
• h
• item
• min
• photo
• position
• price
• published
• s

Please do not rename or remove these classes; nor collapse nested elements which use them.

See also

• {{Audio}}, a variant of this template meant more for inline sounds like pronunciations.
• {{Multi-listen start}}, {{Multi-listen item}}, and {{Multi-listen end}}, templates used to list multiple audio files in the same box
• {{Listen MIDI}}, for MIDI files.