{{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 theFile: (formerlyImage:) 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 sounds being heard
pos: right (default), left, or center
Multiple files
Additional files can be embedded in an article with one template by appending a number to each parameter.
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; seeWikipedia:Alternative text for images. This is needed for file formats 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 sounds being heard
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 aremusic,speech andsound (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 whichdo have the help link; itmust be provided onat least the first file on the article.
pos: by default the box floats to the right side of the screen. Setting this toleft orcenter will float the box on the left-hand side, or center it, respectively.
image: define a different image. E.g.|image=[[File:Example.jpg|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 tofloat:none will anchor the box when this is convenient. Setting this tofloat:none; clear:none will enable the anchored box to co-exist gracefully beside another floating box.
play(n): 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(n): Timestamp at which the file should start playing
length(n): setting|length(n)=hide hides the duration (h:m:s).
{{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)}}
{{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]].}}
{{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
TheHTML mark-up produced by this template includes anhAudio microformat that makes an audio recording's details readilyparsable 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 visitthe 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.
Text or other content to go above all the files in the template (but within the template boundary). Allows markup.
Content
optional
Music or speech icon
type
Enter "music" or "speech" here to change the template icon to a speaker with music notes or a microphone.
Suggested values
soundmusicspeech
Default
sound
Example
music
Line
optional
Custom icon
image
Custom image to replace the speaker icon in the template. Alternatively, enter "none" here to hide the icon entirely.
Example
[[File:Example.jpg|50px]], none
File
optional
Filename
filename
The filename of the file. Filename2, filename3, etc. can be used for subsequent files.
File
required
Title
title
The title to display for the file. Title2, title3, etc. can be used for subsequent files.
String
required
Description
description
A description of the file. Description2, description3, etc. can be used for subsequent files.
String
suggested
Start time
start
Timestamp at which the first file should start playing (start2, start3, etc. can be used for subsequent files)
Example
0:20
Line
optional
Hide duration?
length
Enter "hide" here to hide the duration of the first file (length2, length3, etc. can be used for subsequent files).
Example
hide
Line
optional
Hide player?
play
Enter "no" here to hide the file player for the first file (play2, play3, etc. can be used for subsequent files). To be used for some media files that cannot be displayed inline, to prevent a broken inline link from showing.
Example
no
Line
optional
Hide help text?
help
Enter "no" here to hide the "Problems playing this file? See media help." text at the bottom of the template. Must not be done on the first instance of the template; optional on subsequent instances of the template.
Example
no
Line
optional
Position
pos
Enter "left" or "center" here to change the default position of the template from on the right.
Suggested values
leftcenterright
Default
right
Example
left
Line
optional
Plain style?
plain
Enter "yes" here to remove most of the ornamentation (border, background, icon and help text) and the float/positioning of the template to give a minimalist version, allowing the user to use the custom CSS ("style") parameter to style and position the template.
Example
yes
Line
optional
Optimise for embedding?
embed
Enter any text here to remove the left, right and bottom border, the background, the icon, the help text and the padding of the template for use in an infobox.
