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

From blackwiki
Jump to navigation Jump to search
imported>Jc86035
m (cats, microforma)
imported>Ojorojo
(clarified, music audio samples are usually limited to songs and singles)
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. -->
  
 +
{{infobox|data1={{parameter names example||type=song|file=americaog.ogg}}}}
 
== Usage ==
 
== Usage ==
  
Line 21: Line 22:
 
! Parameter !! Description
 
! Parameter !! Description
 
|-
 
|-
| type || Specifies the background color of the caption from {{tl|Infobox album/color}}. See that template's page for all values.
+
| type || Specify <code>single</code>, <code>song</code>, or a code from {{tl|Infobox album/doc/type}} – this sets the header color.
 
|-
 
|-
| header || Changes the header text; default is "Audio sample". Hide the header by specifying value <code>none</code>.
+
| header || "Audio sample" is the default header. A custom header may be added or to hide it altogether, specify <code>none</code>.
 
|-
 
|-
 
| file || Name of the audio file. For example, for [[:File:americaog.ogg]], specify <code>americaog.ogg</code>.
 
| 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.
+
| description || Since the infobox already provides the name of the song, artist, dates, etc., an additional description is usually not necessary.
 
|}
 
|}
  
Line 41: Line 42:
 
"type": {
 
"type": {
 
"label": "Type",
 
"label": "Type",
"description": "Type of recording (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), such as single for khaki or song for light blue. For album types, see [[Template:Infobox album/color]]",
"example": "song",
+
"example": "song, single",
 
"type": "string",
 
"type": "string",
 
"suggested": true,
 
"suggested": true,

Revision as of 15:01, 5 June 2017

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

Template:UF-audio

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), such as single for khaki or song for light blue. For album types, see [[Template:Infobox album/color]]

Example
song, single
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