Template:Korean/auto/sandbox

This is the template sandbox page for Template:Korean/auto (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

This template should not be used in citation templates such as Citation Style 1 and Citation Style 2, because it includes markup that will pollute the COinS metadata they produce; see Wikipedia:COinS.

This template is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected.

Shortcut

{{ko/autoTemplate:Ko/auto}}

This template uses Lua:

Module:Korean (sandbox)

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**
Markup	Renders 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

^ Explanation

References

^ ref1
^ 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:

In most cases, it uses ehzrmkl
- en_ipa[en_ipa]; hangul[hangulref]; hanja[hanjaref]; rr; mr; ko_ipa[ko_iparef]; lit[litref]
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/auto in articles based on its TemplateData.

TemplateData for Korean/auto

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

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Hangul	`hangul` `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.	String	suggested
Hangul reference	`hangulref`	Hangul reference or footnote	String	optional
Hanja	`hanja` `2`	Hanja	String	suggested
Hanja reference	`hanjaref`	Hanja reference or footnote	String	suggested
Revised Romanization	`rr`	Revised Romanization (semi-automatic). May need to add symbols to the Hangul adjust the romanization. Suggested values `yes` `no` Auto value `yes`	Boolean	optional
McCune–Reischauer	`mr`	McCune–Reischauer (semi-automatic). May need to add symbols to the Hangul adjust the romanization. Suggested values `yes` `no` Auto value `yes`	Boolean	optional
English translation	`lit`	English translation	String	optional
English translation reference	`litref`	English translation reference or footnote	String	optional
English term IPA	`en_ipa`	IPA for English term	String	optional
English IPA reference	`en_iparef`	IPA for English term reference or footnote	String	optional
Korean IPA	`ko_ipa`	IPA for Korean term	String	optional
Korean IPA reference	`ko_iparef`	IPA for Korean term reference or footnote	String	optional
Labels	`labels`	Show labels? Suggested values `yes` `no` Auto value `no`	Boolean	optional
Links	`links`	Show labels but without links? Suggested values `yes` `no` Auto value `no`	Boolean	optional
Name mode	`namemode`	Romanize Hangul as if it's a person's name? Equivalent to putting % at front of Hangul. Suggested values `no` `yes` Auto value `yes`	Boolean	optional
Capitalize romanization	`capitalize`	Capitalize first letter of romanizations? Equivalent to putting ^ at front of Hangul. Suggested values `no` `yes` Auto value `yes`	Boolean	optional
Order	`order`	Order to display terms. Each term represented by a letter. See template docs for key. Default ehzrmkl Example zh	String	optional
Bring out first term?	`out`	Whether to put parentheses around every term after the first Suggested values `yes` `no` Auto value `yes`	Boolean	optional
Bring out first English term?	`en_out`	Shortcut; equivalent to setting out=yes and order=lehzrmk Suggested values `yes` `no` Auto value `yes`	Boolean	optional

Template	Languages	Scripts	Transliterations	Translation	Labels
`{{Hani}}`	Any	—	—	No	No
`{{CJKV}}`	Chinese Japanese Korean Vietnamese	Simplified Chinese Traditional Chinese Japanese writing system^[a] Hangul^[b] Vietnamese alphabet^[c]	Hanyu Pinyin Tongyong Pinyin Cantonese Yale Jyutping Wade–Giles Japanese romanization Korean romanization	Yes	Always
`{{lang-zh}}`	Chinese	Traditional Chinese Simplified Chinese	Hanyu Pinyin Bopomofo Tongyong Pinyin Cantonese Yale Jyutping Wade–Giles Sidney Lau Pe̍h-ōe-jī Tâi-lô	Yes	Optional
`{{Nihongo}}`	Japanese	Japanese writing system^[a]	Hepburn	Yes	Optional
`{{Nihongo2}}`	Japanese	Japanese writing system^[a]	—	No	No
`{{Korean}}`	Korean	Hangul Hanja	Revised Romanization McCune–Reischauer	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

v t e Unicode templates
General	{{Unicode navigation}}
Inline	{{Unichar}} {{Unichar2}} {{U+}} {{GB18030}} {{#invoke:Unicode convert}}
Character properties	Bidi Class General Category Punctuation marks in Unicode Hexadecimal digit Numeric Type Whitespace Alias names and abbreviations
Code points	Planes Unicode blocks
Scripts	{{ISO 15924 script codes and related Unicode data}}
CJK-specific	{{CJK ideographs in Unicode}} {{CJKV}} {{Unihan}} {{Hani}} {{Lang-zh}} {{Nihongo}} {{Korean}} {{Vi-nom}}
Wikipedia related	{{Contains special characters}} (with 'Uncommon Unicode' or more specifically) {{PUA}} (MOS:PUA)
Unicode blocks Unicode charts Unicode templates