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

From blackwiki
Jump to navigation Jump to search
imported>Jc86035
m (+)
imported>Jc86035
m (cats, microforma)
Line 10: Line 10:
 
<pre>
 
<pre>
 
{{subst:Audio sample
 
{{subst:Audio sample
| type        =  
+
| type        =  
| header      =  
+
| header      =  
| file        =  
+
| file        =  
| description =
+
| description =
 
}}
 
}}
 
</pre>
 
</pre>
Line 30: Line 30:
 
|}
 
|}
  
=== TemplateData ===
+
== Microformat ==
 +
{{UF-audio}}
 +
 
 +
== TemplateData ==
 
{{TemplateDataHeader}}
 
{{TemplateDataHeader}}
  
Line 79: Line 82:
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. -->
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. -->
 
[[Category:Exclude in print]]
 
[[Category:Exclude in print]]
[[Category:Music infobox templates|Audiosample]]
+
[[Category:Music infobox templates]]
 +
[[Category:Audio templates]]
 
[[Category:Embeddable templates]]
 
[[Category:Embeddable templates]]
 
</includeonly>
 
</includeonly>

Revision as of 08:05, 20 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. 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.

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). 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