CTAN
Comprehensive TeX Archive Network

Direc­tory macros/luatex/generic/luatexko

README
LuaTeX-ko Package version 1.15 (2016/05/14)
===========================================

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.

LuaTeX version 0.95+ and luaotfload package version 2.7+ 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
------

    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-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. Declares \hangulpunctuations=1 as well.

    [hanja]
Load Hanja captions. Also apply other settings as [hangul] option does.

    [nofontspec]
Prevents loading of fontspec package. Entire document will be typeset
with Type1 fonts.


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, Nanum Type1 fonts from
nanumtype1 package 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
-------------------

    \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.

    \hangulpunctuations=<number>
When <number> is 1 or greater, 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*

Down­load the con­tents of this pack­age in one zip archive (245.3k).

lu­a­texko – Type­set Korean with Lua(La)TeX

This is a Lua(La)TeX macro pack­age that sup­ports type­set­ting Korean doc­u­ments in­clud­ing Old Han­gul texts. As LuaTeX has opened up ac­cess to al­most all the hid­den rou­tines of TeX en­gine, users can ob­tain more beau­ti­ful out­come us­ing this pack­age rather than other Han­gul macros op­er­at­ing on other en­gines.

LuaTeX ver­sion 0.79+ and lu­aot­fload pack­age ver­sion 2.4+ are re­quired for this pack­age to run.

This pack­age also re­quires both cjk-ko and xe­texko pack­ages for its full func­tion­al­ity.

Pack­agelu­a­texko
Ver­sion1.15 2016-05-14
Li­censeThe LaTeX Project Public Li­cense 1.3
Main­tainerDo­hyun Kim
Soo­jin Nam
Con­tained inTeX Live as lu­a­texko
MiKTeX as lu­a­texko
Topics sup­port for type­set­ting Korean
LuaTeX and pack­ages that re­quire it
...
Guest Book Sitemap Contact Contact Author