View source for Template:Audio/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{for|instructions on inserting audio files|Wikipedia:Creation and usage of media files#Audio}}
{{for|audio files set off from text|Template:Listen}}
{{High-use}}

== 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 [[WP:NFCC#7|Wikipedia:Non-free content criteria § Policy #7]].

The template uses the [[mw:Extension:Phonos|Phonos]] MediaWiki extension to create an audio link that plays on click.

== Usage ==
<code><nowiki>{{Audio|name of sound file|text to use as link to soundfile}}</nowiki></code>

; Example
: <code><nowiki>'''Alabama''' ({{Audio|en-us-Alabama.ogg|pronunciation}}) is a state located in...</nowiki></code>
: → '''Alabama''' ({{Audio|en-us-Alabama.ogg|pronunciation}}) is a state located in...

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
    "description": "Use this template to add an inline link to an audio file, preceded by a speaker icon.",
	"format": "inline",
	"params": {
		"1": {
			"label": "Audio file",
			"description": "Audio file to link to",
			"type": "wiki-file-name",
			"example": "En-uk-London.ogg",
			"required": true
		},
		"2": {
			"label": "Label",
			"description": "Text to replace the filename in the link",
			"type": "string",
			"example": "English pronunciation"
		}
	},
	"paramOrder": [
		"1",
		"2"
	]
}
</templatedata>

== See also ==
{{Audio templates}}

<includeonly>{{Sandbox other|
| <!-- PLEASE ADD CATEGORIES BELOW THIS LINE: -->
[[Category:Audio templates]]
[[Category:Templates that add a tracking category]]

}}</includeonly>