summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/luatex/luatexko/README
blob: c7b2f4ae660953f9ea8e7642ba2e4ba487cc59d5 (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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
LuaTeX-ko Package version 1.1 (2013/05/19)
==========================================

This is a Lua(La)TeX macro package that supports typesetting Korean
documents including Old Hangul texts. As LuaTeX has opened up access to
almost all the hidden routines of TeX engine, users can obtain more
beautiful outcome using this package rather than other Hangul macros
operating on other engines. 

Due to the backward-incompatible update of LuaTeX in early 2013, LuaTeX
version 0.76+ and luaotfload package version 2.2+ are required for this
package to run. 

This package also requires both cjk-ko and xetexko packages for its full
functionality.


License
-------

This package is licensed under [LPPL](http://latex-project.org/lppl/)
(LaTeX Project Public License) version 1.3c or later.

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/luatexko>


Files
-----

### TeXinputs

	luatexko.sty		-> tex/luatex/luatexko/
	luatexko-core.sty	-> tex/luatex/luatexko/
	luatexko.lua		-> tex/luatex/luatexko/
	luatexko-normalize.lua	-> tex/luatex/luatexko/
	luatexko-uhc2utf8.lua	-> tex/luatex/luatexko/

### Documents

	luatexko-doc.pdf	-> doc/luatex/luatexko/
	luatexko-doc.tex	-> doc/luatex/luatexko/
	README (this file)	-> doc/luatex/luatexko/
	ChangeLog		-> doc/luatex/luatexko/


Loading
-------

For a LaTeX user, declaring

	\usepackage{luatexko}
or

	\usepackage{kotex}
is sufficient to load the package, which will load fontspec as well.
Notice that kotex.sty is a file provided by cjk-ko package.

Under plain TeX:

	\input luatexko.sty 


Package Options
---------------

	[hangul]
Load Hangul captions. Besides, this option adjusts interword and
interline spacing.

	[hanja]
Load Hanja captions. Also adjusts spacing as [hangul] option does.

	[unfonts]
Load font setting predefined for Un TrueType fonts available at
[this link](http://kldp.net/projects/unfonts/).


Hangul Font Commands
--------------------

	\setmainhangulfont
	\setsanshangulfont
	\setmonohangulfont
Equivalent to \setmainfont et. al. of fontspec package. These fonts are
used when the font loaded by \setmainfont et. al. does not have Hangul
glyphs.

	\setmainhanjafont
	\setsanshanjafont
	\setmonohanjafont
These fonts are used when the font loaded by \setmainfont or
\setmainhangulfont et. al. does not have Hanja glyphs.

In like manner, these commands are available as well:

	\hangulfontspec
	\hanjafontspec
	\newhangulfontfamily
	\newhanjafontfamily
	\addhangulfontfeature
	\addhanjafontfeature


Hangul Font Options
-------------------

	[InterHangul=<dimen>]
Set spacing between Hangul characters.

	[InterLatinCJK=<dimen>]
Set spacing between CJK and Latin characters.

	[PunctRaise=<dimen>]
Raise Latin fullstop and comma after CJK character.

	[QuoteRaise=<dimen>]
Raise Latin quotation marks and parentheses around CJK text.

	[CharRaise=<dimen>]
Raise CJK characters by <dimen>.


Other User Commands
-------------------

	\luatexuhcinputencoding=<number>
When <number> is 1 or greater, UHC (aka. Windows CP949) input encoding
is allowed. <number> 0 restores UTF-8, the default input encoding.

	\dotemph{...}
Emphasise Hangul or Hanja by putting dot above.

	\ruby{<base text>}{<ruby text>}
Typeset ruby annotations.

	\uline{...}
	\sout{...}
	\uuline{...}
	\xout{...}
	\uwave{...}
	\dashuline{...}
	\dotuline{...}
Same functionality as those ulem package provides.


*END of README*