Template:Audio sample/doc

From Wikipedia, the free encyclopedia
Jump to: navigation, search
Audio sample

Usage[edit]

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[edit]

{{subst:Audio sample
 | type        = 
 | header      = 
 | file        = 
 | description =
}}

Parameters[edit]

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[edit]

The HTML mark-up produced by this template includes an hAudio microformat that makes an audio recording's details readily parsable by computer programs. This aids tasks such as the cataloguing of articles and maintenance of databases. For more information about the use of microformats on Wikipedia, please visit the Microformat WikiProject.

Subtemplates

Date-of-publication ("published") information will only be included in the microformat if {{start date}} (or, where appropriate, {{start date and age}}) is used in a parent infobox/template. Do not, however, use {{start date}} or {{start date and age}} if a date before 1583 CE is involved.

Use {{duration}} to specify the duration/length of a recording. For instance, if the recording's duration is 3 minutes 45 seconds, use {{duration|m=3|s=45}} (which appears as: 3:45). If needed, |h= may be included to specify a number of hours.

Please do not remove instances of these subtemplates.

Classes used

The HTML classes this microformat uses include:

  • haudio
  • fn
  • album
  • description
  • category
  • contributor
  • duration
  • h
  • item
  • min
  • photo
  • position
  • price
  • published
  • s
Please do not rename or remove these classes
nor collapse nested elements which use them.

TemplateData[edit]

This is the TemplateData documentation for this template used by VisualEditor and other tools.

See the monthly error 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 has custom formatting.

Parameter Description Type Status
Type type

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]]

Default
empty
Example
song, single
Auto value
empty
String required
Header header

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

Default
empty
Example
none
Auto value
empty
String optional
File file

Audio file to be shown.

Default
empty
Example
Example.ogg
Auto value
empty
File required
Description description

Description of the audio file

Default
empty
Example
"O Kazakhstan" (instrumental)
Auto value
empty
String optional