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