README

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