Tɛmplet:Ko-hhrm/doc

This is a documentation subpage for Tɛmplet:Ko-hhrm.
It contains usage information, categories and other content that is not part of the original tɛmplet page.

This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

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

hangul: Required
hanja: Optional
rr: The Revised Romanization
mr: McCune–Reischauer romanization; to be used in place of |rr= in articles about North Korea
context=north: Deprecated; for use in articles about North Korea; displayed "Hancha" instead of "Hanja" and "Chosŏn'gŭl" instead of "Hangul"
context=old: Deprecated; displayed Hunminjeongeum instead of "Hangul" or "Chosŏn'gŭl", was meant to be used in articles about events that occurred before the development of North and South Korea (pre-1945)
labels: Set to no to remove all labels. This is useful if the template is used multiple times in quick succession.
links: Set to no to remove the wikilinks from labels. This reduces overlinking in an article (see WP:OLINK)
lit: 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

{{Korean|hangul=|hanja=|rr=|mr=|links=|labels=|lit=}}

Typical usage:

{{Korean|hangul=|hanja=|rr=}}

Example:

{{Korean|hangul=대청황제공덕비|hanja=大淸皇帝功德碑|rr=Daechong Hwangje Gongdeokbi}}

will produce:

Korean: 대청황제공덕비; 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 |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.

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

대청황제공덕비; 大淸皇帝功德碑; Daechong Hwangje Gongdeokbi

Add |links=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.

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

Korean: 대청황제공덕비; Hanja: 大淸皇帝功德碑; RR: Daechong Hwangje Gongdeokbi

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Ko-hhrm

A template to facilitiate consistent layout, proper formatting, categorisation and language labelling of Korean text

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Korean characters	`hangul` `1`	Korean characters	String	suggested
Chinese characters	`hanja` `2`	Chinese characters	String	suggested
Revised Romanization	`rr` `3`	Revised Romanization	String	suggested
McCune–Reischauer Romanization	`mr` `4`	McCune–Reischauer Romanization	String	suggested
Labels	`labels`	Labels Example no	String	optional
Links	`links`	Links Example no	String	optional
Context	`context`	Context Example north	Unknown	deprecated
Literal English translation	`lit`	Literal English translation	String	optional