Difference between revisions of "Template:Audio sample/doc"
Jump to navigation
Jump to search
imported>Jc86035 (upd) |
imported>Jc86035 m (+) |
||
| Line 4: | Line 4: | ||
== Usage == | == Usage == | ||
| − | If this template is substituted, it will return a cleaned-up copy of itself with unnecessary parameters removed and deprecated parameters replaced. | + | 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 === | === Syntax === | ||
Revision as of 06:29, 19 May 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. |
Contents
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 | Specifies the background color of the caption from {{Infobox album/color}}. See that template's page for all values. |
| header | Changes the header text; default is "Audio sample". Hide the header by specifying value none.
|
| file | Name of the audio file. For example, for File:americaog.ogg, specify americaog.ogg.
|
| description | Description of the audio file. Usually not necessary. |
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). See [[Template:Infobox album/color]] for all values
| 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 |