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

From blackwiki
Jump to navigation Jump to search
imported>Jc86035
m (fmt)
imported>X201
Line 26: Line 26:
  
 
=== TemplateData ===
 
=== TemplateData ===
 +
{{TemplateDataHeader}}
 +
 
<templatedata>
 
<templatedata>
 
{
 
{

Revision as of 15:17, 11 May 2017

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.

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
Filefile Audio file

Audio file to be shown.

Example
Example.ogg
Filerequired
Headerheader caption upper_caption Upper caption

Toggles header reading "Audio sample".

Example
yes
Booleanoptional
Typetype Type background Background

Type of recording; defaults to "single" (this changes the colour of the header). See «Template:Infobox album/color» for all values

Example
song
Stringsuggested