README

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