README

   1 The LuaTeX-ja Package $VER$
   2 --------------------------------
   3 Copyright (c) 2011--2014 The LuaTeX-ja project
   4 License: modified BSD (see COPYING)
   5
   6 LuaTeX-ja is a macro package for typesetting Japanese documents with LuaTeX.
   7 This package is highly affected by ASCII pTeX engine, but not a porting of it.
   8
   9 Note that this package is still *alpha-stage*; documentations are not complete
  10 and specifications are subject to change. Documentations are located at
  11   doc/luatexja-en.pdf (en), doc/luatexja-ja.pdf (ja).
  12
  13 LuaTeX-ja is developed on
  14   <http://sourceforge.jp/projects/luatex-ja/wiki/FrontPage(en)>.
  15 If you have questions or recognize bugs/have feature requests,
  16 we would like you to create a thread in the forum or a ticket
  17 in the way which SourceForge.JP supplies, via links found in
  18 the page above.
  19
  20
  21 Installation
  22 ------------
  23
  24 0. Please make sure that your TeX distribution is up-to-date.
  25    This version of LuaTeX-ja requires
  26     - LuaTeX beta-0.74.0 or later
  27     - luaotfload v2.2
  28     - luatexbase v0.6
  29    Hence this version does not work in TeX Live 2012 (or earlier).
  30
  31 1. If you are using TeX Live 2013 or later, you can install LuaTeX-ja via tlmgr.
  32
  33 2. If you must/want to install manually:
  34
  35    a. Download the source archive from CTAN,
  36       or tagged as $VER$ in the Git repository by
  37       <http://git.sourceforge.jp/view?p=luatex-ja/luatexja.git
  38                               ;a=snapshot;h=refs/tags/$VER$;sf=tgz>
  39
  40    b1. Extract the archive and process following three files by LuaLaTeX
  41       to generate classes for Japanese typesetting:
  42         src/ltjclasses.ins
  43         src/ltjltxdoc.ins
  44         src/ltjsclasses.ins
  45
  46    b2. Process src/ltj-kinsoku_make.tex by (plain) LuaTeX to generate ltj-kinsoku.lua,
  47       which stores default "kinsoku" parameters.
  48
  49    c. Put src/ into your TEXMF tree.
  50       An example location is TEXMF/tex/luatex/luatexja.
  51
  52       If you are updating from old version, you MUST remove it before
  53       extracting the new version of LuaTeX-ja.
  54
  55    d. You may need to update the filename database, by 'mktexlsr' or something.
  56
  57
  58 Basic Usage
  59 -----------
  60
  61 LuaTeX-ja supports both the plain format and LaTeX2e.
  62 Simply loading luatexja.sty by \input or \usepackage does the minimal setting.
  63
  64 - If you want to create Japanese-based documents, you can consider the use of
  65   ltj{article,book,report}.cls or ltjs{article,book}.cls.
  66 - If you want to use the fontspec package, please load luatexja-fontspec.sty.
  67   It defines control sequences such as \setmainjfont, setsansjfont and
  68   \jfontspec, which can be used for specifying Japanese fonts.
  69
  70 Notes
  71 -----
  72 * This archive contains four .{dtx,ins} pairs:
  73     src/ltjclasses.{ins,dtx},  src/ltjltxdoc.{ins,dtx}
  74     src/ltjsclasses.{ins,dtx}, doc/luatexja.{ins,dtx}
  75   Former three pairs generate class files (see above),
  76   while the latter doc/luatexja.{ins,dtx} generates documentations.
  77   (You will need Kozuka fonts to regenerate documentaion PDFs.)
  78
  79   No .{dtx,ins} pair generates .sty files of LuaTeX-ja package.
  80
  81 * src/*.{ins.dtx} and src/ltj-kinsoku_make.tex are not needed in regular use.
  82
  83 Last commit date: $Format:%cd$