Editing Module:Ko-translit/doc

{{Module rating|pre-alpha}}
This module automatically romanizes Korean text (Hangul). It supports the Revised Romanization (RR) and McCune–Reischauer (MR) romanization systems.
* Example: 독립 (pronounced [동닙]) → ''dongnip'' (RR), ''tongnip'' (MR)

Due to the nature of both systems, users will sometimes need to input symbols to instruct the system on how to correctly handle various edge cases. These input symbols do not appear in the output; they are only used to output the correct romanization per the rules of each system.

; Quick guide
# Personal name
## Prepend <code>%</code> to the ''full'' name (e.g. <code>%홍길동</code>).
##* If the surname is longer than one syllable, insert <code>_</code> or space between the surname and the given name (e.g. <code>%선우_진</code> or <code>%선우 진</code>).
## If there is no surname, prepend <code>%_</code> to the name (e.g. <code>%_복남</code>).
# Capitalization for proper noun
#* Prepend <code>^</code> to the proper noun (e.g. <code>^압구정</code>).
# Unpredictable pronunciation (cannot be predicted from the Hangul spelling and regular pronunciation rules)
## Use <code>$</code> for ㄴ-addition (e.g. <code>색$연필</code> [생년필]).
## Otherwise, use <code>@</code> (e.g. <code>손@등</code> [손뜽], <code>웃@어른</code> [우더른], etc.).
# Mandatory hyphen in RR (for separating an administrative unit)
#* Use <code>*</code> (e.g. <code>^양주*군</code>).

; Full guide
{| class="wikitable"
! Symbol !! RR !! MR !! Without symbol !! Note
|-
| rowspan="5" | <code>@</code> || rowspan="2" | N/A || unpredictable tensification<br>(e.g. <code>손@등</code> [손뜽] ''sontŭng'') || 전등 [전등] ''chŏndŭng'' || 싫증 [실쯩] ''siljeung''/''silchŭng'' is automatically handled (i.e. does not need <code>@</code>).
|-
| written 사이시옷 + ㄱ/ㅂ<br>(e.g. <code>바닷@가</code> [바다까~바닫까] ''padakka'') || 옷걸이 [옫꺼리] ''otkŏri'' ||
|-
| colspan="2" | 절음 법칙<br>(e.g. <code>웃@어른</code> [우더른] ''udeoreun''/''udŏrŭn'')<br>also blocks palatalization of ㄷ + 이<br>(e.g. <code>곧@이어</code> [고디어] ''godieo''/''kodiŏ'') || 웃어라 [우서라] ''useora''/''usŏra''<br>해돋이 [해도지] ''haedoji'' || Most 절음 법칙 is automatically applied. For example, words like 맛없다 [마덥따] ''madeopda''/''madŏpta'' do not need <code>@</code>. Manual 절음 법칙 is needed only before the syllabic blocks 아, 어, 에, 엔, 엘, 여, 으, 은, 을, 음, 읍, 의, 이, 인, 일, 임, and 입.
|-
| colspan="2" | ㄴㄹ pronounced [ㄴㄴ]<br>(e.g. <code>음운@론</code> [으문논] ''eumunnon''/''ŭmunnon'') || 난리 [날리] ''nalli'' || rowspan="2" |
|-
| ''k''/''t''/''p'' for ㄱㅎ/ㄷㅎ/ㅂㅎ in words that are not nouns, pronouns, and numerals<br>(e.g. <code>잡@혀</code> [자펴] ''japyeo'') || N/A || 낙하산 ''nakhasan''
|-
| <code>$</code> || colspan="2" | ㄴ-addition<br>(e.g. <code>색$연필</code> [생년필] ''saengnyeonpil''/''saengnyŏnp'il'', <code>물$엿</code> [물렫] ''mullyeot''/''mullyŏt'') || 입양 [이뱡] ''ibyang'' || ㄴ-addition before 윷 and 잎 is automatically applied. For example, words like 가락윷 [가랑뉻] ''garangnyut''/''karangnyut'' and 깻잎 [깬닙] ''kkaennip'' do not need <code>$</code>.
|-
| <code>`</code> || N/A || voicing of syllable-initial ㄱ/ㄷ/ㅂ/ㅈ after a non-Hangul character<br>(e.g. <code>1`번</code> [일번/한번] ''1bŏn'') || 6번 [육뻔/여섣뻔] ''6pŏn'' || only between a non-Hangul character and a Hangul syllabic block beginning with ㄱ/ㄷ/ㅂ/ㅈ<br><br>Currently, the "non-Hangul character" is limited to ASCII digits and alphabet letters (<code>[0-9A-Za-z]</code>). This can be broadened later if needed.
|-
| <code>_</code> || colspan="2" | adds an additional space not in Hangul text || rowspan="5" | ||
|-
| <code>*</code> || colspan="2" | adds an additional hyphen not in Hangul text<br>(e.g. <code>^양주*군</code> ''Yangju-gun'') || needed for a mandatory hyphen (for separating an administrative unit) in RR
|-
| <code>^</code> || colspan="2" | capitalizes the following letter || must be immediately followed by a Hangul syllabic block
|-
| <code>%</code> || colspan="2" | personal name mode || 1. By default, this mode assumes that the first syllabic block is the surname and the remaining syllabic blocks are the given name.<br>(e.g. <code>%홍길동</code> → surname 홍, given name 길동)<br>2. To specify a different segmentation, insert <code>_</code> or space between the components.<br>(e.g. surname 선우 + given name 진: <code>%선우_진</code> or <code>%선우 진</code>)<br>3. For a mononym (personal name that does not have a surname, or any case where only the given name is needed), precede the name with <code>%_</code>.<br>(e.g. <code>%_복남</code>)<br>4. For a surname-only name (personal name that only consists of a surname, or any case where only the surname is needed), if it is<br>4.1. two or more syllables long, <code>_</code> is needed after it.<br>(e.g. <code>%남궁_</code>)<br>4.2. just one syllable long, do not add <code>_</code> after it.<br>(e.g. <code>%최</code>)<br>5. If a personal name is followed by non–personal name text, put the personal name between two <code>%</code>.<br>(e.g. <code>국립 %홍길동% 기념관</code>)<br><br>Note: This mode does '''not''' support<br>1. the "given name + surname" order (e.g. 제임스 홍).<br>2. a name consisting of three or more components.
|-
| <code>\</code> || colspan="2" | escape character<br>(e.g. <code>\@</code> → @) || for outputting literal @, $, etc.
|}