summaryrefslogtreecommitdiff
path: root/macros/luatex/generic/luatexja/README
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/luatex/generic/luatexja/README
Initial commit
Diffstat (limited to 'macros/luatex/generic/luatexja/README')
-rw-r--r--macros/luatex/generic/luatexja/README90
1 files changed, 90 insertions, 0 deletions
diff --git a/macros/luatex/generic/luatexja/README b/macros/luatex/generic/luatexja/README
new file mode 100644
index 0000000000..ab88e3cb75
--- /dev/null
+++ b/macros/luatex/generic/luatexja/README
@@ -0,0 +1,90 @@
+The LuaTeX-ja Package 20190826.0
+--------------------------------
+Copyright (c) 2011--2019 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/luatexja-en.pdf (en), doc/luatexja-ja.pdf (ja).
+
+LuaTeX-ja is developed on
+ <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.
+ This version of LuaTeX-ja requires
+ - LuaTeX 1.0.0 or later
+ - luaotfload (v2.98 or later recommended)
+ - adobemapping (Adobe CMap files)
+ - everysel package
+ - etoolbox package
+ - ltxcmds package
+ - pdftexcmds package
+ - atbegshi package
+ - filehook package
+ - stfloats package
+ - IPAex fonts (http://ipafont.ipa.go.jp/)
+ Hence this version does not work in TeX Live 2016 (or earlier).
+
+1. If you are using TeX Live 2019 or later, you can install LuaTeX-ja via tlmgr.
+
+2. If you must/want to install manually:
+
+ a. Download the source archive from CTAN,
+ or tagged as 20190826.0 in the Git repository by
+ <http://git.osdn.jp/view?p=luatex-ja/luatexja.git
+ ;a=snapshot;h=refs/tags/20190826.0;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. Process src/ltj-kinsoku_make.tex by (plain) LuaTeX to generate ltj-kinsoku.lua,
+ which stores default "kinsoku" parameters.
+
+ d. Put src/ into your TEXMF tree.
+ An example location is TEXMF/tex/luatex/luatexja.
+
+ If you are updating from old version, you MUST remove it before
+ extracting the new version of LuaTeX-ja.
+
+ e. 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,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
+-----
+* 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} and src/ltj-kinsoku_make.tex are not needed in regular use.
+
+Last commit date: Mon Aug 26 09:29:22 2019 +0900