Fyrimynd:IPA soundbox/doc

Hetta er ein dokumentatión undirsíða til Fyrimynd:IPA soundbox.
Hon inniheldur kunning um nýtsluna, bólkar og um annað innihald, ið ikki er við í uppruna fyrimynd síðuni.

This template employs intricate features of template syntax.

You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.
Remember that you can conduct experiments, and should test all improvements, in either the or your user space before changing anything here.

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|ə}} →
ə
File "mid central vowel#Mid-central unrounded vowel.ogg" does not exist
{{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 existence. 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;}} →

m

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

- default: show errormessage as error message

-

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=
| showsymbol    =
| line-height   =
<!-- PLAYER -->
| soundfile     =
| checkexist    =
| showicon      =
| width         =
| size          =
}}

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

Fyrimynd:IPA soundbox/doc

Usage

Input options

See also