View source for Template:Korean/doc

{{Documentation subpage}}
{{High-use}}

==Purpose==
This template organizes Korean scripts and romanizations for use within article prose. It formats Korean [[Hangul]] and [[hanja]] using [[Template:Lang]] to ensure that web browsers use appropriate fonts, and screen readers use correct pronunciation. It also uses [[Template:Transl]] to mark romanizations as belonging in the "latinx" class of [[MediaWiki:Common.css]].

==Usage==
===Parameters===
Only the first parameter is required
;<code>hangul</code>:Required
;<code>hanja</code>:Optional
;<code>rr</code>:The [[Revised Romanization of Korean|Revised Romanization]]
;<code>mr</code>:[[McCune–Reischauer]] romanization; to be used in place of {{para|rr}} in articles about [[North Korean standard language|North Korea]]
;<code>context=north</code>:For use in articles about North Korea; displayed "Hancha" instead of "Hanja".
;<code>labels</code>:Set to <code>no</code> to remove all labels. This is useful if the template is used multiple times in quick succession.
;<code>links</code>:Set to <code>no</code> to remove the wikilinks from labels. This reduces overlinking in an article (see [[WP:OLINK]])
;<code>lit</code>:Allows for the inclusion of a literal English translation; should not be used for people's names

'''Note:''' This template should generally be placed in parentheses (see [[MOS:TEXT#Foreign terms|MOS:TEXT]])

===Full parameter set===
:<code><nowiki>{{Korean|hangul=|hanja=|rr=|mr=|links=|labels=|lit=}}</nowiki></code>
Typical usage:
:<code><nowiki>{{Korean|hangul=|hanja=|rr=}}</nowiki></code>
Example:
:<code><nowiki>{{Korean|hangul=대청황제공덕비|hanja=大淸皇帝功德碑|rr=Daechong Hwangje Gongdeokbi}}</nowiki></code>
will produce:
:{{Korean|hangul=대청황제공덕비|hanja=大淸皇帝功德碑|rr=Daechong Hwangje Gongdeokbi}}
Alternatively, the template can be used without labels. This will produce the same output as above, but be careful to put the Hangul, hanja, and romanizations in the same order as you would if you were using the labels.

===Label options===
Add {{para|labels|no}} anywhere in the template to disable labels, so only the text supplied as parameters appears, separated by semicolons. This minimises the length of the template, and can be used when the template is used more than once to lessen its impact. Disabling labels also suppresses links.

:{{tlx|Korean | 대청황제공덕비 | 大淸皇帝功德碑 | Daechong Hwangje Gongdeokbi | labels {{=}} no}}
:{{Korean | 대청황제공덕비 | 大淸皇帝功德碑 | Daechong Hwangje Gongdeokbi | labels = no}}

Add {{para|links|no}} anywhere in the template to suppress label links. This is for preventing [[WP:overlinking|overlinking]] in an article or section where the template is used repeatedly.
:{{tlx|Korean | 대청황제공덕비 | 大淸皇帝功德碑 | Daechong Hwangje Gongdeokbi | links {{=}} no}}
:{{Korean | 대청황제공덕비 | 大淸皇帝功德碑 | Daechong Hwangje Gongdeokbi | links = no}}

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"labels": {
			"label": "Labels",
			"description": "Labels",
            "autovalue": "no",
			"example": "no",
			"type": "string"
		},
		"links": {
			"label": "Links",
			"description": "Links",
            "autovalue": "no",
			"example": "no",
			"type": "string"
		},
		"context": {
			"label": "Context",
			"description": "Context",
			"example": "north",
			"deprecated": true
		},
		"hangul": {
			"label": "Korean characters",
			"type": "string",
			"suggested": true,
			"description": "Korean characters",
			"aliases": [
				"1"
			]
		},
		"hanja": {
			"label": "Chinese characters",
			"type": "string",
			"suggested": true,
			"description": "Chinese characters",
			"aliases": [
				"2"
			]
		},
		"mr": {
			"description": "McCune–Reischauer Romanization",
			"type": "string",
			"suggested": true,
			"label": "McCune–Reischauer Romanization",
			"aliases": [
				"4"
			]
		},
		"rr": {
			"description": "Revised Romanization",
			"type": "string",
			"suggested": true,
			"label": "Revised Romanization",
			"aliases": [
				"3"
			]
		},
		"lit": {
			"label": "Literal English translation",
			"description": "Literal English translation",
			"type": "string"
		}
	},
	"description": "A template to facilitiate consistent layout, proper formatting, categorisation and language labelling of Korean text",
	"paramOrder": [
		"hangul",
		"hanja",
		"rr",
		"mr",
		"labels",
		"links",
		"context",
		"lit"
	],
	"format": "inline"
}
</templatedata>

==See also==
* [[Template:Infobox Korean name]]
* [[Template:Lang-ko]]
* [[Template:Hanja]]
* [[Template:Hangugeo foot]]

<includeonly>{{Sandbox other||
[[Category:Korean name templates|{{PAGENAME}}]]

}}</includeonly>