summaryrefslogtreecommitdiff
path: root/macros/xetex/generic/xetexko/README
diff options
context:
space:
mode:
Diffstat (limited to 'macros/xetex/generic/xetexko/README')
-rw-r--r--macros/xetex/generic/xetexko/README137
1 files changed, 137 insertions, 0 deletions
diff --git a/macros/xetex/generic/xetexko/README b/macros/xetex/generic/xetexko/README
new file mode 100644
index 0000000000..d50dbd3676
--- /dev/null
+++ b/macros/xetex/generic/xetexko/README
@@ -0,0 +1,137 @@
+XeTeX-ko Package version 2.21 (2018/08/08)
+=========================================
+
+XeTeX-ko is a macro package for Xe(La)TeX which supports typesetting
+Korean documents including Old Hangul texts. Though XeTeX itself
+already has basic facility to typeset Korean texts, this package
+provides some enhanced features for quality products adapted to
+Korean culture.
+
+This package requires cjk-ko package for its full functionality.
+
+
+License
+-------
+This package is licensed under LPPL (LaTeX Project Public License).
+
+See each file for details.
+
+
+Author
+------
+Please report any errors or suggestions to
+ Dohyun Kim <nomos at ktug org>
+or leave messages in the issue tracker at:
+ <http://github.com/dohyunkim/xetexko>
+
+
+Files
+-----
+
+### TeXinputs
+
+ xetexko.sty -> tex/xetex/xetexko/
+ xetexko-font.sty -> tex/xetex/xetexko/
+ xetexko-hanging.sty -> tex/xetex/xetexko/
+ xetexko-josa.sty -> tex/xetex/xetexko/
+ xetexko-space.sty -> tex/xetex/xetexko/
+ xetexko-vertical.sty -> tex/xetex/xetexko/
+ hanja_hangul.tab -> tex/xetex/xetexko/
+ hanjacom_hangul.tab -> tex/xetex/xetexko/
+ hanjaexa_hangul.tab -> tex/xetex/xetexko/
+
+### Documents
+
+ xetexko-doc.pdf -> doc/xetex/xetexko/
+ xetexko-doc.tex -> doc/xetex/xetexko/
+ README (this file) -> doc/xetex/xetexko/
+ ChangeLog -> doc/xetex/xetexko/
+
+
+Loading
+-------
+If you are a LaTeX user, declaring
+
+ \usepackage{xetexko}
+or
+
+ \usepackage{kotex}
+is sufficient to load the package. Notice that kotex.sty is a file
+provided by cjk-ko package.
+
+Under plain TeX:
+
+ \input xetexko.sty
+
+
+Package Options
+---------------
+
+ [hangul]
+Load Hangul captions. Besides, this option also adjusts interline
+spacing.
+
+ [hanja]
+Load Hanja captions. Also adjusts spacing as [hangul] option does.
+
+Note that [unfonts] option is removed starting with v2.10, and so
+Nanum TrueType will be used when no Hangul/Hanja font is declared.
+
+
+Hangul Font Commands
+--------------------
+
+ \setmainhangulfont
+ \setsanshangulfont
+ \setmonohangulfont
+Same as \setmainfont etc. provided by fontspec package, except that
+these affect only Hangul characters and related symbols.
+
+ \setmainhanjafont
+ \setsanshanjafont
+ \setmonohanjafont
+Same as \setmainfont etc. except that these affect only Hanja
+characters.
+
+In like manner, these commands are available as well:
+
+ \hangulfontspec \hanjafontspec
+ \newhangulfontfamily \newhanjafontfamily
+ \addhangulfontfeature \addhanjafontfeature
+
+If \fallbackhanjafont is defined, it is used as a final fallback font.
+
+
+Hangul Font Options
+-------------------
+
+ [InterLatinCJK=<dimen>]
+Set spacing between Hangul/Hanja and Latin characters.
+
+ [InterHangul=<dimen>]
+Set spacing between Hangul characters.
+
+ [PunctRaise=<dimen>]
+Raise Latin fullstop after Hangul character.
+
+See xetexko-doc.pdf for more options.
+
+
+Other User Commands
+-------------------
+
+ \dotemph{...}
+Emphasise Hangul or Hanja by putting dot above.
+
+ \begin{vertical}{<dimen>}
+ \end{vertical}
+This environment makes a vbox vertically typeset. <dimen> is an
+argument to indicate the box height. For vertical typesetting
+of entire document, use the command \verticaltypesetting instead.
+
+ \은 \는 \이 \가 \을 \를 \와 \과 \로 \으로 \라 \이라
+Commands for automatic Josa selection. Unlike those of cjk-ko
+package, these commands work correctly even after Hangul or Hanja.
+
+
+*END of README*