View source for Template:Audio sample/doc

{{Documentation subpage}}
{{High-use}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{infobox|data1={{parameter names example||type=song|file=Wikipedia.ogg}}}}

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 {{tl|Listen}}.

== Code ==
This template is used with the {{para|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      = <!-- leave blank for "Audio sample" -->
 | file        = 
 | description =
 }}
</syntaxhighlight>

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

===header===
If this parameter is left blank, <code>Audio sample</code> (the default setting) will be generated. A custom header may be created by entering text in this field.  For no header, enter {{para|header|no}}. For multiple audio samples, set the first to {{para|header|Audio samples}} and the succeeding links to {{para|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 <code>File:</code>.

===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 ==
{{UF-audio}}

== TemplateData ==
{{TemplateDataHeader}}

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

<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Music infobox templates]]
[[Category:Audio templates]]
[[Category:Embeddable templates]]
}}</includeonly>