Template:Audio sample/doc

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.

type
Enter  to produce a khaki header or   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,  (the default setting) will be generated. A custom header may be created by entering text in this field. For no header, enter no. For multiple audio samples, set the first to Audio samples and the succeeding links to 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.

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.

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" }