thaicheck Documentation
Version 1.1

(c) Lyndon Hill, 2007.

Introduction

This is a program to validate Thai text.

More up to date information regarding this program can be found at
http://www.lyndonhill.com/Projects/thaicheck.html

Licence

thaicheck is compiled from original code exclusively owned and controlled by
Lyndon Hill. thaicheck is free, no charge may be made whatsoever for copying,
transferring or distributing. Whenever thaicheck is distributed, this ReadMe.txt
file must be included in it's entirety without modification or addition.

See the thaicheck webpage for downloads.

thaicheck is supplied without any warranty, explicit or implied. Use at your
own risk.

Instructions

* What is thaicheck ?

It's a small program to check Thai letter sequence order in plain text files,
(TIS-620 coding). You run it over your files and it tells you if it finds any
mistakes.

* What is TIS-620 and how can I make sure I am using the right type of
text files ?

TIS-620 is a type of text coding. See my project "thaiconv". You can use thaiconv
 to convert your file to TIS-620, run thaicheck and then convert back to your coding.

* Why do I need thaicheck ?

You need thaicheck if you write Thai text in a text editor or word processor
that does not check you are typing legal letter combinations.

Your software (editor, word processor etc) may let you type bad sequences
and you will not know until you view the file on another
computer/font/editor/web browser etc. At that time, when the text rendering 
part of the software meets your illegal combination it usually chooses one of 
the following:

1. Render it as is.
2. Render an unreadable mess.
3. Render nothing.
4. Crash.
5. Not load your document properly in the first instant.

* How do I use thaicheck ?

Use it at the command line or in a script. The basic usage is

$ thaicheck filename level

where the parameters are given by
 filename: the file you want to check
 level:    level of strictness, as defined by WTT 2.0 standard.

* What level of strictness should I use ?

0 = pass through (next to useless for your purposes)
1 = basic check
2 = strict (default)

In all probabilities, if you are using thaicheck then you are the type of
vigilant person with an eye to detail. Don't bother using level 1 and go
straight to level 2.

If there are no mistakes then thaicheck will finish and there is no output.

12.09.2007 
