Template:audio/documentation

This template links to an audio file of spoken language, typically in the "Pronunciation" section of an entry to indicate how a term is pronounced.

To link to an audio file connected to the meaning of the entry (for example, a recording of a klaxon sound in the entry), use listen.

Parameters

 * 1
 * The language code (see List of languages) for the current language section. The parameter lang is a deprecated synonym; please do not use. If this is used, all numbered parameters move down by one.


 * 2
 * The name of the audio file.


 * 3
 * The caption to use, in place of "Audio". In most cases, don't override this, but use one of the following parameters instead.


 * q
 * Specifies a qualifier to be placed before the audio box, after the "Audio" caption. This is formatted with the q/qualifier template.


 * a
 * Specifies one or more comma-separated accent qualifiers to be placed before the audio box, after the "Audio" caption, and are useful for specifying the accent found in the audio file. These are formatted with the a/accent template. To be recognized as a separator, there must be no space following the comma; otherwise, the comma is treated as an embedded comma within the accent qualifier.


 * qq
 * Specifies a qualifier to be placed at the end, after the audio box. Normally, use q instead of this, unless the qualifier is particularly long. This is formatted with the q/qualifier template.


 * aa
 * Specifies one or more comma-separated accent qualifiers to be placed at the end, after the audio box. Normally, use a instead of this, unless the qualifier is particularly long. These are formatted with the a/accent template. To be recognized as a separator, there must be no space following the comma; otherwise, the comma is treated as an embedded comma within the accent qualifier.


 * ref
 * Specifies one or more reference notes to be placed directly after the audio box. The reference is placed in the  section at the bottom of the language's entry. See below for the format of this parameter.


 * text
 * Specifies the text of the audio snippet, if it isn't the same as the term being illustrated. This can be used, for example, when the audio snippet contains extra words in it (e.g. articles).


 * IPA
 * Specifies the IPA pronunciation of the audio snippet. This can be used, for example, when the audio snippet contains extra words in it, to make it easier to pick out the relevant term. The IPA should be enclosed in brackets or slashes, like the parameters of IPA.


 * t
 * Specifies the meaning (gloss) of the text in text, if that text is in a foreign language and its meaning isn't obvious.


 * lit
 * Specifies the literal meaning of the text in text, if needed.


 * tr
 * Specifies the manual transliteration of the text in text, for text in non-Latin scripts where either the automatic transliteration isn't correct or there is no automatic transliteration (e.g. in Persian and Hebrew).


 * ts
 * Specifies the transcription of the text in text, for text in non-Latin scripts where the transliteration is radically different from the actual pronunciation. To be used sparingly and only for certain languages; see the description of this parameter in l for more information.


 * pos
 * Specifies the part of speech of the text in text. Included mostly for completeness; rarely needed.


 * 1
 * Turns off categorization.


 * sort
 * Manual sortkey. Use sparingly; the lua method in Module:languages can usually generate the correct sortkey.


 * bad
 * To formulate a warning to the reader about quality problems of the audio.

Examples

 * The file name should be formatted as [language code]-[dialect if any]-[term].


 * Wikitext:
 * Result:


 * Wikitext:
 * Result:


 * Wikitext:
 * Result:


 * Wikitext:
 * Result:


 * Wikitext:
 * Result:


 * Wikitext:
 * Result:

TemplateData
{	"params": { "1": {			"label": "Language", "description": "The language (see Languages) the recording is in.", "example": "en", "type": "string", "required": true },		"2": {			"label": "Audio file", "description": "The sound file to play.", "example": "en-US pronunciation of \"antishinto\".ogg", "type": "wiki-file-name", "required": true },		"3": {			"label": "Caption", "description": "Text displayed before the audio box. Defaults to 'Audio'; rarely needs to be specified.", "example": "the sound of a pig's \"oink\"", "type": "string" },		"a": { "label": "Left accent qualifier(s)", "description": "Specifies one or more comma-separated accent qualifiers to be placed before the audio box. These are formatted with the / template.", "type": "string" },		"q": { "label": "Left qualifier", "description": "Specifies a qualifier to be placed before the audio box. This is formatted with the / template.", "type": "string" },		"aa": { "label": "Right accent qualifier(s)", "description": "Specifies one or more comma-separated accent qualifiers to be placed after the audio box. These are formatted with the / template.", "type": "string" },		"qq": { "label": "Right qualifier", "description": "Specifies a qualifier to be placed after the audio box. This is formatted with the / template.", "type": "string" },		"ref": { "label": "Reference", "description": "Specifies a reference note to be placed directly after the audio box. The reference is placed in the ===References=== section at the bottom of the language's entry.", "type": "string" },		"text": { "label": "Text of audio snippet", "description": "Specifies the text of the audio snippet, used especially when it contains additional words.", "type": "string" },		"IPA": { "label": "IPA of audio snippet", "description": "Specifies the IPA pronunciation of the audio snippet, used especially when it contains additional words.", "type": "string" }	},	"description": "An audio file to assist readers pronouncing the word. Labeled with language and possibly dialect.", "format": "inline" }