README

   1 The LuaTeX-ja Package $VER$
   2 --------------------------------
   3 Copyright (c) 2011--2015 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     - everysel package
  30     - IPAex fonts (http://ipafont.ipa.go.jp/)
  31    Hence this version does not work in TeX Live 2012 (or earlier).
  32
  33 1. If you are using TeX Live 2013 or later, you can install LuaTeX-ja via tlmgr.
  34
  35 2. If you must/want to install manually:
  36
  37    a. Download the source archive from CTAN,
  38       or tagged as $VER$ in the Git repository by
  39       <http://git.sourceforge.jp/view?p=luatex-ja/luatexja.git
  40                               ;a=snapshot;h=refs/tags/$VER$;sf=tgz>
  41
  42    b1. Extract the archive and process following three files by LuaLaTeX
  43       to generate classes for Japanese typesetting:
  44         src/ltjclasses.ins
  45         src/ltjltxdoc.ins
  46         src/ltjsclasses.ins
  47
  48    b2. Process src/ltj-kinsoku_make.tex by (plain) LuaTeX to generate ltj-kinsoku.lua,
  49       which stores default "kinsoku" parameters.
  50
  51    c. Put src/ into your TEXMF tree.
  52       An example location is TEXMF/tex/luatex/luatexja.
  53
  54       If you are updating from old version, you MUST remove it before
  55       extracting the new version of LuaTeX-ja.
  56
  57    d. You may need to update the filename database, by 'mktexlsr' or something.
  58
  59
  60 Basic Usage
  61 -----------
  62
  63 LuaTeX-ja supports both the plain format and LaTeX2e.
  64 Simply loading luatexja.sty by \input or \usepackage does the minimal setting.
  65
  66 - If you want to create Japanese-based documents, you can consider the use of
  67   ltj{article,book,report}.cls or ltjs{article,book}.cls.
  68 - If you want to use the fontspec package, please load luatexja-fontspec.sty.
  69   It defines control sequences such as \setmainjfont, \setsansjfont and
  70   \jfontspec, which can be used for specifying Japanese fonts.
  71
  72 Notes
  73 -----
  74 * This archive contains four .{dtx,ins} pairs:
  75     src/ltjclasses.{ins,dtx},  src/ltjltxdoc.{ins,dtx}
  76     src/ltjsclasses.{ins,dtx}, doc/luatexja.{ins,dtx}
  77   Former three pairs generate class files (see above),
  78   while the latter doc/luatexja.{ins,dtx} generates documentations.
  79   (You will need Kozuka fonts to regenerate documentaion PDFs.)
  80
  81   No .{dtx,ins} pair generates .sty files of LuaTeX-ja package.
  82
  83 * src/*.{ins.dtx} and src/ltj-kinsoku_make.tex are not needed in regular use.
  84
  85 Last commit date: $Format:%cd$