-The LuaTeX-ja Package 20120421.0
+The LuaTeX-ja Package $VER$
--------------------------------
-Copyright (c) 2011--2012 The LuaTeX-ja project
+Copyright (c) 2011--2020 The LuaTeX-ja project
+License: modified BSD (see COPYING)
LuaTeX-ja is a macro package for typesetting Japanese documents with LuaTeX.
This package is highly affected by ASCII pTeX engine, but not a porting of it.
Note that this package is still *alpha-stage*; documentations are not complete
and specifications are subject to change. Documentations are located at
- doc/man-en.pdf (en), doc/man-ja.pdf (ja), doc/manual-zh.pdf (zh).
+ doc/luatexja-en.pdf (en), doc/luatexja-ja.pdf (ja).
LuaTeX-ja is developed on
- <http://sourceforge.jp/projects/luatex-ja/wiki/FrontPage(en)>.
-If you recognise questions/requests or bugs, we would like you to make a
-thread in the forum or a ticket in the bug tracking system for that in the way
-which SourceForge.jp supplies, via links found in the page above.
-
+ <https://osdn.jp/projects/luatex-ja/wiki/FrontPage(en)>.
+If you have questions or recognize bugs/have feature requests,
+we would like you to create a thread in the forum or a ticket
+in the way which OSDN supplies, via links found in the page above.
Installation
------------
-0. Please make sure that your TeX distribution is up-to-date.
- Needed (additional) packages are:
- - xunicode.sty v0.981
- - filehook.sty
-1. If you use TeX Live 2011 or later, you can install LuaTeX-ja via tlmgr.
+0. Please make sure that your TeX distribution is up-to-date.
+ This version of LuaTeX-ja requires
+ - LuaTeX 1.10.0 (or later)
+ - luaotfload (v3.1 or later recommended)
+ - adobemapping (Adobe CMap files)
+ - LaTeX 2020-02-02 patch level 5 or later (if you want to use with LaTeX)
+ - everysel package
+ - etoolbox package
+ - ltxcmds package
+ - pdftexcmds package
+ - atbegshi package
+ - filehook package
+ - stfloats package
+ - Harano Aji fonts (https://github.com/trueroad/HaranoAjiFonts)
+ more specifically, HaranoAjiMincho-Regular and HaranoAjiGothic-Medium
+
+ Using LuaTeX-ja with LuaHBTeX is not well tested.
+ One might be able to typeset documents without an error, but with
+ some unwanted results.
+
+1. If you are using TeX Live 2020, you can install LuaTeX-ja via tlmgr.
+
2. If you must/want to install manually:
- a. Download the source archive from CTAN, or HEAD in the Git repository by
- <http://git.sourceforge.jp/view?p=luatex-ja/luatexja.git
- ;a=snapshot;h=HEAD;sf=tgz>
- b. Extract the archive and put src/ into your TEXMF tree.
+
+ a. Download the source archive from CTAN,
+ or tagged as $VER$ in the Git repository by
+ <http://git.osdn.jp/view?p=luatex-ja/luatexja.git
+ ;a=snapshot;h=refs/tags/$VER$;sf=tgz>
+
+ b. Extract the archive and process following three files by LuaLaTeX
+ to generate classes for Japanese typesetting:
+ src/ltjclasses.ins
+ src/ltjltxdoc.ins
+ src/ltjsclasses.ins
+
+ c. Put src/ into your TEXMF tree.
An example location is TEXMF/tex/luatex/luatexja.
- c. Files in src/no_runtime/ are not used in the regular use,
- so you can remove them.
- d. You may need to update the filename database, by 'mktexlsr' or something.
+
+ If you are updating from old version, you MUST remove it before
+ extracting the new version of LuaTeX-ja.
+
+ d. You may need to update the filename database, by mktexlsr (or by another program).
Basic Usage
LuaTeX-ja supports both the plain format and LaTeX2e.
Simply loading luatexja.sty by \input or \usepackage does the minimal setting.
-- If you want to create Japanese-based documents, you can consider the use of
- ltj{article,book,report}.cls or ltjs{article,book}.cls.
-- If you want to use the fontspec package, please load luatexja-fontspec.sty.
- It defines control sequences such as \setmainjfont, setsansjfont and
- \jfontspec, which can be used for specifying Japanese fonts.
+- If you want to create Japanese-based documents, you can consider the use of
+ ltj{article,book,report}.cls or ltjs{article,book,report}.cls.
+- If you want to use functionality of the fontspec package with Japanese fonts,
+ load luatexja-fontspec.sty. It defines control sequences such as \setmainjfont,
+ \setsansjfont and \jfontspec, which can be used for specifying Japanese fonts.
+
+Notes
+-----
+* We don't recommend defining a Japanese font with HarfBuzz, by specifying
+ "Renderer=..." (fontspec) or "mode=harf" (otherwise).
+
+* This archive contains four .{dtx,ins} pairs:
+ src/ltjclasses.{ins,dtx}, src/ltjltxdoc.{ins,dtx}
+ src/ltjsclasses.{ins,dtx}, doc/luatexja.{ins,dtx}
+ Former three pairs generate class files (see above),
+ while the latter doc/luatexja.{ins,dtx} generates documentations.
+ (You will need Kozuka fonts to regenerate documentaion PDFs.)
+
+ No .{dtx,ins} pair generates .sty files of LuaTeX-ja package.
+
+* src/*.{ins.dtx} are not needed in regular use.
+
+* ltj-kinsoku_make.tex is removed in version 20200808.0.
+ This file and ltj-kinsoku.lua are not used anymore.
+ (Do not remove ltj-kinsoku.tex.)
+Last commit date: $Format:%cd$
OSDN Git Service
