साँचा:IPA soundbox/doc का स्रोत देखें

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

This template produces a standard box to start a sound file. It has some extra features to help linking to a phonetic sound file. Also, there are options to format possible error messages and to alter the layout of the box. Basic examples:
* {{tlx|IPA soundbox|ə}} &rarr; {{IPA soundbox|ə}} 
* {{tlx|IPA soundbox|<nowiki>|χ|</nowiki>Voiceless_uvular_fricative.ogg‎}} &rarr; {{IPA soundbox|χ|Voiceless_uvular_fricative.ogg}}
=== Usage ===
The box is created in three steps:<br>
'''Step 1'''. Determine the soundfile name
:- By using input IPA symbol, looked up in a list: {{code|ipa symbol{{=}}p}} &rarr; {{IPA soundbox|p|checkexist=no|showbox=no}} 
:- Use input soundfile: {{code|soundfile{{=}}bilabial click.ogg}}&rarr; {{IPA soundbox|ʘ|soundfile=bilabial click.ogg|checkexist=no}} 

'''Step 2'''. Check if the soundfile exists
This check may prevent red links and (undesired) repeated checks

'''Step 3'''. Create the standard browser soundbox on the page, using [[WP:EIS|<nowiki>[[File:soundfile]]</nowiki>]]
Here the information is put together, optional settings such as size are used, and the result is soundbox.
* {{tlx|IPA soundbox|p||size{{=}}60px}} &rarr;
* {{IPA soundbox|p||size=60px}} 

====Input options====
:a. {{code|<nowiki>checkexist=no</nowiki>}}: skip (expensive) check on file existance. Default=yes (do the check).
:b. layout of the soundbox (these settings use basic layout parameters):
:-  {{code|<nowiki>showicon=no</nowiki>}}: show info icon ("noicon" in basic) 
:- {{code|<nowiki>size=50px</nowiki>}} size (in px: default =250px, minimum is ~40px) Basic: width.
:- {{code|<nowiki>style</nowiki>}}: any style (CSS format) to be used, e.g. {{code|<nowiki>style=background:yellow;</nowiki>}}
* {{tlx|IPA soundbox|<nowiki>| ipa symbol=m| size=120px| style=border:1px solid red; background:yellow;</nowiki>}} &rarr;
{{IPA soundbox| ipa symbol=m| size=120px| style=border:1px solid red; background:yellow;}}
<br/>
:c. When an error would exist, show an error message:
:- default: show errormessage as {{error|error message|tag=span}}
:- {{code|<nowiki>errortext=something is wrong</nowiki>}}: Show alternate text when error
:- {{code|<nowiki>errortext=</nowiki>}}: blank, no output at all (no showbox) 

Example of check file once:
*See {{tl|infobox IPA}}. First the file is checked, and returns filename if exists. ''Then'' if there is a filename, the infobox row is composed, including the soundbox set with {{code|<nowiki>checkexist=no</nowiki>}}.

;Full parameter list:
<pre>
{{IPA soundbox
<!-- GENERAL -->
| ipa symbol    =
| style         =
| errortext     =
<!-- ABOVE -->
| show box above=
| IPAsym name   =
| showsymbol    =
| line-height   =
<!-- PLAYER -->
| soundfile     =
| checkexist    =
| showicon      =
| width         =
| size          =
}}</pre>

;Possible errors: 
:1. IPA symbol unknow in IPAsym list
:2. File does not exist
:When an error exists, no button will be shown.

=== See also ===
* {{tlx|IPA audio filename}} 
* {{tlx|infobox IPA}} (uses this template internally)
* {{tlx|IPA vowels audio}} (uses this template internally)
* {{tlx|IPA pulmonics audio}} (uses this template internally)
* [[Wikipedia:Extended image syntax]]
{{IPA templates}}

<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->

[[Category:IPA audio templates]]
</includeonly>