 | This is the template sandbox page for Template:Audio sample (diff). See also the companion subpage for test cases. |
 | This template is used on approximately 3,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.
Preview message: Transclusion count updated automatically (see documentation). |
| Audio sample | |
|---|---|
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
[edit]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.
{{Infobox song
...
| misc = {{subst:Audio sample
| type =
| header = <!-- leave blank for "Audio sample" -->
| file =
| description =
}}
Parameters
[edit]type
[edit]Enter single to produce a khaki header or song 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
[edit]If this parameter is left blank, Audio sample (the default setting) will be generated. A custom header may be created by entering text in this field. For no header, enter |header=no. For multiple audio samples, set the first to |header=Audio samples and the succeeding links to |header=no, so only one header for all will be created (see Example with multiple samples).
file
[edit]Enter the name of the audio file. The param will work with or without the preceding File:.
description
[edit]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
[edit]{{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
}}
Microformat
[edit]- Subtemplates
Date-of-publication ("published") information will only be included in the microformat if {{start date}} (or, where appropriate, {{start date and age}}) is used in a parent infobox/template. Do not, however, use {{start date}} or {{start date and age}} if a date before 1583 CE is involved.
Use {{duration}} to specify the duration/length of a recording. For instance, if the recording's duration is 3 minutes 45 seconds, use {{duration|m=3|s=45}} (which appears as: 3:45). If needed, |h= may be included to specify a number of hours.
Please do not remove instances of these subtemplates.
- Classes used
The HTML classes of this microformat include:
- haudio
- fn
- album
- description
- category
- contributor
- duration
- h
- item
- min
- photo
- position
- price
- published
- s
nor collapse nested elements which use them.
TemplateData
[edit]TemplateData for Audio sample
Adds an audio sample for album and song infoboxes. Use in the "misc" parameter of those templates.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Type | type | 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]]
| String | required |
| Header | header | Change the header text. If value is "none", then the header will not be displayed.
| String | optional |
| File | file | Audio file to be shown.
| File | required |
| Description | description | Description of the audio file
| String | optional |