Template:Audio sample/doc

Audio sample
File:Wikipedia.ogg file help

Once an audio sample has been uploaded to Wikipedia (see the WP:SAMPLE guideline for information and links), use this template to add an audio sample link to an infobox; to add samples to the main body of an article, use {{Listen}}.

Code

This template is used with the |misc= parameter of the infobox template. It should not be used on its own. If this template is substituted, it will return a cleaned-up copy of itself with unnecessary parameters removed and deprecated parameters replaced. Parameter indentation will also automatically be fixed. <syntaxhighlight lang="wikitext" style="overflow:auto;">{{Infobox song ... | misc = {{subst:Audio sample

| type        = 
| header      = 
| file        = 
| description =
}}

</syntaxhighlight>

Parameters

type

Enter single to produce a khaki header or song for light blue for other Infobox song types, so that the headers will have a consistent color. Other header colors are shown at {{Infobox album/color}}.

header

If this parameter is left blank, Audio sample (the default setting) will be generated. A custom header may be created by entering text in this field. For no header, enter |header=no. For multiple audio samples, set the first to |header=Audio samples and the succeeding links to |header=no, so only one header for all will be created (see Example with multiple samples).

file

Enter the name of the audio file. The param will work with or without the preceding File:.

description

Since the infobox already provides the name of the song, artist, dates, etc., an additional description is usually not necessary. However, "First verse", "Chorus", etc., may be added to identify a specific sample. Generally, commentary about the composition, techniques used, etc., should be included in the main body of the article and not in the infobox.

Example with multiple samples

<syntaxhighlight lang="wikitext" style="overflow:auto;">{{Infobox song ... | misc = {{subst:Audio sample

| type        = song
| header      = Audio samples
| file        = Silent Night (choral).ogg
| description = Choral version
}}{{subst:Audio sample
| type        = song
| header      = no
| file        = Gruber - Schumann-Heink - Stille Nacht.ogg
| description = Soprano solo version
}}

</syntaxhighlight>

Microformat

The HTML mark-up produced by this template includes an hAudio microformat that makes an audio recording's details readily parsable 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 visit the 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.

Classes used

The HTML classes of this microformat include:

• haudio
• fn
• album
• description
• category
• contributor
• duration
• h
• item
• min
• photo
• position
• price
• published
• s

Please do not rename or remove these classes
nor collapse nested elements which use them.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Audio sample in articles based on its TemplateData.

TemplateData for Audio sample

<templatedata> { "params": { "type": { "label": "Type", "description": "Type of recording (this changes the colour of the header), such as single for khaki or song for light blue. For album types, see Template:Infobox album/color", "example": "song, single", "type": "string", "suggested": true, "required": true }, "header": { "label": "Header", "description": "Change the header text. If value is \"none\", then the header will not be displayed.", "example": "none", "type": "string" }, "file": { "label": "File", "description": "Audio file to be shown.", "example": "Example.ogg", "type": "wiki-file-name", "required": true, "suggested": true }, "description": { "label": "Description", "description": "Description of the audio file", "example": "\"O Kazakhstan\" (instrumental)", "type": "string" } }, "description": "Adds an audio sample for album and song infoboxes. Use in the \"misc\" parameter of those templates.", "paramOrder": [ "type", "header", "file", "description" ], "format": "block" } </templatedata>