Template:Korean/auto

☆ Save On Wikipedia ↗
Template documentation

Purpose

This template is designed to organize Korean-language text and romanizations for use within article prose. It also wraps text in {{Lang}} and {{Transliteration}} as needed (reasoning).

This template is designed to eventually replace its predecessor and parent {{Korean}}. It is capable of doing everything its predecessor did (in mostly identical user-facing syntax) and also has new features.

New features

  • Semi-automatic romanization (both RR and MR) using Module:Ko-translit
  • Can change the display order of terms
  • Can add both English and Korean IPA pronunciations
  • Can have one term be separated from the others by parentheses
  • Can add individual references to Hangul, Hanja, English IPA, Korean IPA, or literal translations
  • Removed parameter |context=, which was already deprecated

Syntax and usage

Quick examples

Examples
MarkupRenders as
{{Korean/auto|hangul=방|hanja=房|rr=yes|mr=yes|lit=room}}

Korean: ; Hanja: ; RR: bang; MR: pang; lit. 'room'

{{Korean/auto|hangul=방|hangulref={{efn|Explanation}}|hanja=房|hanjaref=<ref>ref1</ref>|rr=yes|mr=yes|lit=room|ko_ipa=paŋ|ko_iparef=<ref>ref2</ref>|labels=no}}

[a]; [1]; bang; pang; [paŋ][2]; 'room'

{{Korean/auto|hangul=%홍길동|hanja=洪吉同|mr=yes|rr=yes|order=mzhr|out=yes|labels=no}}

Hong Kiltong (洪吉同; 홍길동; Hong Gildong)

Notes

  1. Explanation

References

  1. ref1
  2. ref2

Parameters

|hangul=
Required. Hangul text, possibly with symbols to adjust automatic romanization. Symbols won't appear when the Hangul is displayed.
|hangulref=
Optional. Reference or footnote for Hangul.
|hanja=
Optional. Hanja text.
|hanjaref=
Optional. Reference or footnote for Hanja. See MOS:HANJAREF; avoid using Chinese-language sources for this.
|rr=
Optional, default no. Set it to yes to show semi-automatic Revised Romanization. The romanization can/may need to be altered using symbols that you should place in the Hangul.
|mr=
Optional, default no. Set it to yes to show semi-automatic McCune–Reischauer. Can/may need to be adjusted with symbols in Hangul.
|lit=
Optional. English translation of term.
|litref=
Optional. Reference for translation.
|en_ipa=
Optional. IPA pronunciation for English term. Don't have slashes or square brackets around it.
|en_iparef=
Optional. Reference for English IPA.
|ko_ipa=
Optional. IPA for Korean term. Don't have slashes or square brackets around it.
|ko_iparef=
Optional. Reference for Korean IPA.
|labels=
Optional, default yes. Set it to no to hide language and IPA labels. Especially useful when labels are repeated or obvious.
|links=
Optional, default yes. Set it to no to turn off links, especially when they are repeats of previous links.
|namemode=
Optional, default no. Set it to yes to romanize hangul input as if it's a person's name. Equivalent to adding % to the beginning of hangul.
This parameter is mostly appropriate for when hangul only contains a typical person's name (1 surname character). If the name is atypical or hangul contains other text besides a name, consider not using this parameter and instead inserting symbols manually into hangul.
|capitalize=
Optional, default no. Set it to yes to capitalize romanizations of hangul. Equivalent to adding ^ to the beginning of hangul.
|order=
Optional. String that modifies what order to show terms in. Default ordering: ehzrmkl (see #Ordering for more info).
|out=
Optional, default no. Set to yes to put everything after the first term in parentheses.
|en_out=
Optional, default no. Shortcut param; if you set this to yes, it's equivalent to setting out=yes and order=lehzrmk. You can still set an order if you wish, but l must come first.

Ordering

Terms can be reordered by giving a string of letters. Each letter represents a term. References are assumed to always follow just after the relevant term.

Letter Term
e English IPA
h Hangul
z Hanja
r Revised Romanization
m McCune–Reischauer
k Korean IPA
l Literal English translation

By default, if no |order= is given, the template uses one of these two orderings:

  1. In most cases, it uses ehzrmkl
    • en_ipa[en_ipa]; hangul[hangulref]; hanja[hanjaref]; rr; mr; ko_ipa[ko_iparef]; lit[litref]
  2. If en_out=yes, it uses lehzrmk
    • lit[litref] (en_ipa[en_iparef]; hangul[hangulref]; hanja[hanjaref]; rr; mr; ko_ipa[ko_iparef])

The above default orderings attempt to abide by the ordering specified in MOS:KO-LEAD.

If you do provide your own ordering, we recommend you have letters for all parameters that you want to be displayed. There are several possible several optional letters (k and l default to being placed at end if not provided, and e either first or second depending on en_out), but it's clearer to others if you just show all letters you use.

TemplateData

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

For wrapping and appropriately formatting Korean text. Also allows for semi-automatic romanization.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Hangulhangul 1

Hangul. May need symbols to adjust automatic romanization. See [[Module:Ko-translit]] for a guide on the symbols. Quick guide: ^ to capitalize the next letter, % to activate name mode.

Stringsuggested
Hangul referencehangulref

Hangul reference or footnote

Stringoptional
Hanjahanja 2

Hanja

Stringsuggested
Hanja referencehanjaref

Hanja reference or footnote

Stringsuggested
Revised Romanizationrr

Revised Romanization (semi-automatic). May need to add symbols to the Hangul adjust the romanization.

Suggested values
yes no
Auto value
yes
Booleanoptional
McCune–Reischauermr

McCune–Reischauer (semi-automatic). May need to add symbols to the Hangul adjust the romanization.

Suggested values
yes no
Auto value
yes
Booleanoptional
English translationlit

English translation

Stringoptional
English translation referencelitref

English translation reference or footnote

Stringoptional
English term IPAen_ipa

IPA for English term

Stringoptional
English IPA referenceen_iparef

IPA for English term reference or footnote

Stringoptional
Korean IPAko_ipa

IPA for Korean term

Stringoptional
Korean IPA referenceko_iparef

IPA for Korean term reference or footnote

Stringoptional
Labelslabels

Show labels?

Suggested values
yes no
Auto value
no
Booleanoptional
Linkslinks

Show labels but without links?

Suggested values
yes no
Auto value
no
Booleanoptional
Name modenamemode

Romanize Hangul as if it's a person's name? Equivalent to putting % at front of Hangul.

Suggested values
no yes
Auto value
yes
Booleanoptional
Capitalize romanizationcapitalize

Capitalize first letter of romanizations? Equivalent to putting ^ at front of Hangul.

Suggested values
no yes
Auto value
yes
Booleanoptional
Orderorder

Order to display terms. Each term represented by a letter. See template docs for key.

Default
ehzrmkl
Example
zh
Stringoptional
Bring out first term?out

Whether to put parentheses around every term after the first

Suggested values
yes no
Auto value
yes
Booleanoptional
Bring out first English term?en_out

Shortcut; equivalent to setting out=yes and order=lehzrmk

Suggested values
yes no
Auto value
yes
Booleanoptional

See also


Similar templates

Inline templates for marking up Chinese characters
TemplateLanguagesScriptsTransliterationsTranslationLabels
{{Hani}} AnyN/aN/aNoNo
{{CJKV}} YesAlways
{{lang-zh}} Chinese
  • Traditional Chinese
  • Simplified Chinese
YesOptional
{{Nihongo}} Japanese Japanese writing system[a]HepburnYesOptional
{{Nihongo2}} JapaneseJapanese writing system[a] N/aNoNo
{{Korean}} Korean
YesOptional
{{Hanja}} Korean Hanja N/aNoAlways
{{Vi-nom}} Vietnamese Chữ Nôm N/aNoNo
{{Lang}} AnyAnyAnyNoNo
{{Langx}} AnyAnyAnyYesOptional
  1. 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.