Template:Audio sample/doc - Revision history

Matt at 10:21, 14 April 2025

2025-04-14T10:21:42Z

← Older revision		Revision as of 06:21, 14 April 2025
Line 4:		Line 4:
	{{infobox\|data1={{parameter names example\|\|type=song\|file=Wikipedia.ogg}}}}		{{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}}~~.		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 .

	== Code ==		== Code ==

Matt at 21:28, 9 April 2025

2025-04-09T21:28:42Z

← Older revision		Revision as of 17:28, 9 April 2025
Line 1:		Line 1:
	{{wikipedia\|page name}}		{{wikipedia\|page name}}
	{{Documentation subpage}}		{{Documentation subpage}}
	~~{{High-use}}~~
	<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->		<!-- 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}}}}		{{infobox\|data1={{parameter names example\|\|type=song\|file=Wikipedia.ogg}}}}

Matt at 14:37, 8 April 2025

2025-04-08T14:37:06Z

← Older revision		Revision as of 10:37, 8 April 2025
Line 52:		Line 52:

	== TemplateData ==		== TemplateData ==
	~~{{TemplateDataHeader}}~~

	<templatedata>		<templatedata>

Matt at 16:10, 7 April 2025

2025-04-07T16:10:04Z

← Older revision		Revision as of 12:10, 7 April 2025
Line 5:		Line 5:
	{{infobox\|data1={{parameter names example\|\|type=song\|file=Wikipedia.ogg}}}}		{{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}}.		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 ==		== Code ==

Matt at 21:10, 5 March 2025

2025-03-05T21:10:23Z

← Older revision		Revision as of 17:10, 5 March 2025
Line 1:		Line 1:
			{{wikipedia\|page name}}
	{{Documentation subpage}}		{{Documentation subpage}}
	{{High-use}}		{{High-use}}

Matt: Protected "Template:Audio sample/doc": Initial wiki setup ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

2025-03-05T19:56:42Z

Protected "Template:Audio sample/doc": Initial wiki setup ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))

← Older revision	Revision as of 15:56, 5 March 2025
(No difference)

Matt: Created page with "{{Documentation subpage}} {{High-use}} {{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 {{..."

2025-03-05T18:42:12Z

Created page with "{{Documentation subpage}} {{High-use}}  {{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 {{..."

New page

{{Documentation subpage}}
{{High-use}}

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

[[Category:Music infobox templates]]
[[Category:Audio templates]]
[[Category:Embeddable templates]]
}}</includeonly>