Template:Infobox IPA/doc
| This is a documentation subpage for Template:Infobox IPA. It contains usage information, categories and other content that is not part of the original template page. |
Contents
Usage
This template can be used to add an infobox for a phonetic sound.
This infobox can be used to describe a phonetic sound, both by its name and its IPA symbol. Additional information can be added, like the X-SAMPA letters and a graphic image file.
In general, the descriptive name corresponds with the article name. The infobox is then placed on that article page.
Parameters
Basic parameters
Only a few parameters are required to produce a useful infobox. The above header can be set, and up to four IPA symbols can be shown:
For common IPA symbols, the IPA number defines the article name and the default soundfile name. Decimals are decimal character references, also known as "Entity", to define the symbol in HTML. The template tries to find all known information with these two numbers.
| Infobox IPA/doc | |
|---|---|
| ɮ | |
| IPA Number | 149 |
| Encoding | |
| Entity (decimal) | ɮ |
| Unicode (hex) | U+026E |
{{Infobox IPA
| ipa number = 149
| decimal1 = 622
}}
Some more basic parameters:
| Voiced velar stop | |||
|---|---|---|---|
| ɡ | |||
| IPA Number | 110 | ||
| Encoding | |||
| Entity (decimal) | ɡ | ||
| Unicode (hex) | U+0261 | ||
| X-SAMPA | g | ||
| Braille | ⠛ (braille pattern dots-1245) U+281B | ||
| |||
{{Infobox IPA
| above = Voiced velar stop
| ipa number = 110
| decimal = 609
| imagefile = Voiced velar stop (vector).svg
| imagesize = 150px
| x-sampa = g
| kirshenbaum = g
| braille = g
}}
Full parameter list
{{infobox IPA
| above =
| ipa symbol =
| ipa symbol2 =
| ipa symbol3 =
| ipa symbol4 =
| imagefile =
| imagecaption =
| imagesize =
| ipa number =
| ipa link =
| decimal1 =
| decimal2 =
| decimal3 =
| decimal4 =
| note1 label =
| note1 =
| unicode =
| x-sampa =
| kirshenbaum =
| braille =
| braille2 =
| braille3 =
| braille4 =
| note2 label =
| note2 =
| soundfile =
}}
- Decimal numbers
Up to four decimal values can be entered, to compose the symbol:
| Voiceless | |
|---|---|
| ʎ̥˔ | |
| IPA Number | 157 402A 429 |
| Encoding | |
| Entity (decimal) | ʎ̥˔ |
| Unicode (hex) | U+028E U+0325 U+02D4 |
| ipa symbol = ʎ̥˔ | ipa number = 157 402A 429 | decimal1 = 654 | decimal2 = 805 | decimal3 = 724 | decimal4 =
Multiple symbols
Up to eight symbols can be shown in big font.
| Downstep and upstep | |
|---|---|
| ꜛ◌ | |
| ꜜ◌ |
| above = Downstep and upstep | ipa symbol = ꜛ◌ | ipa symbol2 = ꜜ◌ | ipa symbol3 = ... | ipa symbol8 =
Image
Adding an image of the symbol:
| Voiceless | ||||
|---|---|---|---|---|
| ʎ̥˔ | ||||
| ||||
{{infobox IPA
| ipa symbol = ʎ̥˔
| imagefile = Lateral fricatives.svg
| imagecaption = image example
| imagesize = 50px
}}
More input options
| Open front unrounded vowel | |
|---|---|
| a | |
| Extra note 1 | This is my first note |
| Encoding | |
| Unicode (hex) | U+9999 |
| X-SAMPA | X-S |
| Extra note 2 | Another note by me here |
| ipa symbol = a | note1 label = Extra note 1 | note1 = This is my first note | unicode = U+9999 | x-sampa = X-S | kirshenbaum = K | note2 label = Extra note 2 | note2 = Another note by me here
Soundfile
The template tries to determine the default soundfile name by using the sound name (as determined by the IPA number, or IPA symbol):
{{IPA symbol|m}}→ Lua error in Module:IPA_symbol at line 37: Invalid data type "soundfile".- If this fails, the file name can be entered.
When the file exists, the soundbutton is shown. Otherwise, no soundbutton is shown at all.
| Infobox IPA/doc | |
|---|---|
| abc | |
| Example non default soundfile | |
| Audio sample | |
| File:Accordion registers.ogg |
| ipa symbol = abc | note2 = Example non default soundfile | soundfile = Accordion registers.ogg
Deprecated parameters
The next parameters are deprecated. They can still be used, and may be present in articles.
Old parameters are treated as input for new ones, e.g. input ipa-image=... is read as input for imagefile=....
old parameter goes into new parameter:<br> ipa-number => ipa number ipa-text => ipa symbol ipa-image => imagefile decimal => decimal1 xsampa => x-sampa sound => soundfile
Priorities in parameters
The template tries to get as much information as possible from the input. Overwriting:
| above = (overwrites ipa symbol name (IPA symbol) in header) | ipa symbol = (overwrites big symbol that was created by the decimal numbers) | unicode = (overwrites Unicode numbers that were determinated by the decimal numbers) | soundfile = (overwrites any default soundfile name that was derived by the IPA symbol name or number)
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Label above | above title | Title of the info box
| Line | suggested |
| IPA symbol 1 | ipa symbol ipa-text | IPA symbol for the sound
| Line | suggested |
| decimal HMTL codepoint 1 | decimal1 decimal | Defines the first symbol in HTML
| Number | suggested |
| Decimal2 | decimal2 | no description | Unknown | optional |
| Decimal3 | decimal3 | no description | Unknown | optional |
| Decimal4 | decimal4 | no description | Unknown | optional |
| Ipa symbol2 | ipa symbol2 | no description | Unknown | optional |
| Ipa symbol3 | ipa symbol3 | no description | Unknown | optional |
| Ipa symbol4 | ipa symbol4 | no description | Unknown | optional |
| Ipa symbol5 | ipa symbol5 | no description | Unknown | optional |
| Ipa symbol6 | ipa symbol6 | no description | Unknown | optional |
| Ipa symbol7 | ipa symbol7 | no description | Unknown | optional |
| Ipa symbol8 | ipa symbol8 | no description | Unknown | optional |
| Image file | imagefile ipa-image | no description | File | optional |
| Image size | imagesize | no description | String | optional |
| Image caption | imagecaption | no description | Line | optional |
| IPA number | ipa number | defines the article name and the default soundfile name
| Number | optional |
| Ipa link | ipa link | no description | Unknown | optional |
| Description 1 label | note1 label | Labels the first note | String | optional |
| Description 1 | note1 | Description for first symbol | Line | optional |
| Unicode | unicode | no description | String | optional |
| X-sampa | x-sampa | no description | Unknown | optional |
| Xsampa | xsampa | no description | Unknown | optional |
| Kirshenbaum | kirshenbaum | no description | Unknown | optional |
| Braille | braille | no description | Unknown | optional |
| Braille2 | braille2 | no description | Unknown | optional |
| Braille3 | braille3 | no description | Unknown | optional |
| Braille4 | braille4 | no description | Unknown | optional |
| Note2 label | note2 label | no description | Unknown | optional |
| Note2 | note2 | no description | Unknown | optional |
| Sound file | soundfile sound | A sound file to play
| File | optional |