Jump to content

Template:Audio sample/doc

From Wikipedia, the free encyclopedia

This is an old revision of this page, as edited by Jc86035 (talk | contribs) at 08:05, 20 May 2017 (cats, microforma). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

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

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 of this microformat 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

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Audio sample in articles based on its TemplateData.

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