Difference between revisions of "Template:Audio sample/doc"

From blackwiki
Jump to navigation Jump to search
imported>Jc86035
imported>Jc86035
(upd)
Line 3: Line 3:
  
 
== Usage ==
 
== Usage ==
 +
 +
If this template is substituted, it will return a cleaned-up copy of itself with unnecessary parameters removed and deprecated parameters replaced.
  
 
=== Syntax ===
 
=== Syntax ===
  
 
<pre>
 
<pre>
{{Audiosample
+
{{subst:Audio sample
| file    =  
+
| type        =  
| header =  
+
| header     =  
| type    =  
+
| file        =
 +
| description =
 
}}
 
}}
 
</pre>
 
</pre>
Line 18: Line 21:
 
! Parameter !! Description
 
! Parameter !! Description
 
|-
 
|-
| file || Name of the audio file. For example, for [[:File:americaog.ogg]], specify <code>americaog.ogg</code>
+
| type || Specifies the background color of the caption from {{tl|Infobox album/color}}. See that template's page for all values.
 
|-
 
|-
| header || Putting anything in this parameter adds an infobox header reading "Audio sample".
+
| header || Changes the header text; default is "Audio sample". Hide the header by specifying value <code>none</code>.
 
|-
 
|-
| type || Specifies the background color of the caption from {{tl|Infobox album/color}}; defaults to <code>single</code>. See that template's page for all values.
+
| file || Name of the audio file. For example, for [[:File:americaog.ogg]], specify <code>americaog.ogg</code>.
 +
|-
 +
| description || Description of the audio file. Usually not necessary.
 
|}
 
|}
  
Line 32: Line 37:
 
"params": {
 
"params": {
 
"type": {
 
"type": {
"aliases": [
 
"Type",
 
"background",
 
"Background"
 
],
 
 
"label": "Type",
 
"label": "Type",
"description": "Type of recording; defaults to \"single\" (this changes the colour of the header). See «Template:Infobox album/color» for all values",
+
"description": "Type of recording (this changes the colour of the header). See [[Template:Infobox album/color]] for all values",
 
"example": "song",
 
"example": "song",
 
"type": "string",
 
"type": "string",
"suggested": true
+
"suggested": true,
 +
"required": true
 
},
 
},
 
"header": {
 
"header": {
"aliases": [
 
"caption",
 
"upper_caption",
 
"Upper caption"
 
],
 
 
"label": "Header",
 
"label": "Header",
"description": "Toggles header reading \"Audio sample\".",
+
"description": "Change the header text. If value is \"none\", then the header will not be displayed.",
"example": "yes",
+
"example": "none",
"type": "boolean"
+
"type": "string"
 
},
 
},
 
"file": {
 
"file": {
"aliases": [
 
"Audio file"
 
],
 
 
"label": "File",
 
"label": "File",
 
"description": "Audio file to be shown.",
 
"description": "Audio file to be shown.",
Line 64: Line 57:
 
"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",
"header",
+
"description"
"type"
 
 
],
 
],
 
"format": "block"
 
"format": "block"

Revision as of 11:27, 18 May 2017

Usage

If this template is substituted, it will return a cleaned-up copy of itself with unnecessary parameters removed and deprecated parameters replaced.

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.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Typetype

Type of recording (this changes the colour of the header). See [[Template:Infobox album/color]] for all values

Example
song
Stringrequired
Headerheader

Change the header text. If value is "none", then the header will not be displayed.

Example
none
Stringoptional
Filefile

Audio file to be shown.

Example
Example.ogg
Filerequired
Descriptiondescription

Description of the audio file

Example
"O Kazakhstan" (instrumental)
Stringoptional