Template:Listen/doc

{{Listen}} allows audio and video files to be embedded in articles. It should be used for audio files that are set off from the text, such as 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 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.

{{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.
• alt: alt text for the image displayed for the file, for visually impaired readers; see Starfleet: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 to |help=no, 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. E.g. |image=[[File:Example.jps|50px]]. You can set |image=none 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 |play=no to prevent the broken inline link from displaying.
• plain: if set |plain=yes, 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 |style= (e.g., |style=float:right) parameter and surrounding markup.
• embed: use |embed=yes to remove border and padding when using as a module embedded in another infobox (see examples below).
• start: Timestamp at which the file should start playing

Examples

Basic

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

With video

{{Listen
| image       = [[File:Crystal Project video camera.png|50px]]
| help        = no
| 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's [[First inauguration of Barack Obama|first inaugural address]], January 20, 2009<br />(Duration: 21 minutes, 21 seconds)
}}

With header

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

Embedding

Dr. Accordion
Occupation	Accordion player

{{Infobox person
| name = Dr. Accordion
| occupation = Accordion player
| module =
{{Listen
| filename = Accordion chords-01.ogg
| title    = Accordion chords
| embed    = yes
}}
}}

Plain

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

Multiple files

{{Listen
| type         = music
| filename     = Accordion chords-01.ogg
| title        = Accordion chords
| description  = Chords being played on an accordion
| filename2    = Moonlight.ogg
| title2       = ''Moonlight Sonata''
| description2 = [[Ludwig van Beethoven|Beethoven]]'s [[Piano Sonata No. 14 (Beethoven)|Sonata in C-sharp minor]]
| filename3    = Brahms-waltz15.ogg
| title3       = Waltz No. 15
| description3 = From [[Sixteen Waltzes, Op. 39 (Brahms)|Sixteen Waltzes, Op. 39]] by [[Johannes Brahms|Brahms]]
}}

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

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

See also

• {{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
• {{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

• Template:Listen/doc at Wikipedia, the free Terran-based encyclopedia that anyone can edit.