Template:Media/doc

This template is a typing aid that adds multimedia icons to any page. It is intended to identify which works have multimedia elements attached to them (such as audio files, spoken word versions, film clips and music). The template has two uses, both to create the icons and to provide a key for those icons.

Usage
If no parameters are set, the template will display the default "speaker" icon as used with audio files and spoken word versions of texts.

This template has two fuctions: Icon or Key.

Icon only
Icon only is the default setting of this template. Size can be adjusted (in pixels). Default size is 20px in the Author: namespace and 15px in the Main namespace. To adjust the size, use the number of pixels with no named parameter.

can be used to display multiple icons. This overrides the.

Key text
By setting the parameter to yes, the template will display text to explain the icon. This will override the creation of icons. When using this fuction, the template should be placed in the appropriate page header.

The key will automatically include an opening line break, which is often but not always useful for displaying correctly. This line break can be deactivated by setting the parameter to yes.

The text of the key depends on the namespace combined with the and  parameters.

In the Author and Wikisource namespaces, this template inserts one of the following icons and text:

In the main namespace (and any other namespace not mentioned), this template instead inserts one of the following icons and text:

The parameter can override the use of the word "chapters" in the text. This can be used in situations where the work is subdivided in a different manner. Possibilities include "parts" or "sections."

Note #1: When used as a key, this template adds Category:Spoken works (audio), Category:Works with music (music, score) or Category:Works with videos (video). To omit addition of the Category add the code

Icon
On author pages, place the icon after the name of the text that has multimedia elements.

If a single chapter or other subsection of a work has multimedia elements, this template can be placed on the contents page of the work to indicate which contain the multimedia element(s). In these cases, place the icon after the name of the chapter or subsection (in this situation, the size should be 15px.)

Key
The key should be placed in the page header. This appropriate place depends on the namespace:

Multimedia
This template displays icons for four types of media, as shown in this table. Any one of the keywords can be used with to set the appropriate icon. To set more than one icon, set to "true" and set any of, ,  and  to "true" to display the icons.

Speaker & Spoken
The previous version of this template was Speaker, which originally displayed only the speaker icon. Speaker is still in use and can still be used, as it redirects to this template.

The template Spoken, which originally provided a key for the speaker icon, has also been merged into this template. Spoken is still in use and can still be used, as it redirects to this template.

Related templates

 * Listen – to add audio files to a text
 * Watch – to add video files to a text