README

   1 The LuaTeX-ja Package $VER$
   2 --------------------------------
   3 Copyright (c) 2011--2024 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://github.com/luatexja/luatexja>.
  15 If you have questions or recognize bugs/have feature requests,
  16 we would like you to create an issue.
  17
  18
  19 Installation
  20 ------------
  21
  22 0. Please make sure that your TeX distribution is up-to-date.
  23    This version of LuaTeX-ja requires
  24     - LuaTeX 1.10.0 (or later)
  25     - luaotfload (v3.1 or later recommended)
  26     - adobemapping (Adobe CMap files)
  27     - LaTeX2e 2020-02-02 patch level 5 or later (if you want to use with LaTeX)
  28     - etoolbox package
  29     - ltxcmds package, pdftexcmds package
  30     - filehook package, atbegshi package (for LaTeX2e 2020-02-02)
  31     - everysel package (for LaTeXe 2020-02-02 and 2020-10-01)
  32     - Harano Aji fonts (https://github.com/trueroad/HaranoAjiFonts)
  33           more specifically, HaranoAjiMincho-Regular and HaranoAjiGothic-Medium
  34
  35    Using LuaTeX-ja with LuaHBTeX is not well tested.
  36    One might be able to typeset documents without an error, but with
  37    some unwanted results.
  38
  39 1. If you are using TeX Live 2021, you can install LuaTeX-ja via tlmgr.
  40
  41 2. If you must/want to install manually:
  42
  43    a. Download the source archive from CTAN,
  44       or tagged as $VER$ in the Git repository by
  45       <https://github.com/luatexja/luatexja/archive/refs/tags/$VER.zip>
  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. Put src/ into your TEXMF tree.
  54       An example location is TEXMF/tex/luatex/luatexja.
  55
  56       If you are updating from old version, you MUST remove it before
  57       extracting the new version of LuaTeX-ja.
  58
  59    d. You may need to update the filename database, by mktexlsr (or by another program).
  60
  61
  62 Basic Usage
  63 -----------
  64
  65 LuaTeX-ja supports both the plain format and LaTeX2e.
  66 Simply loading luatexja.sty by \input or \usepackage does the minimal setting.
  67
  68 - If you want to create Japanese-based documents, you can consider the use of
  69   ltj{article,book,report}.cls or ltjs{article,book,report}.cls.
  70 - If you want to use functionality of the fontspec package with Japanese fonts,
  71   load luatexja-fontspec.sty. It defines control sequences such as \setmainjfont,
  72   \setsansjfont and  \jfontspec, which can be used for specifying Japanese fonts.
  73
  74 Notes
  75 -----
  76 * We don't recommend defining a Japanese font with HarfBuzz, by specifying
  77   "Renderer=..." (fontspec) or "mode=harf" (otherwise).
  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} are not needed in regular use.
  89
  90 * ltj-kinsoku_make.tex is removed in version 20200808.0.
  91   This file and ltj-kinsoku.lua are not used anymore.
  92   (Do not remove ltj-kinsoku.tex.)
  93
  94 Last commit date: $Format:%cd$