Template:Infobox IPA/doc
This is a documentation subpage for Template:Infobox IPA. It may contain usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
Usage
[edit]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
[edit]Basic parameters
[edit]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:
|ipa number=
is required to show the sound if available and the header if |above=
is omitted.
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.
Some more basic parameters:
Voiced velar plosive | |||
---|---|---|---|
ɡ | |||
IPA Number | 110 | ||
Encoding | |||
Entity (decimal) | ɡ | ||
Unicode (hex) | U+0261 | ||
X-SAMPA | g | ||
Braille | |||
|
{{Infobox IPA
| above = Voiced velar plosive
| ipa number = 110
| decimal = 609
| imagefile = Voiced velar stop (vector).svg
| imagesize = 150px
| x-sampa = g
| braille = g
}}
Full parameter list
[edit]{{infobox IPA
| above =
| ipa symbol =
| ipa symbol2 =
| ipa symbol3 =
| ipa symbol4 =
| imagefile =
| imagecaption =
| imagesize =
| ipa number =
| decimal1 =
| decimal2 =
| decimal3 =
| decimal4 =
| note1 label =
| note1 =
| unicode =
| x-sampa =
| braille =
| braille2 =
| braille3 =
| braille4 =
| note2 label =
| note2 =
}}
- 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
[edit]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
[edit]Adding an image of the symbol:
Voiceless | ||||
---|---|---|---|---|
ʎ̥˔ | ||||
|
{{infobox IPA
| ipa symbol = ʎ̥˔
| imagefile = Lateral fricatives.svg
| imagecaption = image example
| imagesize = 50px
}}
More input options
[edit]Open front unrounded vowel | |
---|---|
a | |
Extra note 1 | This is my first note |
Audio sample | |
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
| note2 label = Extra note 2
| note2 = Another note by me here
Sound file
[edit]The template tries to determine the default sound file name by the IPA symbol as defined at Module:IPA symbol/data:
{{IPA symbol|m}}
→ Bilabial nasal.ogg
sound = no
overrides the sound file.
Priorities in parameters
[edit]The template tries to get as much information as possible from the input. Overwriting:
| above = (overwrites ipa symbol name (IPA symbol) in header)
| unicode = (overwrites Unicode numbers that were determinated by the decimal numbers)
Template data
[edit]TemplateData for Infobox IPA
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Label above | above | 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 | image ipa-image imagefile | no description | File | optional |
Image size | imagesize | no description | String | optional |
Image caption | imagecaption | no description | Line | optional |
IPA number | ipa number | no description
| Number | optional |
Description 1 | note1 | Description for first symbol | Line | optional |
unicode | unicode | no description | String | optional |
X-SAMPA | x-sampa xsampa | 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 |