साँचा:IPA soundbox/doc

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:

• {{IPA soundbox|ə}} →
  ə
• {{IPA soundbox||χ|Voiceless_uvular_fricative.ogg‎}} →
  χ

Usage

The box is created in three steps:
Step 1. Determine the soundfile name

- By using input IPA symbol, looked up in a list:

ipa symbol=p

→

p

- Use input soundfile:

soundfile=bilabial click.ogg

→

ʘ

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 [[File:soundfile]] Here the information is put together, optional settings such as size are used, and the result is soundbox.

• {{IPA soundbox|p|size=60px}} →
• p

Input options

a.

checkexist=no

: skip (expensive) check on file existance. Default=yes (do the check).

b. layout of the soundbox (these settings use basic layout parameters):

-

showicon=no

: show info icon ("noicon" in basic)

-

size=50px

size (in px: default =250px, minimum is ~40px) Basic: width.

-

style

: any style (CSS format) to be used, e.g.

style=background:yellow;

• {{IPA soundbox|| ipa symbol=m| size=120px| style=border:1px solid red; background:yellow;}} →

{{{1}}}

c. When an error would exist, show an error message:

- default: show errormessage as

-

errortext=something is wrong

: Show alternate text when error

-

errortext=

: blank, no output at all (no showbox)

Example of check file once:

• See {{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

  checkexist=no
  

  .

Full parameter list

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

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

• {{IPA audio filename}}
• {{infobox IPA}} (uses this template internally)
• {{IPA vowels audio}} (uses this template internally)
• {{IPA pulmonics audio}} (uses this template internally)
• Wikipedia:Extended image syntax