summaryrefslogtreecommitdiff
path: root/macros/luatex/generic/luatexko/README
diff options
context:
space:
mode:
Diffstat (limited to 'macros/luatex/generic/luatexko/README')
-rw-r--r--macros/luatex/generic/luatexko/README151
1 files changed, 151 insertions, 0 deletions
diff --git a/macros/luatex/generic/luatexko/README b/macros/luatex/generic/luatexko/README
new file mode 100644
index 0000000000..1284ed2271
--- /dev/null
+++ b/macros/luatex/generic/luatexko/README
@@ -0,0 +1,151 @@
+LuaTeX-ko Package version 2.4 (2019/08/01)
+===========================================
+
+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 packages
+operating on other engines.
+
+LuaTeX version 1.10+ and luaotfload package version 2.96+ are required for
+this package to run.
+
+This package also requires cjk-ko package 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
+------
+
+ Dohyun Kim <nomos at ktug org>
+ Soojin Nam <jsunam at gmail com>
+
+Please report any errors or suggestions to
+or leave messages in the issue tracker at:
+ <http://github.com/dohyunkim/luatexko>
+
+
+Files
+-----
+
+TeXinputs
+
+ luatexko.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. Declares \hangulpunctuations=1 as well.
+
+ [hanja]
+Load Hanja captions. Also apply other settings as [hangul] option does.
+
+
+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.
+
+ \setmainfallbackfont
+ \setsansfallbackfont
+ \setmonofallbackfont
+These fonts are used when the font loaded by \setmainfont,
+\setmainhangulfont, or \setmainhanjafont et. al. does not have Hanja
+glyphs.
+
+In like manner, these commands are available as well:
+
+ \hangulfontspec \newhangulfontfamily \addhangulfontfeature
+ \hanjafontspec \newhanjafontfamily \addhanjafontfeature
+ \fallbackfontspec \newfallbackfontfamily \addfallbackfontfeature
+
+If any of these CJK fonts are not specified, UnBatang/UnDotum TrueType
+fonts will be used for typesetting CJK characters.
+
+
+Hangul Font Options
+-------------------
+
+ [InterHangul=<dimen>]
+Set spacing between Hangul characters.
+
+ [InterLatinCJK=<dimen>]
+Set spacing between CJK and Latin characters.
+
+ [CharRaise=<dimen>]
+Raise CJK characters by <dimen>.
+
+
+Other User Commands
+-------------------
+
+ \hangulpunctuations=<number>
+When <number> is 1 or greater (being default value), latin punctuations
+will be typeset with hangul fonts.
+
+ \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*