Difference between revisions of "Template:Audio sample/doc"
Jump to navigation
Jump to search
imported>Jc86035 m (updated) |
imported>Jc86035 (TemplateData) |
||
| Line 31: | Line 31: | ||
[[Category:Embeddable templates]] | [[Category:Embeddable templates]] | ||
</includeonly> | </includeonly> | ||
| + | <templatedata> | ||
| + | { | ||
| + | "params": { | ||
| + | "type": { | ||
| + | "aliases": [ | ||
| + | "Type", | ||
| + | "background", | ||
| + | "Background" | ||
| + | ], | ||
| + | "label": "Type", | ||
| + | "description": "Type of recording; defaults to \"single\" (this changes the colour of the header). See «Template:Infobox album/color» for all values", | ||
| + | "example": "song", | ||
| + | "type": "string", | ||
| + | "suggested": true | ||
| + | }, | ||
| + | "header": { | ||
| + | "aliases": [ | ||
| + | "caption", | ||
| + | "upper_caption", | ||
| + | "Upper caption" | ||
| + | ], | ||
| + | "label": "Header", | ||
| + | "description": "Toggles header reading \"Audio sample\".", | ||
| + | "example": "yes", | ||
| + | "type": "boolean" | ||
| + | }, | ||
| + | "file": { | ||
| + | "aliases": [ | ||
| + | "Audio file" | ||
| + | ], | ||
| + | "label": "File", | ||
| + | "description": "Audio file to be shown.", | ||
| + | "example": "Example.ogg", | ||
| + | "type": "wiki-file-name", | ||
| + | "required": true, | ||
| + | "suggested": true | ||
| + | } | ||
| + | }, | ||
| + | "description": "Adds an audio sample for album and song infoboxes. Use in the \"misc\" parameter of those templates.", | ||
| + | "paramOrder": [ | ||
| + | "file", | ||
| + | "header", | ||
| + | "type" | ||
| + | ] | ||
| + | } | ||
| + | </templatedata> | ||
Revision as of 11:04, 10 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. |
Usage
Syntax
{{Audiosample
| file =
| header =
| type =
}}
Parameters
| Parameter | Description |
|---|---|
| file | Name of the audio file. For example, for File:americaog.ogg, specify americaog.ogg
|
| header | Putting anything in this parameter adds an infobox header reading "Audio sample". |
| type | Specifies the background color of the caption from {{Infobox album/color}}; defaults to single. See that template's page for all values.
|
Adds an audio sample for album and song infoboxes. Use in the "misc" parameter of those templates.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| File | file Audio file | Audio file to be shown.
| File | required |
| Header | header caption upper_caption Upper caption | Toggles header reading "Audio sample".
| Boolean | optional |
| Type | type Type background Background | Type of recording; defaults to "single" (this changes the colour of the header). See «Template:Infobox album/color» for all values
| String | suggested |