Template:Audio/doc: Difference between revisions

From Savez
Jump to navigation Jump to search
Template Audio>Paine Ellsworth
(High-use template)
 
m (1 revision imported)
 

Latest revision as of 00:36, 12 July 2023

Purpose

This template links to an audio file for quick listening. It is meant to be used inline with text, for pronunciations and the like. Please note that this just creates a link to the file and does not actually embed the file. If the file is Non-Free and only referenced via this template it is not in compliance with Wikipedia:Non-free content criteria § Policy #7.

Usage

Basic

{{Audio|name of sound file|text to use as link to soundfile|help=}}

Simple
'''Alabama''' ({{Audio|en-us-Alabama.ogg|pronunciation}}) is a state located in...
Alabama (Template:Error-small) is a state located in...
Help links

Setting |help=no disables the "help/info" links. If this is done the template {{inline audio}} must be shown on the page.

'''Alabama''' ({{Audio|en-us-Alabama.ogg|pronunciation of "Alabama"|help=no}})
Alabama (Template:Error-small)
Todo: add {{inline audio}} to this page.

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 in articles based on its TemplateData.

TemplateData for Audio

Use this template to add an inline link to an audio file, preceded by a speaker icon.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Audio file1

Audio file to link to

Example
En-uk-London.ogg
Filerequired
Label2

Text to replace the filename in the link

Example
English pronunciation
Stringoptional
Show "(help·info)" links?help

Enter "no" here to remove the "(help·info)" links.

Example
no
Auto value
no
Lineoptional

See also