Template:Listen image/doc

Usage
undefined allows audio files to be embedded in articles with an associated image. It should be used for audio files and their accompanying visual representations that are set off from the text. It is just like Listen, except that it displays an image above the media player (but in the same box). This gives a much more pleasing visual result than placing a Listen below an image.

For non-free, fair-use media samples, a description of the media is required to provide contextual significance, and thus satisfy item No. 8 of the Policy section of Non-free content criteria. Do not position non-free audio or video files in the infobox.

Basic usage
The audio part of this template is almost exactly the same as Listen. This way, you can convert a Listen to a Listen image by—at the bare minimum—adding the word "image" to the template name and adding the main_image parameter. 


 * main_image (Required): the pagename of the image to display with the audio file, the   (formerly  ) prefix
 * main_image_caption: the caption for the main image
 * main_image_alt : the alt text for the main image, for visually impaired readers; see Alternative text for images. This is needed for file formats such as Ogg's  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.
 * 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 audio file. For non-free, fair-use audio, this must include a textual description of what is heard in the sample.

Extended usage
Additional audio files can be embedded in an article with one template by appending a number to each parameter. The maximum number of audio files embedded in this way is ten.




 * main_title: the title to display, emphasized, at the top of the template. This title applies to the template as a whole.
 * main_image (Required): the pagename of the image to display with the audio file, the   (formerly  ) prefix
 * main_image_upright: the upright factor, used to scale the main image from its default size.  is the default thumbnail size,   is twice the default thumbnail size, etc. In general, using this parameter should not be necessary, as the image should be appropriately sized for the media player already. See Manual of Style/Images for more details. (default value:  )
 * main_image_size: the image size. In general, using this parameter should not be necessary, as the image should be appropriately sized for the media player already. main_image_upright is generally preferred to this parameter.
 * main_image_caption: the caption for the main image
 * 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 media file, if applicable, for visually impaired readers.
 * 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 of the audio section 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 audio content section.
 * help: if set to no, suppresses the help text that normally appears at the bottom of the audio content section. 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.
 * image: define a different image to show to the left of the media player. E.g. Example.jps. You can set none to disable the image entirely.
 * start: Timestamp at which the file should start playing.
 * style: can be used to pass specific style instructions to the audio content section.
 * embed: use yes to remove the loudspeaker icon image and padding around the audio content section.
 * play: 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 (image and help links) from the audio content section 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.

Note: Due to technical limitations, the pos attribute, which allows you to set the horizontal float of the template in Listen, is not implemented here. This template always floats right.

Examples
Basic



Extended



Multiple files



No listen icon

