Debian Codegraph @

texmf-dist/doc/luatex/luatexko/README

raw
1 LuaTeX-ko Package version 5.7 (2026/02/20)
2 ===========================================
3
4 This is a Lua(La)TeX macro package that supports typesetting Korean
5 documents including Old Hangul texts. As LuaTeX has opened up access to
6 almost all the hidden routines of TeX engine, users can obtain more
7 beautiful outcome using this package rather than other Hangul packages
8 operating on other engines.
9
10 LuaTeX version 1.10+ and luaotfload package version 2.96+ are required for
11 this package to run.
12
13 This package also requires cjk-ko package for its full functionality.
14
15
16 License
17 -------
18
19 This package is licensed under [LPPL](http://latex-project.org/lppl/)
20 (LaTeX Project Public License) version 1.3c or later.
21
22 See each file for details.
23
24
25 Author
26 ------
27
28 Dohyun Kim <nomosnomos at gmail com>
29 Soojin Nam <jsunam at gmail com>
30
31 Please report any errors or suggestions to
32 Dohyun Kim <nomosnomos at gmail com> (current maintainer)
33 or leave messages in the issue tracker at:
34 <http://github.com/dohyunkim/luatexko>
35
36
37 Files
38 -----
39
40 TeXinputs
41
42 luatexko.sty -> tex/luatex/luatexko/
43 luatexko.lua -> tex/luatex/luatexko/
44 luatexko-normalize.lua -> tex/luatex/luatexko/
45 luatexko-uhc2utf8.lua -> tex/luatex/luatexko/
46
47 Documents
48
49 luatexko-doc.pdf -> doc/luatex/luatexko/
50 luatexko-doc.tex -> doc/luatex/luatexko/
51 README (this file) -> doc/luatex/luatexko/
52 ChangeLog -> doc/luatex/luatexko/
53
54
55 Loading
56 -------
57
58 For a LaTeX user, declaring
59
60 \usepackage{luatexko}
61 or
62
63 \usepackage{kotex}
64 is sufficient to load the package, which will load fontspec as well.
65 Notice that kotex.sty is a file provided by cjk-ko package.
66
67 Under plain TeX:
68
69 \input luatexko.sty
70
71
72 Package Options
73 ---------------
74
75 [hangul]
76 Load Hangul captions. Besides, this option adjusts interword and
77 interline spacing. Declares \hangulpunctuations=1 as well.
78
79 [hanja]
80 Load Hanja captions. Also apply other settings as [hangul] option does.
81
82
83 Hangul Font Commands
84 --------------------
85
86 \setmainhangulfont
87 \setsanshangulfont
88 \setmonohangulfont
89 Equivalent to \setmainfont et. al. of fontspec package. These fonts are
90 used when the font loaded by \setmainfont et. al. does not have Hangul
91 glyphs.
92
93 \setmainhanjafont
94 \setsanshanjafont
95 \setmonohanjafont
96 These fonts are used when the font loaded by \setmainfont or
97 \setmainhangulfont et. al. does not have Hanja glyphs.
98
99 \setmainfallbackfont
100 \setsansfallbackfont
101 \setmonofallbackfont
102 These fonts are used when the font loaded by \setmainfont,
103 \setmainhangulfont, or \setmainhanjafont et. al. does not have Hanja
104 glyphs.
105
106 In like manner, these commands are available as well:
107
108 \hangulfontspec \newhangulfontfamily \addhangulfontfeature
109 \hanjafontspec \newhanjafontfamily \addhanjafontfeature
110 \fallbackfontspec \newfallbackfontfamily \addfallbackfontfeature
111
112 If any of these CJK fonts are not specified, UnBatang/UnDotum TrueType
113 fonts will be used for typesetting CJK characters.
114
115
116 Hangul Font Options
117 -------------------
118
119 [InterHangul=<dimen>]
120 Set spacing between Hangul characters.
121
122 [InterLatinCJK=<dimen>]
123 Set spacing between CJK and Latin characters.
124
125 [InterCharacter=<dimen>]
126 Set spacing between CJK characters.
127
128 [InterCharStretch=<dimen>]
129 Set stretching of the glue between CJK characters.
130
131 [InterCharPenalty=<number>]
132 Set the penalty (default: 50) inserted between CJK characters.
133
134 [CharRaise=<dimen>]
135 Raise CJK characters by <dimen>.
136
137 [CompressPunctuations]
138 Make CJK punctuations half-width.
139
140 [RemoveClassicSpaces]
141 Remove spaces between CJK characters for old document.
142
143 Other User Commands
144 -------------------
145
146 \hangulpunctuations=<number>
147 When <number> is 1 or greater (being default value), latin punctuations
148 will be typeset with hangul fonts.
149
150 \dotemph{...}
151 Emphasise Hangul or Hanja by putting dot above.
152
153 \ruby{<base text>}{<ruby text>}
154 Typeset ruby annotations.
155
156 \uline{...}
157 \sout{...}
158 \uuline{...}
159 \xout{...}
160 \uwave{...}
161 \dashuline{...}
162 \dotuline{...}
163 Same functionality as those ulem package provides.
164
165 \typesetclassic
166 Command/environment for typesetting old document in horizontal writing mode.
167
168 \begin{vertical}{<dimen>}
169 \end{vertical}
170 This environment makes a box vertically typeset. <dimen> is an
171 argument to indicate the box height. When the <dimen> is \empty,
172 a box with natural height will result. For vertical writing of
173 entire document, use the command \verticaltypesetting instead.
174
175 \은 \는 \이 \가 \을 \를 \와 \과 \로 \으로 \라 \이라
176 Commands for automatic Josa selection. Unlike those of cjk-ko
177 package, these commands work correctly even after Hangul or Hanja.
178
179 *END of README*