Template:Listen/doc

undefined 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

 * filename (Required): the pagename of the media file, the   (formerly  ) 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; see 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 are music, speech and sound (default)
 * header: can be used to add a header to the box.
 * help: if set to 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 or center will float the box on the left-hand side, or center it, respectively.
 * image: define a different image. E.g. Example.jpg. You can set 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(n): some media files cannot be displayed inline; if this is the case set no to prevent the broken inline link from displaying.
 * plain: if set 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., float:right) parameter and surrounding markup.
 * embed: use 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 hide hides the duration (h:m:s).

TemplateData
{	"description": "Allows audio and video files to be embedded in articles.", "format": "\n", "params": { "header": { "label": "Header", "description": "Text or other content to go above all the files in the template (but within the template boundary). Allows markup.", "type": "content" },		"type": { "label": "Music or speech icon", "description": "Enter \"music\" or \"speech\" here to change the template icon to a speaker with music notes or a microphone.", "type": "line", "example": "music", "default": "sound", "suggestedvalues": [ "sound", "music", "speech" ]		},		"image": { "label": "Custom icon", "description": "Custom image to replace the speaker icon in the template. Alternatively, enter \"none\" here to hide the icon entirely.", "type": "wiki-file-name", "example": ", none" },		"filename": { "label": "Filename", "description": "The filename of the file. Filename2, filename3, etc. can be used for subsequent files.", "type": "wiki-file-name", "required": true },		"title": { "label": "Title", "description": "The title to display for the file. Title2, title3, etc. can be used for subsequent files.", "type": "string", "required": true },		"description": { "label": "Description", "description": "A description of the file. Description2, description3, etc. can be used for subsequent files.", "type": "string", "suggested": true },		"start": { "label": "Start time", "description": "Timestamp at which the first file should start playing (start2, start3, etc. can be used for subsequent files)", "type": "line", "example": "0:20" },		"length": { "label": "Hide duration?", "description": "Enter \"hide\" here to hide the duration of the first file (length2, length3, etc. can be used for subsequent files).", "type": "line", "example": "hide" },		"play": { "label": "Hide player?", "description": "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.", "type": "line", "example": "no" },		"help": { "label": "Hide help text?", "description": "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.", "type": "line", "example": "no" },		"pos": { "label": "Position", "description": "Enter \"left\" or \"center\" here to change the default position of the template from on the right.", "type": "line", "example": "left", "default": "right", "suggestedvalues": [ "left", "center", "right" ]		},		"plain": { "label": "Plain style?", "description": "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.", "type": "line", "example": "yes" },		"embed": { "label": "Optimise for embedding?", "description": "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.", "type": "line", "example": "y" },		"style": { "label": "Custom CSS", "description": "Custom CSS for the template", "type": "content", "example": "float:none; clear:none" }	},	"paramOrder": [ "header", "type", "image", "filename", "title", "description", "start", "length", "play", "help", "pos", "plain", "embed", "style" ] }