Editing Template:Ko-rm/doc

{{Documentation/Header}}
{{Lua}}
Template to automate the romanization of Korean text based on the [[Genshin Impact Wiki:Korean]] guidelines.
==Syntax==
{{T|ko-rm|v1=Korean text|v2=capi=include to capitalize everything|v3=sent=include to use sentence case}}
* {{F|^}} will capitalize the following syllable.
* {{F|_}} will decapitalize the following syllable.

;Hyphenation and spacing corrections
* {{F|< >}} can be added to insert a space into the romanization. This should only be used when a space is needed around punctuation. Do not use this to break words into two. For example:
** {{T|ko-rm|…으윽…< >흠.|sent=1|_Y_=1}}
* {{F|<->}} can be added to insert a hyphen into the romanization. For example:
** {{T|ko-rm|나<->의|_Y_=1}}
* {{F|<・: >}} can be used instead of just {{F|・}} to romanize it as a space instead of a spaced hyphen.
** {{T|ko-rm|야곱<・: >머스크|capi=1|_Y_=1}}

;Irregular pronunciation corrections
* {{F|nn}} &mdash; {{T|ko-rm|v1=Korean text|v2=nn=position of the syllable containing ᄅ}} will transcribe the specified intersyllabic "ᆫᄅ" sequence as ''nn'' instead of the default ''ll''. For example:
** {{T|ko-rm|생산량|nn=3|_Y_=1}}
* {{F|ni}} &mdash; {{T|ko-rm|v1=Korean text|v2=ni=position of the syllable containing 이/야/여/요/유}} will add the "ㄴ" to the specified syllable for the "ㄴ addition" rule. For example:
** {{T|ko-rm|옛이야기|ni=2|_Y_=1}}
* {{F|bcred}} &mdash; {{T|ko-rm|v1=Korean text|v2=bcred=position of the syllable containing the batchim to reduce}} will reduce the consonant cluster in the specified syllable or neutralize the batchim in the specified syllable prior to consonant assimilation. This can also be used to block palatalization. For example:
** {{T|ko-rm|값어치|bcred=1|_Y_=1}}
** {{T|ko-rm|맞흥정|bcred=1|_Y_=1}}
** {{T|ko-rm|곧이어|bcred=1|_Y_=1}}
* When counting positions, spaces are included in the count but not punctuation.
* If multiple of each irregularity exists, their positions may be listed with commas. For example:
** {{T|ko-rm|생산량, 곧이어, 생산량, 곧이어|nn=3,11|bcred=5,13|_Y_=1}}

;Given names
* Surround any part of the Korean text with {{F|//}} on both sides for given names to romanize with the exceptions noted in the guidelines. For example:
** {{T|ko-rm|//종려//의 운명의 별|_Y_=1}}

;Numbers
* The reading of numbers can be added into the original text in the format {{F|<number:reading in Hangul>}}. For example:
** {{T|ko-rm|<11:열한>시 <11:십일>분|_Y_=1}}

==Examples==
;Default
{{T|ko-rm|「외눈박이 월드」|_Y_=1}}<br>

;Forced capitalization
{{T|ko-rm|방^랑자|_Y_=1}}<br>

;Title case
{{T|ko-rm|새벽의 어둠|capi=1|_Y_=1}}<br>
{{T|ko-rm|…으윽…< >흠, 유쾌하지 않은 일들이 생각났어|capi=1|_Y_=1}}<br>
{{T|ko-rm|P1=1=속세를 비웃는 백 가지 {{T|tt|자태|姿態|NC=1}}{{T|Sino|ko|NC=1}}|capi=1|let_parse=1}} yields: {{ko-rm|속세를 비웃는 백 가지 {{tt|자태|姿態}}{{Sino|ko}}|capi=1}}

;Sentence case
{{T|ko-rm|…으윽…흠, 유쾌하지 않은 일들이 생각났어|sent=1|_Y_=1}}<br>
{{T|ko-rm|P1=1=속세를 비웃는 백 가지 {{T|tt|자태|姿態|NC=1}}{{T|Sino|ko|NC=1}}|sent=1|let_parse=1}} yields: {{ko-rm|속세를 비웃는 백 가지 {{tt|자태|姿態}}{{Sino|ko}}|sent=1}}<br>
==Template Data==
<!--
Edit the Template Data through the "MANAGE TEMPLATEDATA" button at the top left
--><templatedata>
{
	"params": {
		"1": {
			"label": "Text",
			"description": "Korean text to be romanized.",
			"example": "\"방랑자\"",
			"type": "string",
			"required": true
		},
		"capi": {
			"label": "Title Case",
			"description": "Transform the romanization into title case.",
			"type": "boolean",
			"suggested": true
		},
		"sent": {
			"label": "Sentence Case",
			"description": "Transform the romanization into sentence case.",
			"type": "boolean",
			"suggested": true
		},
		"nn": {
			"label": "ᆫᄅ as nn",
			"description": "Romanize the initial of the specified character as if it were ㄴ.",
			"type": "string",
			"suggested": true
		},
		"ni": {
			"label": "ㄴ Addition",
			"description": "Add a ㄴ before the specified character.",
			"type": "string",
			"suggested": true
		},
		"bcred": {
			"label": "Batchim Reduction",
			"description": "Reduce the batchim of the specified character.",
			"type": "string",
			"suggested": true
		}
	},
	"format": "inline",
	"description": "Template to automate the romanization of Korean text"
}
</templatedata>