Template:Korean/doc

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.

Parameters
Only the first parameter is required
 * :Required
 * :Optional
 * :The Revised Romanization
 * :McCune–Reischauer romanization; to be used in place of rr in articles about North Korea
 * :Optional; for use in articles about North Korea; displays "Hancha" instead of "Hanja" and "Chosŏn'gŭl" instead of "Hangul"
 * :Optional; displays the more neutral Hunminjeongeum instead of "Hangul" or "Chosŏn'gŭl", can be used in articles about events that occurred before the development of North and South Korea (pre-1945)
 * :Set to  to remove all labels. This is useful if the template is used multiple times in quick succession.
 * :Set to  to remove the wikilinks from labels. This reduces overlinking in an article (see WP:OLINK)
 * :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)

Full parameter set


Typical usage:

Example:

will produce:

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 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.



Add no anywhere in the template to suppress label links. This is for preventing overlinking in an article or section where the template is used repeatedly.

TemplateData
{	"params": { "labels": { "label": "Labels", "description": "Labels", "example": "no", "type": "string" },		"links": { "label": "Links", "description": "Links", "example": "no", "type": "string" },		"context": { "label": "Context", "description": "Context", "example": "north" },		"hangul": { "label": "Korean characters", "type": "string", "suggested": true, "description": "Korean characters" },		"hanja": { "label": "Chinese characters", "type": "string", "suggested": true, "description": "Chinese characters" },		"mr": { "description": "McCune–Reischauer Romanization", "type": "string", "suggested": true, "label": "McCune–Reischauer Romanization" },		"rr": { "description": "Revised Romanization", "type": "string", "suggested": true, "label": "Revised Romanization" },		"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" }