Template:Audio sample/doc

This is a documentation subpage for Template:Audio sample.
It may contain usage information, categories and other content that is not part of the original template page.

Usage

Syntax

{{Audiosample
| file    = 
| header  = 
| type    = 
}}

Parameters

Parameter	Description
file	Name of the audio file. For example, for File:americaog.ogg, specify `americaog.ogg`
header	Putting anything in this parameter adds an infobox header reading "Audio sample".
type	Specifies the background color of the caption from {{Infobox album/color}}; defaults to `single`. See that template's page for all values.

TemplateData

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
File	`file` `Audio file`	Audio file to be shown. Example Example.ogg	File	required
Header	`header` `caption` `upper_caption` `Upper caption`	Toggles header reading "Audio sample". Example yes	Boolean	optional
Type	`type` `Type` `background` `Background`	Type of recording; defaults to "single" (this changes the colour of the header). See «Template:Infobox album/color» for all values Example song	String	suggested