Template:IPA audio filename/doc

This template produces the filename of an IPA sound sample (not the sound itself). It is determined, by default, from the IPA symbol. For example:  →. Optionally, a non-default filename can be entered here, so the template will produce that non-default filename. Also optionally, the existence of the file can be checked, and an error message can be overridden by a text or a blank.

Usage
Full input list is:
 * First parameter or ípa symbol= This first parameter (or named parameter ipa symbol=)is for the IPA symbol. The symbol is translated into the name of the sound (using the list in IPAsym) and adding the extension . When the parameter is not used, the input   should be used. For any symbol, the default name can be permanently overruled through the list (see below).
 * &rarr;
 * soundfile= (optional, default=none) This parameter allows for entering any literal filename. Input here bypasses (overwrites) the first parameter. It can be used to enter a filename that does not have a default name as IPAsym produces. Note: when used, this input should have the extension.
 * &rarr;


 * checkexist= (optional, default=no) Can be "yes" or "no". When entered "yes", and the filename is not an error, the template checks for the existence of the filename. If itdoes not exist, an error is produced. ''Note: Checking for existance is called an "expensive" function, in that it requires serious server-side action. The number of file checks per page is limited.
 * &rarr;
 * errortext= (optional, default=none) The errortext entered here overwrites any possible error-output. If there is no error, this errortext is not used. The tradeoff is: it hides any error information, but is cleans up the output. The errortext can be a blank, like.
 * &rarr;

Permanent altered from default name
Some IPA symbols have soundfiles available in Wikipedia that are not the default name. These alternate names can be entered in this template, and will show up in the output.

Subtemplate contains the list of alternate names. Example: The filename however differs from that default name. The list in produces that different name: Currently, the next nine non-default names are in the list:
 * kʼ is named, so this would yield default name:

Possible errors
Three error situations are covered:
 * No IPA symbol entered (and no soundfile name):
 * &rarr;


 * The IPA symbol may not be defined in :
 * &rarr;


 * Checkexist=yes is asked, and the file does not exist:
 * &rarr;

These error outputs can be overridden by using. This can be blank. This only has effect on the output, it does not alter the existing error situation.

Technical background

 * The template uses nested sub-templates to prevent re-caculation of repeated data. e.g. the name from is calculated only once, and then passed through to the next subtemplate in the nest. This is more important for the check on existence , which is "expensive" and should be performed only once. The nesting has three levels:  calls  calls.
 * Error texts are passed through unaltered. At the end, in, any error is enveloped with the errortext (if provided).
 * Check existence is performed only when the filename is not an error in itself.

Issues

 * Todo: the template should accept input "|ipa symbol=...", overriding current unnamed param #1.

Subtemplates used:
 * (Here non-default filenames can be entered)
 * (Here non-default filenames can be entered)
 * (Here non-default filenames can be entered)