Template:Audio sample/doc

Usage

If this template is substituted, it will return a cleaned-up copy of itself with unnecessary parameters removed and deprecated parameters replaced.

Syntax

{{subst:Audio sample
| type        = 
| header      = 
| file        = 
| description =
}}

Parameters

Parameter	Description
type	Specifies the background color of the caption from {{Infobox album/color}}. See that template's page for all values.
header	Changes the header text; default is "Audio sample". Hide the header by specifying value none.
file	Name of the audio file. For example, for File:americaog.ogg, specify americaog.ogg.
description	Description of the audio file. Usually not necessary.

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

Adds an audio sample for album and song infoboxes. Use in the "misc" parameter of those templates.

Template parameters

This template prefers block formatting of parameters.

Parameter		Description	Type	Status
Type	type	Type of recording (this changes the colour of the header). See [[Template:Infobox album/color]] for all values Example song	String	required
Header	header	Change the header text. If value is "none", then the header will not be displayed. Example none	String	optional
File	file	Audio file to be shown. Example Example.ogg	File	required
Description	description	Description of the audio file Example "O Kazakhstan" (instrumental)	String	optional