Jump to content

Template:Korean/doc

From Wikipedia, the free encyclopedia

Purpose

[edit]

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

[edit]

Parameters

[edit]

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
For use in articles about North Korea; displayed "Hancha" instead of "Hanja".
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

[edit]
{{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大淸皇帝功德碑; RRDaechong 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

[edit]

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: 大淸皇帝功德碑; RRDaechong Hwangje Gongdeokbi

TemplateData

[edit]
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Korean in articles based on its TemplateData.

TemplateData for Korean

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

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Korean charactershangul 1

Korean characters

Stringsuggested
Chinese charactershanja 2

Chinese characters

Stringsuggested
Revised Romanizationrr 3

Revised Romanization

Stringsuggested
McCune–Reischauer Romanizationmr 4

McCune–Reischauer Romanization

Stringsuggested
Labelslabels

Labels

Example
no
Auto value
no
Stringoptional
Linkslinks

Links

Example
no
Auto value
no
Stringoptional
Contextcontext

Context

Example
north
Unknowndeprecated
Literal English translationlit

Literal English translation

Stringoptional

See also

[edit]

Similar templates

[edit]
Inline templates for marking up Chinese characters
Template Languages Scripts Transliterations Translation Labels
{{Hani}} Any No No
{{CJKV}} Yes Always
{{lang-zh}} Chinese
  • Traditional Chinese
  • Simplified Chinese
Yes Optional
{{Nihongo}} Japanese Japanese writing system[a] Hepburn Yes Optional
{{Nihongo2}} Japanese Japanese writing system[a] No No
{{Korean}} Korean
Yes Optional
{{Hanja}} Korean Hanja No Always
{{Vi-nom}} Vietnamese Chữ Nôm No No
{{Lang}} Any Any Any No No
{{Langx}} Any Any Any Yes Optional
  1. ^ a b c No parameter for giving a kana transcription; mixed orthography can be used.
  2. ^ A single "Korean" parameter—suitable for giving a Hangul transcription of a written word used in multiple languages, but not transcribing hanja in a Korean-specific context.
  3. ^ A single "Vietnamese" parameter—suitable for giving a transcription of a written word used in multiple languages, but not transcribing in a Vietnamese-specific context.