Difference between revisions of "Template:Audio sample/doc"
imported>Jc86035 m (→Usage) |
imported>Zyxw m (keep /sandbox out of categories) |
||
| (14 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
| − | <!-- | + | <!-- 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. | ||
| + | <pre style="overflow:auto;">{{Infobox song | ||
| + | ... | ||
| + | | misc = {{subst:Audio sample | ||
| + | | type = | ||
| + | | header = <!-- leave blank for "Audio sample" --> | ||
| + | | file = | ||
| + | | description = | ||
| + | }} | ||
| + | </pre> | ||
| + | |||
| + | ==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, without the preceding <code>File:</code>. For example for [[:File:Silent Night (choral).ogg]], enter <code>Silent Night (choral).ogg</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. | ||
| − | <pre> | + | ==Example with multiple samples== |
| − | {{ | + | <pre style="overflow:auto;">{{Infobox song |
| − | | file | + | ... |
| − | | header = | + | | 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 | ||
| + | }} | ||
</pre> | </pre> | ||
| − | == | + | == Microformat == |
| − | { | + | {{UF-audio}} |
| − | + | ||
| − | + | == TemplateData == | |
| − | + | {{TemplateDataHeader}} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<templatedata> | <templatedata> | ||
{ | { | ||
"params": { | "params": { | ||
"type": { | "type": { | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
"label": "Type", | "label": "Type", | ||
| − | "description": "Type of recording | + | "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", | + | "example": "song, single", |
"type": "string", | "type": "string", | ||
| − | "suggested": true | + | "suggested": true, |
| + | "required": true | ||
}, | }, | ||
"header": { | "header": { | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
"label": "Header", | "label": "Header", | ||
| − | "description": " | + | "description": "Change the header text. If value is \"none\", then the header will not be displayed.", |
| − | "example": " | + | "example": "none", |
| − | "type": " | + | "type": "string" |
}, | }, | ||
"file": { | "file": { | ||
| − | |||
| − | |||
| − | |||
"label": "File", | "label": "File", | ||
"description": "Audio file to be shown.", | "description": "Audio file to be shown.", | ||
| Line 62: | Line 76: | ||
"required": true, | "required": true, | ||
"suggested": 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.", | "description": "Adds an audio sample for album and song infoboxes. Use in the \"misc\" parameter of those templates.", | ||
"paramOrder": [ | "paramOrder": [ | ||
| + | "type", | ||
| + | "header", | ||
"file", | "file", | ||
| − | " | + | "description" |
| − | + | ], | |
| − | + | "format": "block" | |
} | } | ||
</templatedata> | </templatedata> | ||
| − | <includeonly> | + | <includeonly>{{sandbox other|| |
| − | <!-- | + | <!-- Categories below this line, please; interwikis at Wikidata --> |
[[Category:Exclude in print]] | [[Category:Exclude in print]] | ||
| − | [[Category:Music infobox templates | + | [[Category:Music infobox templates]] |
| + | [[Category:Audio templates]] | ||
[[Category:Embeddable templates]] | [[Category:Embeddable templates]] | ||
| − | </includeonly> | + | }}</includeonly> |
Latest revision as of 17:51, 10 March 2020
| This is a documentation subpage for Template:Audio sample. It contains usage information, categories and other content that is not part of the original template page. |
| Template:Parameter names example |
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}}.
Contents
Code
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
type
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
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
Enter the name of the audio file, without the preceding File:. For example for File:Silent Night (choral).ogg, enter Silent Night (choral).ogg.
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
{{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
TemplateData
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 |