summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/xetex/xetexko/README
blob: 75a856429889097d761ca2f9bb485591bfdc283a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
XeTeX-ko Package version 2.17 (2017/09/29)
=========================================

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*