Editing Template:Th-rm/doc

{{Documentation/Header}}
{{Lua}}

Template to automate the romanization of Thai text based on the [[Petit Planet Wiki:Thai]] guidelines.

==Syntax==
{{T|th-rm|v1=Thai text|v2=capi=include to capitalize each word|v3=sent=include to use sentence case}}

* The romanization follows the [[Petit Planet Wiki:Thai]] guidelines, which are based on the [[w:Royal Thai General System of Transcription|Royal Thai General System of Transcription]] (RTGS).
* The template is primarily intended as an automatic fallback for the Other languages template. Editors should provide a manual romanization when a name has an irregular or otherwise ambiguous pronunciation.

;Capitalization
* {{F|capi}} can be used to capitalize each word in the romanization. For example:
** {{T|th-rm|สถาบันไทยคดีศึกษา|capi=1|_Y_=1}}
* {{F|sent}} can be used to capitalize the first word and words following sentence-ending punctuation. For example:
** {{T|th-rm|สวัสดีครับ. วันนี้เป็นอย่างไรบ้าง|sent=1|_Y_=1}}

;Hyphenation and spacing corrections
* {{F|< >}} can be added to insert a space into the romanization.
* {{F|<->}} can be added to insert a hyphen into the romanization.
* These corrections should only be used when the automatic romanization cannot determine the desired separation.
* For example:
** {{T|th-rm|สง่า<->งาม|_Y_=1}}

==Examples==
;Default
{{T|th-rm|สง่างาม|_Y_=1}}<br>
{{T|th-rm|ทราย|_Y_=1}}<br>
{{T|th-rm|จริง|_Y_=1}}<br>
{{T|th-rm|ศรี|_Y_=1}}<br>
{{T|th-rm|บุตร|_Y_=1}}<br>
{{T|th-rm|เพชร|_Y_=1}}<br>
{{T|th-rm|ลักษณ์|_Y_=1}}<br>

;Words with spaces
{{T|th-rm|สถาบันไทยคดีศึกษา|_Y_=1}}<br>
{{T|th-rm|โชคชัย จิตงาม|_Y_=1}}<br>

;Forced capitalization
{{T|th-rm|สถาบันไทยคดีศึกษา|capi=1|_Y_=1}}<br>

;Sentence case
{{T|th-rm|สวัสดีครับ. วันนี้เป็นอย่างไรบ้าง|sent=1|_Y_=1}}<br>

;Consonant exceptions
{{T|th-rm|ทราย|_Y_=1}}<br>
{{T|th-rm|ทราบ|_Y_=1}}<br>
{{T|th-rm|ทรง|_Y_=1}}<br>
{{T|th-rm|หนา|_Y_=1}}<br>
{{T|th-rm|หนี|_Y_=1}}<br>
{{T|th-rm|จริง|_Y_=1}}<br>
{{T|th-rm|ศรี|_Y_=1}}<br>

==Notes==
* Thai words normally do not use spaces to separate words. Automatic romanization therefore cannot always determine word boundaries from Thai orthography alone.
* When a manual romanization is supplied to a template using this module as a fallback, the manual romanization should take precedence.
* This module follows the romanization rules described at [[Petit Planet Wiki:Thai]] rather than attempting to provide a phonetic transcription of Thai.

==Template Data==
<!--
Edit the Template Data through the "MANAGE TEMPLATEDATA" button at the top left
--><templatedata>
{
	"params": {
		"1": {
			"label": "Text",
			"description": "Thai 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
		}
	},
	"format": "inline",
	"description": "Template to automate the romanization of Thai text."
}
</templatedata>