Template:Audio sample/doc
< Template:Audio sample
Jump to navigation
Jump to search
Revision as of 00:48, 6 June 2017 by imported>Marchjuly (Self revert to try and figure out why the non-free file is still shown as being used in this template.)
| 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 |
Usage
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.
Syntax
{{subst:Audio sample
| type =
| header =
| file =
| description =
}}
Parameters
| Parameter | Description |
|---|---|
| type | Specify single, song, or a code from {{Infobox album/doc/type}} – this sets the header color.
|
| header | "Audio sample" is the default header. A custom header may be added or to hide it altogether, specify none.
|
| file | Name of the audio file. For example, for File:americaog.ogg, specify americaog.ogg.
|
| description | Since the infobox already provides the name of the song, artist, dates, etc., an additional description is usually not necessary. |
Microformat
TemplateData
This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.
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 |