Template:Audio/documentation

Usage

This template links to an audio file for quick listening, either in the "Pronunciation" section of an entry to indicate how a term is pronounced, or elsewhere to provide an audio recording that is relevant to the entry.

Parameters

The template takes the following parameters:

• |1= – mandatory: a code indicating the language of a term. See "Project:List of languages" for a list of these codes. The parameter |lang= is a deprecated synonym; please do not use. If this is used, all numbered parameters move down by one.
• |2= – mandatory: the name of the audio file.
• |3= – mandatory in some cases: the text to use as a link to the audio file. You must use this parameter when indicating the pronunciation of a term with this template.
• |format= – if using the template to provide a relevant audio recording, use |format=1.

Examples

To indicate the pronunciation of a term

• Wikitext: {{audio|en|en-uk-ubiquitous.ogg|Audio (RP)}}
• Result:

  Audio (RP)

  (file)

To link to a relevant audio recording

• Wikitext: {{audio|en|WWII submarine dive klaxon.ogg|A dive alert, or klaxon, aboard a {{wt|World War II}} {{w|United States Navy}} [[submarine#Noun|submarine]]|format=1}}
• Result:

  	(file)
  A dive alert, or klaxon, aboard a World War II United States Navy submarine

Visit klaxon to see how the template is used.

See also

• {{audio-IPA}} – a version of the template to be used with IPA transcriptions

TemplateData

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

TemplateData for Audio

An audio file to assist readers pronouncing the word. Labeled with language and possibly dialect.

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Language	1	The language the recording is in. Example en	Line	required
Audio file	2 file clip	The sound file to play Example en-US pronunciation of "antishinto".ogg	File	required
Text displayed	3 text context	Text displayed on the link; typically something like "Audio (GA)". You must use this parameter when indicating the pronunciation of a term with this template. Example Audio (RP)	Line	required