View source for Template:Infobox IPA/doc

{{documentation subpage}}
{{Lua|Module:Infobox|Module:Check for unknown parameters}}
==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:

'''{{para|ipa number}} is required''' to show the sound if available and the header if {{para|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:
{{Infobox IPA
| above       = Voiced velar plosive
| ipa number  = 110
| decimal     = 609
| imagefile   = Voiced velar stop (vector).svg
| imagesize   = 150px
| x-sampa     = g
| braille     = g
}}
<syntaxhighlight lang="wikitext">{{Infobox IPA
| above       = Voiced velar plosive
| ipa number  = 110
| decimal     = 609
| imagefile   = Voiced velar stop (vector).svg
| imagesize   = 150px
| x-sampa     = g
| braille     = g
}}</syntaxhighlight>{{clear}}

==Full parameter list==
<syntaxhighlight lang="wikitext">
{{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        =
}}
</syntaxhighlight>

;Decimal numbers
Up to four decimal values can be entered, to compose the symbol:
{{infobox IPA
| ipa symbol = ʎ̥˔
| ipa number = 157 402A 429
| decimal1   = 654
| decimal2   = 805
| decimal3   = 724
| decimal4   =
}}
<syntaxhighlight lang="wikitext">
| ipa symbol = ʎ̥˔
| ipa number = 157 402A 429
| decimal1   = 654
| decimal2   = 805
| decimal3   = 724
| decimal4   =
</syntaxhighlight>
{{clear}}

===Multiple symbols===
Up to eight symbols can be shown in big font.
{{Infobox IPA
| above = Downstep and upstep
| ipa symbol  = ꜛ◌
| ipa symbol2 = ꜜ◌
| ipa symbol3 =
| ipa symbol8 =
}}
<syntaxhighlight lang="wikitext">
| above = Downstep and upstep
| ipa symbol  = ꜛ◌
| ipa symbol2 = ꜜ◌
| ipa symbol3 =
...
| ipa symbol8 =
</syntaxhighlight>{{clear}}

===Image===
Adding an image of the symbol:
{{infobox IPA
| ipa symbol = ʎ̥˔
| imagefile    = Lateral fricatives.svg
| imagecaption = image example
| imagesize    = 50px
}}
<syntaxhighlight lang="wikitext">
{{infobox IPA
| ipa symbol = ʎ̥˔
| imagefile    = Lateral fricatives.svg
| imagecaption = image example
| imagesize    = 50px
}}
</syntaxhighlight>{{clear}}

===More input options===
{{infobox IPA
| 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
}}
<syntaxhighlight lang="wikitext">
| 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
</syntaxhighlight>{{clear}}

===Sound file===
The template tries to determine the default sound file name by the IPA symbol as defined at [[Module:IPA symbol/data]]:
* {{tlx|IPA symbol|m|output=audio}} &rarr; {{IPA symbol|m|output=audio}}

<code>sound = no</code> overrides the sound file.

==Priorities in parameters==
The template tries to get as much information as possible from the input.
Overwriting:
<syntaxhighlight lang="wikitext">
| above        = (overwrites ipa symbol name (IPA symbol) in header)
| unicode      = (overwrites Unicode numbers that were determinated by the decimal numbers)
</syntaxhighlight>

{{IPA templates}}
==Template data==
{{Template data header}}
<templatedata>
{
	"params": {
		"above": {
			"label": "Label above",
			"description": "Title of the info box",
			"example": "Voiced velar stop",
			"type": "line",
			"suggested": true
		},
		"ipa symbol": {
			"aliases": [
				"ipa-text"
			],
			"label": "IPA symbol 1",
			"description": "IPA symbol for the sound",
			"example": "g",
			"type": "line",
			"suggested": true
		},
		"decimal1": {
			"aliases": [
				"decimal"
			],
			"label": "decimal HMTL codepoint 1",
			"description": "Defines the first symbol in HTML",
			"example": "162",
			"type": "number",
			"suggested": true
		},
		"decimal2": {},
		"decimal3": {},
		"decimal4": {},
		"ipa symbol2": {},
		"ipa symbol3": {},
		"ipa symbol4": {},
		"ipa symbol5": {},
		"ipa symbol6": {},
		"ipa symbol7": {},
		"ipa symbol8": {},
		"imagesize": {
			"label": "Image size",
			"type": "string"
		},
		"imagecaption": {
			"label": "Image caption",
			"type": "line"
		},
		"ipa number": {
			"label": "IPA number",
			"example": "149",
			"type": "number"
		},
		"note1": {
			"label": "Description 1",
			"description": "Description for first symbol",
			"type": "line"
		},
		"unicode": {
			"type": "string"
		},
		"x-sampa": {
			"aliases": [
				"xsampa"
			],
			"label": "X-SAMPA"
		},
		"braille": {},
		"braille2": {},
		"braille3": {},
		"braille4": {},
		"note2 label": {},
		"note2": {},
		"image": {
			"aliases": [
				"ipa-image",
				"imagefile"
			],
			"label": "Image",
			"type": "wiki-file-name"
		}
	},
	"format": "block",
	"paramOrder": [
		"above",
		"ipa symbol",
		"decimal1",
		"decimal2",
		"decimal3",
		"decimal4",
		"ipa symbol2",
		"ipa symbol3",
		"ipa symbol4",
		"ipa symbol5",
		"ipa symbol6",
		"ipa symbol7",
		"ipa symbol8",
		"image",
		"imagesize",
		"imagecaption",
		"ipa number",
		"note1",
		"unicode",
		"x-sampa",
		"braille",
		"braille2",
		"braille3",
		"braille4",
		"note2 label",
		"note2"
	]
}
</templatedata><!--

--><includeonly>{{Sandbox other||
<!--Categories below this line, please; interwikis at Wikidata-->
{{DEFAULTSORT:Infobox Ipa}}
[[Category:Language infobox templates|Ipa]]
[[Category:International Phonetic Alphabet templates]]
}}</includeonly>