ಟೆಂಪ್ಲೇಟು:Audio/doc

This is a documentation subpage for ಟೆಂಪ್ಲೇಟು:Audio
It may contain usage information, categories and other content that is not part of the original ಟೆಂಪ್ಲೇಟು page.

This template is used on approximately ೨೭,೦೦೦ pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

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 (pronunciation (ಸಹಾಯ·ಮಾಹಿತಿ)) 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 (

pronunciation of "Alabama" (ಸಹಾಯ·ಮಾಹಿತಿ))

Todo: add {{inline audio}} to this page.

Microformat

The HTML mark up produced by this template includes an hAudio microformat, which makes the recording's details parsable by computers, either acting automatically to catalogue articles across Wikipedia, or via a browser tool operated by a person, to (for example) add the subject to a playlist or database. For more information about the use of microformats on Wikipedia, please see the microformat project.

Sub-templates

Date-of-publication ("published") information will only be included in the microformat if {{Start date}} (or {{Start date and age}} where appropriate) is used in a parent template or infobox (but do not use these if the date is before 1583 CE).

For the length or duration of a recording, say 3 minutes 45 seconds, use {{Duration}} thus: {{Duration|m=3|s=45}}, which renders as 3:45. An optional h parameter can be used for hours.

Please do not remove instances of these sub-templates.

Classes

hAudio uses HTML classes including:

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.
ಪರಿಮಿತಿ		ವಿವರ	ನಮೂನೆ	ಸ್ಥಾನಮಾನ
Audio file	`1`	Audio file to link to Example En-uk-London.ogg	ಕಡತ	required
Label	`2`	Text to replace the filename in the link Example English pronunciation	String	ಐಚ್ಛಿಕ
Show "(help·info)" links?	`help`	Enter "no" here to remove the "(help·info)" links. Example no Auto value `no`	Line	ಐಚ್ಛಿಕ