Template:Listen
Jump to navigation
Jump to search
This template uses Module:Listen, a script written in the Lua programming language. Please see Wikipedia:Lua if you want to learn more about Lua or help convert other templates. |
{{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, 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:
- 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. Eg
|image=[[File:Example.jps|20px]]
. 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).
Examples
Basic
{{Listen | filename = Lament of the Highborne.ogg | title = Lament of the Highborne | description = A lament sung by Sylvanas Windrunner }}
With header
{{Listen | filename = Lament of the Highborne.ogg | title = Lament of the Highborne | description = A lament sung by Sylvanas Windrunner | header = The song }}
Plain
{{Listen | filename = Lament of the Highborne.ogg | title = Lament of the Highborne | plain = yes | style = float:left }}
Multiple files
{{Listen | filename = Lament of the Highborne.ogg | title = Lament of the Highborne | description = A lament sung by Sylvanas Windrunner | filename2 = Faerie Dragon.ogg | title2 = ''Faerie Dragon'' | description2 = The Fey-Drunk Darter event }}
Categories:
- Lua-based templates
- Listen template using plain parameter