README

   1 The LuaTeX-ja Package $VER$
   2 --------------------------------
   3 Copyright (c) 2011--2020 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.07.0 (or later)
  26     - luaotfload (v3.1 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
  37    Using LuaTeX-ja with LuaHBTeX is not well tested.
  38    One might be able to typeset documents without an error, but with
  39    some unwanted results.
  40
  41 1. If you are using TeX Live 2019, you can install LuaTeX-ja via tlmgr.
  42
  43 2. If you must/want to install manually:
  44
  45    a. Download the source archive from CTAN,
  46       or tagged as $VER$ in the Git repository by
  47       <http://git.osdn.jp/view?p=luatex-ja/luatexja.git
  48                               ;a=snapshot;h=refs/tags/$VER$;sf=tgz>
  49
  50    b. Extract the archive and process following three files by LuaLaTeX
  51       to generate classes for Japanese typesetting:
  52         src/ltjclasses.ins
  53         src/ltjltxdoc.ins
  54         src/ltjsclasses.ins
  55
  56    c. Process src/ltj-kinsoku_make.tex by (plain) LuaTeX to generate ltj-kinsoku.lua,
  57       which stores default "kinsoku" parameters.
  58
  59    d. Put src/ into your TEXMF tree.
  60       An example location is TEXMF/tex/luatex/luatexja.
  61
  62       If you are updating from old version, you MUST remove it before
  63       extracting the new version of LuaTeX-ja.
  64
  65    e. You may need to update the filename database, by mktexlsr (or by another program).
  66
  67
  68 Basic Usage
  69 -----------
  70
  71 LuaTeX-ja supports both the plain format and LaTeX2e.
  72 Simply loading luatexja.sty by \input or \usepackage does the minimal setting.
  73
  74 - If you want to create Japanese-based documents, you can consider the use of
  75   ltj{article,book,report}.cls or ltjs{article,book,report}.cls.
  76 - If you want to use functionality of the fontspec package with Japanese fonts,
  77   load luatexja-fontspec.sty. It defines control sequences such as \setmainjfont,
  78   \setsansjfont and  \jfontspec, which can be used for specifying Japanese fonts.
  79
  80 Notes
  81 -----
  82 * We don't recommend defining a Japanese font with HarfBuzz, by specifying
  83   "Renderer=..." (fontspec) or "mode=harf" (otherwise).
  84
  85 * This archive contains four .{dtx,ins} pairs:
  86     src/ltjclasses.{ins,dtx},  src/ltjltxdoc.{ins,dtx}
  87     src/ltjsclasses.{ins,dtx}, doc/luatexja.{ins,dtx}
  88   Former three pairs generate class files (see above),
  89   while the latter doc/luatexja.{ins,dtx} generates documentations.
  90   (You will need Kozuka fonts to regenerate documentaion PDFs.)
  91
  92   No .{dtx,ins} pair generates .sty files of LuaTeX-ja package.
  93
  94 * src/*.{ins.dtx} and src/ltj-kinsoku_make.tex are not needed in regular use.
  95
  96 Last commit date: $Format:%cd$