summaryrefslogtreecommitdiff
path: root/language/korean/kotex-plain/README
diff options
context:
space:
mode:
Diffstat (limited to 'language/korean/kotex-plain/README')
-rw-r--r--language/korean/kotex-plain/README69
1 files changed, 69 insertions, 0 deletions
diff --git a/language/korean/kotex-plain/README b/language/korean/kotex-plain/README
new file mode 100644
index 0000000000..6749669b6e
--- /dev/null
+++ b/language/korean/kotex-plain/README
@@ -0,0 +1,69 @@
+kotex-plain
+===========
+
+Introduction
+------------
+
+kotex-plain is a package for typesetting Hangul, the native
+alphabet of the Korean language, using plain TeX engine.
+The input Korean text should be encoded in UTF-8.
+kotex-plain belongs to ko.TeX, a comprehensive Korean typesetting
+system together with kotex-utf, kotex-oblivoir, kotex-utils,
+cjk-ko, xetexko, and luatexko.
+
+Files
+-----
+
+### TeXinputs
+
+ kotexplain.tex -> tex/plain/kotex/
+ kotexutf.tex -> tex/plain/kotex/
+ kotexutf-core.tex -> tex/plain/kotex/
+ hangulcweb.tex -> tex/plain/kotex/
+
+### Documents
+
+ README (this file) -> doc/plain/kotex/
+ ChangeLog -> doc/plain/kotex/
+
+Usage
+-----
+
+To typeset Hangul, start your document as follows:
+
+ \input kotexplain
+
+You should use `etex` or `pdftex` commands to compile the document
+since kotex-plain uses e-TeX primitives. Also keep in mind that
+Korean documents needs to be encoded in UTF-8.
+
+To specify Hangul fonts, you can use the following methods:
+
+* `\hfont{outbb}{at 12pt}`: This command set the current Hangul font
+as 12 point bold. This is the most general way of specifying
+Hangul fonts.
+* `\hfontname{outbtb}`: This is equivallent to `\hfont{outbb}{}`, which
+only applies bold typeface to the current font.
+* `\hfontsize{at 12pt}`: This command changes the size of the current
+font as 12 point. Same effect can be achieved by `\hfont{}{at 12pt}`.
+
+To use CWEB system for literate programming, you can use `hangulcweb.tex`
+as follows:
+
+ \input hangulcweb
+
+For more information, please refer to the kotex-utf package documentation
+(written in Korean).
+
+License
+-------
+
+kotex-plain is licensed under the LaTeX Project Public
+License (LPPL) version 1.3c or later.
+
+Contacts
+--------
+
+Please report any errors or suggestions to the package maintainer,
+Kihwang Lee <leekh at ktug org>.
+