View source for Template:hyphenation/doc

{{documentation subpage}}
<!-- Categories, interwikis and TemplateData go at the bottom of this page. -->
This template is used for providing the hyphenation pronunciation of a word.

== Usage ==
To add hyphenation pronunciation to words, mark each possible hyphenation location with a [[vertical bar]] (a.k.a. a “pipe”: « | »), and it will be displayed with an [[interpunct]] (U+2027 hyphenation point ‹ ‧ ›).

For example, on {{term|measure}}, writing <code><nowiki>{{hyphenation|mea|sure}}</nowiki></code> gives you:

* {{hyphenation|mea|sure}}

For cases where there are more than one possible hyphenation this template can be used with the <code>caption=</code> parameter to give more detailed usage, or the <code>nocaption=1</code> parameter to turn off the caption altogether. For example, writing <code><nowiki>{{hyphenation|mea|sure|caption=Hyphenation US}} {{hyphenation|caption=UK|mea|sure}}</nowiki></code> will give you:

* {{hyphenation|mea|sure|caption=Hyphenation US}} {{hyphenation|caption=UK|mea|sure}}

Note: This template is limited to 30 possible hyphenation locations, which is enough for most words. If the word has more than that, you will have to write out the hyphenation yourself (with the interpunct)

== TemplateData ==
{{TemplateDataHeader}}
<templatedata>
{
	"params": {
		"1": {
			"required": true,
			"label": "Hyphenation portion",
			"type": "string",
			"description": "A hyphenation portion of the word."
		},
		"2": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"3": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"4": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"5": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"6": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"7": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"8": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"9": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"10": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"11": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"12": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"13": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"14": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"15": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"16": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"17": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"18": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"19": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"20": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"21": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"22": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"23": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"24": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"25": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"26": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"27": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"28": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"29": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"30": {
			"required": false,
			"label": "Hyphenation portion",
			"inherits": "1"
		},
		"nocaption": {
			"required": false,
			"label": "No caption?",
			"type": "string",
			"description": "Whether or not to have a caption for the hyphenation, blank is to have it."
		},
		"caption": {
			"required": false,
			"label": "Caption",
			"type": "string",
			"description": "A caption for the hyphenation."
		}
	},
	"description": "Template for adding hyphenation pronunciations to pages."
}
</templatedata>

<includeonly>[[Category:Pronunciation templates|Hyphenation]]</includeonly>