Difference between revisions of "Template:Audio sample/doc"
(use a free file) |
imported>Ojorojo (updated with new parameter, etc.) |
||
| Line 2: | Line 2: | ||
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. --> | <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. --> | ||
| − | + | Audio samples may be uploaded to as long as they comply with copyright law and Wikipedia guidelines (see [[WP:SAMPLE]]). Use this template to add an audio sample link to an infobox created by {{tl|Infobox song}}. | |
| + | |||
== Usage == | == Usage == | ||
| + | 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. | ||
| − | + | === Code === | |
| − | + | {{infobox|data1={{parameter names example||type=song|file=Wikipedia.ogg}}}} | |
| − | === | + | <pre style="overflow:auto;">{{Infobox song |
| − | + | ... | |
| − | <pre> | + | | misc = {{subst:Audio sample |
| − | {{subst:Audio sample | ||
| type = | | type = | ||
| header = | | header = | ||
| file = | | file = | ||
| description = | | description = | ||
| − | }} | + | }} |
</pre> | </pre> | ||
| − | + | ; type : Enter the same type specified in the {{tl|Infobox song}} parameter {{para|type}}. If not used or set to {{para|type|single}}, a header with a khaki background color is created. Set to {{para|type|song}} to generate a light blue background. | |
| − | {| | + | ; header : Enter the text for the header. If not used, the default is <code>Audio sample</code>. For no header, enter {{para|header|no}}. For audio samples links, 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). |
| − | + | ; 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, "Live version", "2010 remix", etc., may be added if needed. |
| − | | type || | + | |
| − | + | ==Example== | |
| − | | header | | + | <pre 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 | ||
| + | }} | ||
| + | </pre> | ||
== Microformat == | == Microformat == | ||
Revision as of 15:40, 15 July 2017
| 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. |
Audio samples may be uploaded to as long as they comply with copyright law and Wikipedia guidelines (see WP:SAMPLE). Use this template to add an audio sample link to an infobox created by {{Infobox song}}.
Contents
Usage
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.
Code
| Template:Parameter names example |
{{Infobox song
...
| misc = {{subst:Audio sample
| type =
| header =
| file =
| description =
}}
- type
- Enter the same type specified in the {{Infobox song}} parameter
|type=. If not used or set to|type=single, a header with a khaki background color is created. Set to|type=songto generate a light blue background. - header
- Enter the text for the header. If not used, the default is
Audio sample. For no header, enter|header=no. For audio samples links, set the first to|header=Audio samplesand the succeeding links to|header=no, so only one header for all will be created (see Example). - file
- Enter the name of the audio file, without the preceding
File:. For example for File:Silent Night (choral).ogg, enterSilent 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, "Live version", "2010 remix", etc., may be added if needed.
Example
{{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 |