OSDN Git Service

Merge branch 'kmaeda-manual' into kitagawa_test
[luatex-ja/luatexja.git] / doc / manual.dtx
1 %#! lualatex -shell-escape manual.ins
2
3 %<en>\documentclass[a4paper,titlepage]{article}
4 %<ja>\documentclass[a4paper,titlepage]{ltjsarticle}
5 \usepackage[margin=20mm,footskip=5mm]{geometry}
6
7 \usepackage{amsmath,amssymb,xcolor,pict2e,multienum,amsthm,float}
8 \usepackage{booktabs,listings,lltjlisting,showexpl,multicol}
9 \usepackage{luatexja-otf}
10 \usepackage{luatexja-fontspec}
11 \usepackage[unicode]{hyperref}
12 \usepackage[all]{xy}
13 \SelectTips{cm}{}
14
15 \DeclareRobustCommand\eTeX{\ensuremath{\varepsilon}-\kern-.125em\TeX}
16 \DeclareRobustCommand\LuaTeX{Lua\TeX}
17 \DeclareRobustCommand\pdfTeX{pdf\TeX}
18 \DeclareRobustCommand\pTeX{p\kern-.05em\TeX}
19 \DeclareRobustCommand\upTeX{up\kern-.05em\TeX}
20 \DeclareRobustCommand\pLaTeX{p\kern-.05em\LaTeX}
21 \DeclareRobustCommand\pLaTeXe{p\kern-.05em\LaTeXe}
22 \DeclareRobustCommand\epTeX{\ensuremath{\varepsilon}-\kern-.125em\pTeX}
23
24 \ltjsetparameter{jacharrange={-3}}
25 \theoremstyle{definition}
26 %<en>\newtheorem{defn}{Definition}
27 %<ja>\newtheorem{defn}{定義}
28
29 \newenvironment{cslist}{%
30   \leftskip2em\parindent=0pt\def\makelabel##1{{\tt\char92##1}}
31   \def\{{\char`\{}\def\}{\char`\}}
32   \let\origitem=\item
33   \def\item[##1]{\par\smallskip\par\hskip-\leftskip\makelabel{##1}\par}
34 }{}
35
36 \makeatletter
37 \long\def\@makecaption#1#2{%
38   \vskip\abovecaptionskip
39   \sbox\@tempboxa{{\small #1. #2}}%
40   \ifdim \wd\@tempboxa >\hsize
41     {\small #1. #2}\par
42   \else
43     \global \@minipagefalse
44     \hb@xt@\hsize{\hfil\box\@tempboxa\hfil}%
45   \fi
46   \vskip\belowcaptionskip}
47 \makeatother
48
49 %<*en>
50 \title{The \LuaTeX-ja package}
51 \author{The \LuaTeX-ja project team}
52 %</en>
53 %<*ja>
54 \title{\LuaTeX-jaパッケージ}
55 \author{\LuaTeX-jaプロジェクトチーム}
56 %</ja>
57
58 \lstset{
59   basicstyle=\ttfamily\small, pos=o, breaklines=true,
60   numbers=none, rframe={}, basewidth=0.5em
61 }
62
63 \parskip=\smallskipamount
64 \protected\def\Param#1{\textsf{#1}} % parameter name
65 \protected\def\Pkg#1{\underline{\smash{\texttt{#1}}}} % packages/classes
66
67 \begin{document}
68 \catcode`\<=13
69 \def<#1>{{\normalfont\rm\itshape$\langle$#1$\rangle$}}
70 \maketitle
71
72 \tableofcontents
73 \bigskip
74
75 %<*en>
76 \textbf{This documentation is far from complete. It may have many
77 grammatical (and contextual) errors.}
78 %</en>
79 %<*ja>
80 \textbf{\large 本ドキュメントはまだまだ未完成です.}
81 %</ja>
82
83 \clearpage
84 %<en>\part{User's manual}
85 %<ja>\part{ユーザーズマニュアル}
86
87 %<en>\section{Introduction}
88 %<ja>\section{はじめに}
89
90 %<*en>
91 The \LuaTeX-ja package is a macro package for typesetting high-quality
92 Japanese documents when using \LuaTeX.
93 %</en>
94 %<*ja>
95 \LuaTeX-jaパッケージは,次世代標準\TeX である\LuaTeX の上で,\pTeX と同等
96 /それ以上の品質の日本語組版を実現させようとするマクロパッケージである.
97 %</ja>
98
99 %<en>\subsection{Backgrounds}
100 %<ja>\subsection{背景}
101
102 %<*en>
103 Traditionally, ASCII \pTeX, an extension of \TeX, and its derivatives
104 are used to typeset Japanese documents in \TeX. \pTeX\ is an engine
105 extension of \TeX: so it can produce high-quality Japanese documents
106 without using very complicated macros. But this point is a mixed
107 blessing: \pTeX\ is left behind from other extensions of \TeX,
108 especially \eTeX\ and \pdfTeX, and from changes about
109 Japanese processing in computers (\textit{e.g.}, the UTF-8 encoding).
110 %</en>
111 %<*ja>
112 従来,「\TeX を用いて日本語組版を行う」といったとき,エンジンとしては
113 ASCII \pTeX やそれの拡張物が用いられることが一般的であった.\pTeX は\TeX
114 のエンジン拡張であり,(少々仕様上不便な点はあるものの)商業印刷の分野に
115 も用いられるほどの高品質な日本語組版を可能としている.だが,それは弱点に
116 もなってしまった:\pTeX という(組版的に)満足なものがあったため,海外で
117 行われている数々の\TeX の拡張──例えば\eTeX や\pdfTeX ──や,TrueType,
118 OpenType, Unicodeといった計算機で日本語を扱う際の状況の変化に追従すること
119 を怠ってしまったのだ.
120 %</ja>
121
122 %<*en>
123 Recently extensions of \pTeX, namely \upTeX\ (Unicode-implementation
124 of \pTeX) and \epTeX\ (merging of \pTeX\ and
125 \eTeX\ extension), have developed to fill those gaps to some
126 extent, but gaps still exist.
127 %</en>
128 %<*ja>
129 ここ数年,若干状況は改善されてきた.現在手に入る大半の\pTeX バイナリでは
130 外部UTF-8入力が利用可能となり,さらにUnicode化を推進し,\pTeX の内部処理
131 までUnicode化した\upTeX も開発されている.また,\pTeX に\eTeX 拡張をマー
132 ジした\epTeX も登場し,\TeX\ Live\ 2011では\pLaTeX が\epTeX の上で動作す
133 るようになった.だが,\pdfTeX 拡張(PDF 直接出力やmicro-typesetting)を
134 \pTeX に対応させようという動きはなく,海外とのgapは未だにあるのが現状であ
135 る.
136 %</ja>
137
138 %<*en>
139 However, the appearance of \LuaTeX\ changed the whole situation. With
140 using Lua `callbacks', users can customize the internal processing of
141 \LuaTeX. So there is no need to modify sources of engines to
142 support Japanese typesetting: to do this, we only have to write Lua
143 scripts for appropriate callbacks.
144 %</en>
145 %<*ja>
146 しかし,\LuaTeX の登場で,状況は大きく変わることになった.Luaコードで
147 `callback'を書くことにより,\LuaTeX の内部処理に割り込みをかけることが可
148 能となった.これは,エンジン拡張という真似をしなくても,Luaコードとそれに
149 関する\TeX マクロを書けば,エンジン拡張とほぼ同程度のことができるようになっ
150 たということを意味する.\LuaTeX-jaは,このアプローチによってLuaコード・
151 \TeX マクロによって日本語組版を\LuaTeX の上で実現させようという目的で開発
152 が始まったパッケージである.
153 %</ja>
154
155 %<en>\subsection{Major Changes from \pTeX}
156 %<ja>\subsection{\pTeX からの主な変更点}
157
158 %<*en>
159 The \LuaTeX-ja package is under much influence of \pTeX\ engine. The initial
160 target of development was to implement features of \pTeX. However,
161 \emph{\LuaTeX-ja is not a just porting of \pTeX; unnatural
162 specifications/behaviors of \pTeX\ were not adopted}.
163 %</en>
164 %<*ja>
165 \LuaTeX-jaは,\pTeX に多大な影響を受けている.初期の開発目標は,\pTeX の機
166 能をLuaコードにより実装することであった.しかし,開発が進むにつれ,\pTeX
167 の完全な移植は不可能であり,また\pTeX における実装がいささか不可解になっ
168 ているような状況も発見された.そのため,\textbf{\LuaTeX-ja は,もはや
169 \pTeX の完全な移植は目標とはしない.\pTeX における不自然な仕様・挙動があ
170 れば,そこは積極的に改める.}
171 %</ja>
172
173 %<*en>
174 The followings are major changes from \pTeX:
175 %</en>
176 %<*ja>
177 以下は \pTeX からの主な変更点である.
178 %</ja>
179
180 \begin{itemize}
181 %<*en>
182 \item A Japanese font is a tuple of a `real' font, a Japanese font
183       metric (\textbf{JFM}, for short), and an optional string called
184       `variation'.
185 %</en>
186 %<*ja>
187 \item 和文フォントは「実際の」フォント,和文フォントメトリック(JFM と呼ぶ),そ
188       して `variation' と呼ばれる文字列の組である.
189 %</ja>
190
191 %<*en>
192 \item In \pTeX, a line break after Japanese character is ignored (and
193       doesn't yield a space), since line breaks (in source files) are
194       permitted almost everywhere in Japanese texts. However, \LuaTeX-ja
195       doesn't have this function completely, because of a specification
196       of \LuaTeX.
197 %</en>
198 %<*ja>
199 \item 日本語の文書中では改行はほとんどどこでも許されるので,\pTeX では和文文字
200       直後の改行は無視される(スペースが入らない)ようになっていた.しかし,
201       \LuaTeX-ja では \LuaTeX の仕様のためにこの機能は完全には実装されていない.
202 %</ja>
203
204 %<*en>
205 \item The insertion process of glues/kerns between two Japanese
206       characters and between a Japanese character and other characters
207       (we refer these glues/kerns as \textbf{JAglue}) is rewritten from
208       scratch.
209 %</en>
210 %<*ja>
211 \item 2つの和文文字の間,和文文字と欧文文字の間に入るグルー/カーン
212       (\textbf{JAglue} と呼ぶ)の挿入処理が0から書き直されている.
213 %</ja>
214
215 \begin{itemize}
216 %<*en>
217 \item As \LuaTeX's internal character handling is `node-based'
218       (\textit{e.g.}, \verb+of{}fice+ doesn't prevent ligatures), the
219       insertion process of \textbf{JAglue} is now `node-based'.
220 %</en>
221 %<*ja>
222 \item \LuaTeX の内部での文字の扱いが「ノードベース」になっているように(例えば,
223       \verb+of{}fice+ で合字は抑制されない),\textbf{JAglue} の挿入処理も
224       「ノードベース」である.
225 %</ja>
226
227 %<*en>
228 \item Furthermore, nodes between two characters which have no effects in
229       line break (\textit{e.g.}, \verb+\special+ node) and kerns from
230       italic correction are ignored in the insertion process.
231 %</en>
232 %<*ja>
233 \item さらに,2つの文字の間にある行末では効果を持たないノード(例えば
234       \verb+\special+ ノード)や,イタリック補正に伴い挿入されるカーンは
235       挿入処理中では無視される.
236 %</ja>
237
238 %<*en>
239 \item \emph{Caution: due to above two points, many methods which did the
240       dividing the process of the insertion of \textbf{JAglue} in \pTeX\ are not
241       effective anymore.} In concrete terms, the following two methods are not effective anymore:
242 %</en>
243 %<*ja>
244 \item \textbf{注意:上の2つの変更により,従来 \textbf{JAglue} の挿入処理を分断するのに
245       使われていたいくつかの方法は用いることができない.具体的には,次の方法はもはや無効である:}
246 %</ja>
247 \begin{verbatim}
248   ちょ{}っと  ちょ\/っと
249 \end{verbatim}
250 %<*en>
251       If you want to do so, please put an empty hbox between it instead:
252 %</en>
253 %<*ja>
254       もし同じことをやりたければ,空のhboxを間に挟めばよい:
255 %</ja>
256 \begin{verbatim}
257   ちょ\hbox{}っと
258 \end{verbatim}
259
260
261 %<*en>
262 \item In the process, two Japanese fonts which only differ in their `real'
263       fonts are identified.
264 %</en>
265 %<*ja>
266 \item 処理中では,2つの和文フォントは,「実際の」フォントのみが異なる場合に同一視
267       される.
268 %</ja>
269 \end{itemize}
270
271 %<*en>
272 \item At the present, vertical typesetting (\emph{tategaki}), is not
273       supported in \LuaTeX-ja.
274 %</en>
275 %<*ja>
276 \item 現時点では,縦書きは \LuaTeX-ja ではサポートされていない.
277 %</ja>
278
279 \end{itemize} 
280
281 %<*en>
282 For detailed information, see Part~\ref{part-imp}.
283 %</en>
284 %<*ja>
285 詳細については第 \ref{part-imp} 部を見よ.
286 %</ja>
287
288 %<en>\subsection{Notations}
289 %<ja>\subsection{用語と記法}
290
291 %<*en>
292 In this document, the following terms and notations are used:
293 %</en>
294 %<*ja>
295 本ドキュメントでは,以下の用語と記法を用いる:
296 %</ja>
297
298 \begin{itemize}
299 %<*en>
300 \item Characters are divided into two types: 
301 %</en>
302 %<*ja>
303 \item 文字は2種類に分けられる:
304 %</ja>
305 \begin{itemize}
306 %<*en>
307 \item \textbf{JAchar}: standing for Japanese characters such as
308       Hiragana, Katakana, Kanji and other punctuation marks for
309       Japanese.
310 %</en>
311 %<*ja>
312 \item \textbf{JAchar}: ひらがな,カタカナ,漢字,和文用の約物といった和文文字の
313       ことを指す.
314 %</ja>
315
316 %<*en>
317 \item \textbf{ALchar}: standing for all other characters like alphabets. 
318 %</en>
319 %<*ja>
320 \item \textbf{ALchar}: アルファベットを始めとする,その他全ての文字を指す.
321 %</ja>
322 \end{itemize}
323
324 %<*en>
325 We say `alphabetic fonts' for fonts used in \textbf{ALchar}, and `Japanese fonts' for fonts used in \textbf{JAchar}.
326 %</en>
327 %<*ja>
328 そして,\textbf{ALchar} の出力に用いられるフォントを「欧文フォント」と呼び,
329 \textbf{JAchar} の出力に用いられるフォントを「和文フォント」と呼ぶ.
330 %</ja>
331
332 %<*en>
333 \item A word in a sans-serif font (like \Param{prebreakpenalty})
334       means an internal parameter for Japanese typesetting, and it
335       is used as a key in \verb+\ltjsetparameter+ command.
336 %</en>
337 %<*ja>
338 \item サンセリフ体で書かれた語(例:\Param{prebreakpenalty})は日本語組版用の
339       パラメータを表し,これらは \verb+\ltjsetparameter+ コマンドのキーとして
340       用いられる.
341 %</ja>
342
343 %<*en>
344 \item A word in typewriter font with underline (like \Pkg{fontspec})
345       means a package or a class of \LaTeX.
346 %</en>
347 %<*ja>
348 \item 下線付きのタイプライタ体で書かれた語(例:\Pkg{fontspec})は \LaTeX の
349       パッケージやクラスを表す.
350 %</ja>
351
352 %<*en>
353 \item The word `primitive' is used not only for primitives in \LuaTeX,
354       but also for control sequences that defined in the core module of
355       \LuaTeX-ja.
356 %</en>
357 %<*ja>
358 \item 「プリミティブ」という語を,\LuaTeX のプリミティブだけではなく \LuaTeX-ja
359       のコアモジュールで定義されたコントロールシーケンスに対しても用いる.
360 %</ja>
361
362 %<*en>
363 \item In this document, natural numbers start from~0.
364 %</en>
365 %<*ja>
366 \item 本ドキュメントでは,自然数は0から始まる.
367 %</ja>
368 \end{itemize}
369
370 %<en>\subsection{About the project}
371 %<ja>\subsection{プロジェクトについて}
372
373 %<*en>
374 \paragraph{Project Wiki} Project Wiki is under construction.
375 %</en>
376 %<*ja>
377 \paragraph{プロジェクト Wiki} プロジェクト Wiki は構築中である.
378 %</ja>
379
380 %<*en>
381 \begin{itemize}
382 \item \url{http://sourceforge.jp/projects/luatex-ja/wiki/FrontPage%28en%29} (English)
383 \item \url{http://sourceforge.jp/projects/luatex-ja/wiki/FrontPage} (Japanese)
384 \end{itemize}
385 %</en>
386 %<*ja>
387 \begin{itemize}
388 \item \url{http://sourceforge.jp/projects/luatex-ja/wiki/FrontPage}(日本語)
389 \item \url{http://sourceforge.jp/projects/luatex-ja/wiki/FrontPage%28en%29}(英語)
390 \end{itemize}
391 %</ja>
392
393 %<*en>
394 This project is hosted by SourceForge.JP.
395 %</en>
396 %<*ja>
397 本プロジェクトは SourceForge.JP のサービスを用いて運営されている.
398 %</ja>
399
400 %<en>\paragraph{Members}\ 
401 %<ja>\paragraph{開発メンバー}\ 
402 %<*en>
403 \begin{multienumerate}
404 \def\labelenumi{$\bullet$}
405 \mitemxxx{Hironori KITAGAWA}{Kazuki MAEDA}{Takayuki YATO}
406 \mitemxxx{Yusuke KUROKI}{Noriyuki ABE}{Munehiro YAMAMOTO}
407 \mitemxxo{Tomoaki HONDA}{Shuzaburo SAITO}
408 \end{multienumerate}
409 %</en>
410 %<*ja>
411 \begin{multienumerate}
412 \def\labelenumi{$\bullet$}
413 \mitemxxx{北川 弘典}{前田 一貴}{八登 崇之}
414 \mitemxxx{黒木 裕介}{阿部 紀行}{山本 宗宏}
415 \mitemxxo{本田 知亮}{齋藤 修三郎}
416 \end{multienumerate}
417 %</ja>
418
419
420 % \paragraph{Acknowledgments} -- 挿入するならここ
421
422 \clearpage
423 %<en>\section{Getting Started}
424 %<ja>\section{使い方}
425 %<en>\subsection{Installation}
426 %<ja>\subsection{インストール}
427
428 %<*en>
429 To install the \LuaTeX-ja\ package, you will need:
430 %</en>
431 %<*ja>
432 \LuaTeX-ja パッケージのインストールには,次のものが必要である.
433 %</ja>
434 \begin{itemize}
435 %<*en>
436 \item \LuaTeX\ (version 0.65.0-beta or later) and its supporting packages.\\
437 If you are using \TeX~Live~2011 or current W32\TeX, you don't have to worry.
438 %</en>
439 %<*ja>
440 \item \LuaTeX(バージョン 0.65.0-beta 以降)とその支援パッケージ.
441       \TeX~Live~2011 や W32\TeX の最新版ならば問題ない.
442 %</ja>
443 %<*en>
444 \item The source archive of \LuaTeX-ja, of course\texttt{:)}
445 %</en>
446 %<*ja>
447 \item \LuaTeX-ja のソースアーカイブ(もちろん \texttt{:)}).
448 %</ja>
449 \end{itemize}
450
451 %<*en>
452 The installation methods are as follows:
453 %</en>
454 %<*ja>
455 インストール方法は以下のようになる:
456 %</ja>
457 \begin{enumerate}
458 %<*en>
459 \item Download the source archive.
460
461       At the present, \LuaTeX-ja has no official release, so you have to retrieve
462       the archive from the repository.
463       You can retrieve the Git repository via
464 %</en>
465 %<*ja>
466 \item ソースアーカイブをダウンロードする.
467
468       現時点では,\LuaTeX-ja の公式リリースはないので,レポジトリからアーカイブを
469       取得しなければならない.
470       次のようにすることで,Git レポジトリを取得することができる:
471 %</ja>
472 \begin{verbatim}
473 $ git clone git://git.sourceforge.jp/gitroot/luatex-ja/luatexja.git
474 \end{verbatim} 
475 %<*en>
476       or download the archive of HEAD in \texttt{master} branch from
477 %</en>
478 %<*ja>
479       もしくは,\texttt{master} ブランチの HEAD アーカイブを以下からダウンロードすることができる:
480 %</ja>
481 \begin{flushleft}
482 \url{http://git.sourceforge.jp/view?p=luatex-ja/luatexja.git;a=snapshot;h=HEAD;sf=tgz}.
483 \end{flushleft}
484
485 %<*en>
486 Note that the forefront of development may not be in \texttt{master} branch.
487 %</en>
488 %<*ja>
489 開発中の最新の成果は \texttt{master} ブランチには含まれていないかもしれないことに注意.
490 %</ja>
491
492 %<*en>
493 \item Extract the archive. You will see \texttt{src/} and several other sub-directories.
494 %</en>
495 %<*ja>
496 \item アーカイブを展開する.\texttt{src/} をはじめとしたいくつかのディレクトリができる.
497 %</ja>
498
499 %<*en>
500 \item Copy all the contents of \texttt{src/} into one of your \texttt{TEXMF} tree.
501 %</en>
502 %<*ja>
503 \item \texttt{src/} の中身全てを自分の \texttt{TEXMF} ツリーにコピーする.
504 %</ja>
505
506 %<*en>
507 \item If \texttt{mktexlsr} is needed to update the file name database, make it so.
508 %</en>
509 %<*ja>
510 \item もし \texttt{mktexlsr} を実行する必要があればそうする.
511 %</ja>
512 \end{enumerate}
513
514 %<en>\subsection{Cautions}
515 %<ja>\subsection{注意点}
516
517 \begin{itemize}
518 %<*en>
519 \item The encoding of your source file must be UTF-8. No other
520       encodings, such as EUC-JP or Shift-JIS, are not supported.
521 %</en>
522 %<*ja>
523 \item 原稿のソースファイルの文字コードは UTF-8 でなければならない.
524       EUC-JP や Shift-JIS は使用できない.
525 %</ja>
526
527 %<*en>
528 \item May be conflict with other packages. 
529
530       For example, the default setting of \textbf{JAchar} in the present
531       version does not coexist with the \Pkg{unicode-math}
532       package. Putting the following line in preamble makes that
533       mathematical symbols will be typeset correctly, but several
534       Japanese characters will be treated as an \textbf{ALchar} as
535       side-effect:
536 %</en>
537 %<*ja>
538 \item いくつかのパッケージと衝突する.
539
540       例えば,\textbf{JAchar} の範囲の設定がデフォルトのままだと,現行の
541       バージョンでは \Pkg{unicode-math} パッケージと共存できない.
542       以下の行をプリアンブルに追加することで数学記号が正しく出るように
543       なるが,副作用としていくつかの和文文字が \textbf{ALchar} として
544       扱われるようになってしまう:
545 %</ja>
546 \begin{verbatim}
547 \ltjsetparameter{jacharrange={-3, -8}}
548 \end{verbatim}
549 \end{itemize}
550
551 %<en>\subsection{Using in plain \TeX}
552 %<ja>\subsection{plain \TeX で使う}
553 \label{ssec-plain}
554
555 %<*en>
556 To use \LuaTeX-ja in plain \TeX, simply put the following at the beginning of the document:
557 %</en>
558 %<*ja>
559 \LuaTeX-ja を plain \TeX で使うためには,単に次の行をソースファイルの冒頭に追加すればよい:
560 %</ja>
561 \begin{verbatim}
562 \input luatexja.sty
563 \end{verbatim}
564 %<*en>
565 This does minimal settings (like \texttt{ptex.tex}) for typesetting Japanese documents:
566 %</en>
567 %<*ja>
568 これで(\texttt{ptex.tex} のように)日本語組版のための最低限の設定がなされる:
569 %</ja>
570
571 \begin{itemize}
572 %<*en>
573 \item The following 6~Japanese fonts are preloaded:
574 \begin{center}
575 \begin{tabular}{ccccc}
576 \toprule
577 \textbf{classification}&\textbf{font name}&\bf `10\,pt'&\bf`7\,pt'&\bf`5\,pt'\\\midrule
578 \emph{mincho}&Ryumin-Light    &\verb+\tenmin+&\verb+\sevenmin+&\verb+\fivemin+\\
579 \emph{gothic}&GothicBBB-Medium&\verb+\tengt+ &\verb+\sevengt+ &\verb+\fivegt+\\
580 \bottomrule
581 \end{tabular}
582 \end{center}
583 %</en>
584 %<*ja>
585 \item 以下の6つの和文フォントが定義される:
586 \begin{center}
587 \begin{tabular}{ccccc}
588 \toprule
589 \textbf{字体}&\textbf{フォント名}&\bf `10\,pt'&\bf`7\,pt'&\bf`5\,pt'\\\midrule
590 \emph{明朝体}&Ryumin-Light    &\verb+\tenmin+&\verb+\sevenmin+&\verb+\fivemin+\\
591 \emph{ゴシック体}&GothicBBB-Medium&\verb+\tengt+ &\verb+\sevengt+ &\verb+\fivegt+\\
592 \bottomrule
593 \end{tabular}
594 \end{center}
595 %</ja>
596 \begin{itemize}
597 %<*en>
598 \item The `Q(級)' is a unit used in Japanese phototypesetting, and
599       $1\,\textrm{Q}=0.25\,\textrm{mm}$. This length is stored in a
600       dimension \verb+\jQ+.
601 %</en>
602 %<*ja>
603 \item `Q(級)' は日本の写植で用いられる単位で,$1\,\textrm{Q}=0.25\,\textrm{mm}$
604       である.この長さは \verb+\jQ+ に保持されている.
605 %</ja>
606
607 %<*en>
608 \item It is widely accepted that the font `Ryumin-Light' and
609       `GothicBBB-Medium' aren't embedded into PDF files, and PDF reader
610       substitute them by some external Japanese fonts (\textit{e.g.},
611       Kozuka Mincho is used for Ryumin-Light in Adobe Reader). We adopt this custom to
612       the default setting.
613 %</en>
614 %<*ja>
615 \item `Ryumin-Light' と `GothicBBB-Medium' は PDF ファイルに埋め込まずに
616       名前参照のみで用いることが広く受け入れられており,この場合 PDF リーダーが
617       適切な外部フォントで代用する(例えば,Adobe Reader では Ryumin-Light は
618       小塚明朝で代替される).そこで,これらをデフォルトのフォントと
619       して採用する.
620 %</ja>
621
622 %<*en>
623 \item A character in an alphabetic font is generally smaller than a
624       Japanese font in the same size. So actual size specification of
625       these Japanese fonts is in fact smaller than that of alphabetic
626       fonts, namely scaled by 0.962216.
627 %</en>
628 %<*ja>
629 \item 欧文フォントの文字は和文フォントの文字よりも,同じ文字サイズでも
630       一般に小さい.そこで,これらの和文フォントの実際のサイズは指定された値よりも
631       小さくなるように設定されており,具体的には指定の 0.962216 倍にスケールされる.
632 %</ja>
633 \end{itemize}
634
635 %<*en>
636 \item The amount of glue that are inserted between a \textbf{JAchar} and
637       an \textbf{ALchar} (the parameter \Param{xkanjiskip}) is set to
638 %</en>
639 %<*ja>
640 \item \textbf{JAchar} と \textbf{ALchar} の間に入るグルー (\Param{xkanjiskip}) の
641       量は次のように設定されている:
642 %</ja>
643 \[
644  (0.25\cdot 0.962216\cdot 10\,\mathrm{pt})^{+1\,\text{pt}}_{-1\,\text{pt}} 
645  = 2.40554\,\mathrm{pt}^{+1\,\text{pt}}_{-1\,\text{pt}}.
646 \]
647 \end{itemize}
648
649 %<en>\subsection{Using in \LaTeX}
650 %<ja>\subsection{\LaTeX で使う}
651 \label{ssec-ltx}
652
653 \paragraph{\LaTeXe}
654
655 %<*en>
656 Using in \LaTeXe\ is basically same. To set up the minimal environment
657 for Japanese, you only have to load \texttt{luatexja.sty}:
658 %</en>
659 %<*ja>
660 \LaTeXe を用いる場合も基本的には同じである.日本語組版のための最低限の環境を
661 設定するためには,\texttt{luatexja.sty} を読み込むだけでよい:
662 %</ja>
663 \begin{verbatim}
664 \usepackage{luatexja}
665 \end{verbatim}
666 %<*en>
667 It also does minimal settings (counterparts in \pLaTeX\ are \texttt{
668 plfonts.dtx} and \texttt{pldefs.ltx}):
669 %</en>
670 %<*ja>
671 これで \pLaTeX の \texttt{plfonts.dtx} と \texttt{pldefs.ltx} に相当する最低限の設定が
672 なされる:
673 %</ja>
674
675 \begin{itemize}
676 %<*en>
677 \item \texttt{JY3} is the font encoding for Japanese fonts (in horizontal direction).\\
678 When vertical typesetting is supported by \LuaTeX-ja in the future, \texttt{JT3} will be used for vertical fonts.
679 %</en>
680 %<*ja>
681 \item \texttt{JY3} は和文フォント用のフォントエンコーディングである(横書き用).\\
682 将来的に,\LuaTeX-ja で縦書きがサポートされる際には,\texttt{JT3} を縦書き用として
683 用いる予定である.
684 %</ja>
685
686 %<*en>
687 \item Two font families \texttt{mc} and \texttt{gt} are defined: 
688 \begin{center}
689 \begin{tabular}{ccccc}
690 \toprule
691 \textbf{classification}&\textbf{family}&\verb+\mdseries+&\verb+\bfseries+&\textbf{scale}\\\midrule
692 \emph{mincho}&\tt mc&Ryumin-Light    &GothicBBB-Medium&0.962216\\
693 \emph{gothic}&\tt gt&GothicBBB-Medium&GothicBBB-Medium&0.962216\\
694 \bottomrule
695 \end{tabular}
696 \end{center}
697 Remark that the bold series in both family are same as the medium series of \emph{gothic} family.
698 This is a convention in \pLaTeX. This is a trace that there were only 2~fonts (these are Ryumin-Light 
699 and GothicBBB-Medium) in early years of DTP.
700 %</en>
701 %<*ja>
702 \item 2つのフォントファミリ \texttt{mc} と \texttt{gt} が定義されている:
703 \begin{center}
704 \begin{tabular}{ccccc}
705 \toprule
706 \textbf{字体}&\textbf{ファミリ}&\verb+\mdseries+&\verb+\bfseries+&\textbf{スケール}\\\midrule
707 明朝体&\tt mc&Ryumin-Light    &GothicBBB-Medium&0.962216\\
708 ゴシック体&\tt gt&GothicBBB-Medium&GothicBBB-Medium&0.962216\\
709 \bottomrule
710 \end{tabular}
711 \end{center}
712 どちらのファミリにおいても,その bold シリーズはゴシック体の medium シリーズで
713 あることに注意.これは初期の DTP において和文フォントが2つ(それがちょうど\ 
714 Ryumin-Light, GothicBBB-Medium だった)しか利用できなかった時の名残であり,\pLaTeX{}
715 での標準設定とも同じである.
716 %</ja>
717
718 %<*en>
719 \item Japanese characters in math mode are typeset by the font family \texttt{mc}.
720 %</en>
721 %<*ja>
722 \item 数式モード中の和文文字は \texttt{mc} ファミリで出力される.
723 %</ja>
724 \end{itemize}
725
726 %<*en>
727 However, above settings are not sufficient for Japanese-based
728 documents. To typeset Japanese-based documents, you are better to use
729 class files other than \texttt{article.cls}, \texttt{book.cls}, and so on.  At
730 the present, we have the counterparts of \Pkg{jclasses} (standard
731 classes in \pLaTeX) and \Pkg{jsclasses} (classes by Haruhiko
732 Okumura), namely, \Pkg{ltjclasses} and \Pkg{ltjsclasses}.
733 %</en>
734 %<*ja>
735 しかしながら,上記の設定は日本語の文書にとって十分とは言えない.
736 日本語文書を組版するためには,\texttt{article.cls}, \texttt{book.cls} といった
737 欧文用のクラスファイルではなく,和文用のクラスファイルを用いた方がよい.
738 現時点では,\Pkg{jclasses} (\pLaTeX の標準クラス)と \Pkg{jsclasses}
739 (奥村晴彦氏によるクラスファイル)に対応するものとして,\Pkg{ltjclasses},
740 \Pkg{ltjsclasses} がそれぞれ用意されている.
741 %</ja>
742
743 %<*en>
744 \paragraph{\texttt{\char92 CID, \texttt{\char92 UTF}} and macros in OTF package}
745 Under \pLaTeX, \Pkg{otf} package (developed by Shuzaburo Saito) is
746 used for typesetting characters which is in Adobe-Japan1-6 CID but not
747 in JIS~X~0208. Since this package is widely used, \LuaTeX-ja
748 supports some of functions in \Pkg{otf} package.
749 If you want to use these functions, load \Pkg{luatexja-otf} package.
750 %</en>
751 %<*ja>
752 \paragraph{\texttt{\char92 CID, \texttt{\char92 UTF}} と OTF パッケージのマクロ}
753 \pLaTeX では,JIS~X~0208 にない Adobe-Japan1-6 の文字を出力するために,
754 齋藤修三郎氏による \Pkg{otf} パッケージが用いられていた.このパッケージは
755 広く用いられているため,\LuaTeX-ja においても \Pkg{otf} パッケージの機能の
756 一部をサポートしている.これらの機能を用いるためには \Pkg{luatexja-otf} パッケージ
757 を読み込めばよい.
758 %</ja>
759
760 \begin{LTXexample}
761 森\UTF{9DD7}外と内田百\UTF{9592}とが\UTF{9AD9}島屋に行く。
762
763 \CID{7652}飾区の\CID{13706}野家,
764 葛飾区の吉野家
765 \end{LTXexample}
766 %lltjlisting.sty要修正?:↑「森」の直後で改行.
767
768
769 %<en>\subsection{Changing Fonts}
770 %<ja>\subsection{フォントの変更}
771 \label{ssub-chgfnt}
772
773 %<*en>
774 \paragraph{Remark: Japanese Characters in Math Mode}
775 Since \pTeX\ supports Japanese characters in math mode, there are
776 sources like the following:
777 %</en>
778 %<*ja>
779 \paragraph{意見:数式モード中の和文文字}
780 \pTeX では数式中での和文文字の使用がサポートされていたので,
781 以下のようなソースが存在した:
782 %</ja>
783 \begin{LTXexample}
784 $f_{高温}$~($f_{\text{high temperature}}$).
785 \[ y=(x-1)^2+2\quad{}よって\quad y>0 \]
786 $5\in{}素:=\{\,p\in\mathbb N:\text{$p$ is a prime}\,\}$.
787 \end{LTXexample}
788 %<*en>
789 We (the project members of \LuaTeX-ja) think that using
790 Japanese characters in math mode are allowed if and only if these are used as identifiers.
791 In this point of view, 
792 %</en>
793 %<*ja>
794 \LuaTeX-ja プロジェクトでは,数式モード中での和文文字はそれらが識別子として用いられる
795 ときのみ許されると考えている.
796 この観点から,
797 %</ja>
798 \begin{itemize}
799 %<*en>
800 \item The lines 1~and~2 above are not correct, since `高温' in above is used as a textual label, and
801 `よって' is used as a conjunction. 
802 %</en>
803 %<*ja>
804 \item 上記数式のうち 1, 2 行目は正しくない.なぜならば `高温' が意味のあるラベルと
805       して,`よって' が接続詞として用いられているからである.
806 %</ja>
807 %<*en>
808 \item However, the line~3 is correct, since `素' is used as an identifier.
809 %</en>
810 %<*ja>
811 \item しかしながら,3行目は `素' が識別子として用いられているので正しい.
812 %</ja>
813 \end{itemize}
814 %<*en>
815 Hence, in our opinion, the above input should be corrected as:
816 %</en>
817 %<*ja>
818 したがって,\LuaTeX-ja プロジェクトの意見としては,上記の入力は次のように直されるべき
819 である:
820 %</ja>
821 \begin{LTXexample}
822 $f_{\text{高温}}$~%
823 ($f_{\text{high temperature}}$).
824 \[ y=(x-1)^2+2\quad 
825   \mathrel{\text{よって}}\quad y>0 \]
826 $5\in{}素:=\{\,p\in\mathbb N:\text{$p$ is a prime}\,\}$.
827 \end{LTXexample}
828 %BUG?: \{\}がなければ「素」がでない.上の段落の「よって」もでてない.
829 %<*en>
830 We also believe that using Japanese characters as identifiers is rare,
831 hence we don't describe how to change Japanese fonts in math mode in
832 this chapter. For the method, please see Part~\ref{part-ref}.
833 %</en>
834 %<*ja>
835 また \LuaTeX-ja プロジェクトでは,和文文字が識別子として用いられることはほとんどない
836 と考えており,したがってこの章では数式モード中の和文フォントを変更する方法については
837 記述しない.この方法については第 \ref{part-ref} 部を参照のこと.
838 %</ja>
839
840 %<*en>
841 \paragraph{plain \TeX}
842 To change Japanese fonts in plain \TeX, you must use the primitive
843 \verb+\jfont+. So please see Part~\ref{part-ref}.
844 %</en>
845 %<*ja>
846 \paragraph{plain \TeX}
847 plain \TeX で和文フォントを変更するためには,\verb+\jfont+ プリミティブを用いなけれ
848 ばならない.第 \ref{part-ref} 部を参照せよ.
849 %</ja>
850
851 %<*en>
852 \paragraph{NFSS2}
853 For \LaTeXe, \LuaTeX-ja simply adopted the font selection system from that
854 of \pLaTeXe\ (in \texttt{plfonts.dtx}).
855 %</en>
856 %<*ja>
857 \paragraph{NFSS2}
858 \LaTeXe については,\LuaTeX-ja では単にフォント選択システムを \pLaTeXe\ (\texttt{plfonts.dtx})
859 から採用している.
860 %</ja>
861 \begin{itemize}
862 %<*en>
863 \item Two control sequences \verb+\mcdefault+ and \verb+\gtdefault+ are
864       used to specify the default font families for \emph{mincho} and
865       \emph{gothic}, respectively. Default values: \texttt{mc} for
866       \verb+\mcdefault+ and \texttt{gt} for \verb+\gtdefault+.
867 %</en>
868 %<*ja>
869 \item 2つのコントロールシーケンス \verb+\mcdefault+ と \verb+\gtdefault+ がそれぞ
870       れ明朝体とゴシック体のデフォルトのフォントファミリを指定するために用いられる.
871       初期値:\verb+\mcdefault+ は \texttt{mc},\verb+\gtdefault+ は \texttt{gt}.
872 %</ja>
873 %<*en>
874 \item Commands \verb+\fontfamily+, \verb+\fontseries+,
875       \verb+\fontshape+ and \verb+\selectfont+ can be used to change
876       attributes of Japanese fonts. 
877 %</en>
878 %<*ja>
879 \item \verb+\fontfamily+, \verb+\fontseries+, \verb+\fontshape+, そして 
880       \verb+\selectfont+ が和文フォントの属性を変更するために使用できる.
881 %</ja>
882
883 %<*en>
884 \begin{center}
885 \begin{tabular}{cccccc}
886 \toprule
887 &\textbf{encoding}&\textbf{family}&\textbf{series}&\textbf{shape}&\textbf{selection}\\\midrule
888 alphabetic fonts
889 &\verb+\romanencoding+&\verb+\romanfamily+&\verb+\romanseries+&\verb+\romanshape+
890 &\verb+\useroman+\\
891 Japanese fonts
892 &\verb+\kanjiencoding+&\verb+\kanjifamily+&\verb+\kanjiseries+&\verb+\kanjishape+
893 &\verb+\usekanji+\\
894 both&---&--&\verb+\fontseries+&\verb+\fontshape+&---\\
895 auto select&\verb+\fontencoding+&\verb+\fontfamily+&---&---&\verb+\usefont+\\
896 \bottomrule
897 \end{tabular}
898 \end{center}
899 %</en>
900 %<*ja>
901 \begin{center}
902 \begin{tabular}{cccccc}
903 \toprule
904 &\textbf{エンコーディング}&\textbf{ファミリ}&\textbf{シリーズ}&\textbf{シェープ}&\textbf{選択}\\\midrule
905 欧文フォント
906 &\verb+\romanencoding+&\verb+\romanfamily+&\verb+\romanseries+&\verb+\romanshape+
907 &\verb+\useroman+\\
908 和文フォント
909 &\verb+\kanjiencoding+&\verb+\kanjifamily+&\verb+\kanjiseries+&\verb+\kanjishape+
910 &\verb+\usekanji+\\
911 両方&---&--&\verb+\fontseries+&\verb+\fontshape+&---\\
912 自動選択&\verb+\fontencoding+&\verb+\fontfamily+&---&---&\verb+\usefont+\\
913 \bottomrule
914 \end{tabular}
915 \end{center}
916 %</ja>
917
918 %<*en>
919       \verb+\fontencoding{<encoding>}+ changes the encoding of alphabetic fonts
920       or Japanese fonts depending on the argument. For example, 
921       \verb+\fontencoding{JY3}+ changes the encoding of Japanese fonts to 
922       \texttt{JY3} and \verb+\fontencoding{T1}+ changes the encoding of 
923       alphabetic fonts to \texttt{T1}.
924       \verb+\fontfamily+ also changes the family of Japanese fonts, alphabetic
925       fonts, \emph{or both}. For detail, see Subsection~\ref{ssub-nfsspat}.
926 %</en>
927 %<*ja>
928       ここで,\verb+\fontencoding{<encoding>}+は,引数により和文側か欧文側かの
929       どちらかが切り替わる.例えば,\verb+\fontencoding{JY3}+は和文フォントの
930       エンコーディングを\texttt{JY3}に変更し,\verb+\fontencoding{T1}+ は欧文
931       フォント側を\texttt{T1}へと変更する.
932       \verb+\fontfamily+も引数により和文側,欧文側,\textbf{あるいは両方}のフォ
933       ントファミリが切り替わる.詳細は\ref{ssub-nfsspat}節を参照すること.
934 %</ja>
935
936 %<*en>
937 \item For defining a Japanese font family, use
938       \verb+\DeclareKanjiFamily+ instead of
939       \verb+\DeclareFontFamily+. However, in the present implementation,
940       using \verb+\DeclareFontFamily+ doesn't cause any problem.
941 %</en>
942 %<*ja>
943 \item 和文フォントファミリの定義には \verb+\DeclareFontFamily+ の代わりに
944       \verb+\DeclareKanjiFamily+ を用いる.しかし,現在の実装では 
945       \verb+\DeclareFontFamily+ を用いても問題は生じない.
946 %</ja>
947 \end{itemize}
948
949 %<*en>
950 \paragraph{fontspec}
951 To coexist with the \Pkg{fontspec} package, it is needed to load
952 \Pkg{luatexja-fontspec} package in the preamble. This additional
953 package automatically loads \Pkg{luatexja} and \Pkg{fontspec}
954 package, if needed.
955 %</en>
956 %<*ja>
957 \Pkg{fontspec} パッケージと同様の機能を和文フォントに対しても用いるためには,
958 \Pkg{luatexja-fontspec} パッケージをプリアンブルで読み込む必要がある.このパッケージ
959 は必要ならば自動で \Pkg{luatexja} パッケージと \Pkg{fontspec} パッケージを読み込む.
960 %</ja>
961
962 %<*en>
963 In \Pkg{luatexja-fontspec} package, the following 7~commands are defined as
964 counterparts of original commands in the \Pkg{fontspec} package:
965 %</en>
966 %<*ja>
967 \Pkg{luatexja-fontspec} パッケージでは,以下の7つのコマンドを \Pkg{fontspec} 
968 パッケージの元のコマンドに対応するものとして定義している:
969 %</ja>
970 %<*en>
971 \begin{center}
972 \begin{tabular}{ccccc}
973 \toprule
974 Japanese fonts
975 &\verb+\jfontspec+&\verb+\setmainjfont+&\verb+\setsansjfont+&\verb+\newjfontfamily+\\
976 alphabetic fonts
977 &\verb+\fontspec+&\verb+\setmainfont+&\verb+\setsansfont+&\verb+\newfontfamily+\\
978 \midrule
979 Japanese fonts
980 &\verb+\newjfontface+&\verb+\defaultjfontfeatures+&\verb+\addjfontfeatures+\\
981 alphabetic fonts
982 &\verb+\newfontface+&\verb+\defaultfontfeatures+&\verb+\addfontfeatures+\\
983 \bottomrule
984 \end{tabular}
985 \end{center}
986 %</en>
987 %<*ja>
988 \begin{center}
989 \begin{tabular}{ccccc}
990 \toprule
991 和文フォント
992 &\verb+\jfontspec+&\verb+\setmainjfont+&\verb+\setsansjfont+&\verb+\newjfontfamily+\\
993 欧文フォント
994 &\verb+\fontspec+&\verb+\setmainfont+&\verb+\setsansfont+&\verb+\newfontfamily+\\
995 \midrule
996 和文フォント
997 &\verb+\newjfontface+&\verb+\defaultjfontfeatures+&\verb+\addjfontfeatures+\\
998 欧文フォント
999 &\verb+\newfontface+&\verb+\defaultfontfeatures+&\verb+\addfontfeatures+\\
1000 \bottomrule
1001 \end{tabular}
1002 \end{center}
1003 %</ja>
1004
1005 \begin{LTXexample}
1006 \fontspec[Numbers=OldStyle]{TeX Gyre Termes}
1007 \jfontspec{IPAexMincho}
1008 JIS~X~0213:2004→辻
1009
1010 \addjfontfeatures{CJKShape=JIS1990}
1011 JIS~X~0208:1990→辻
1012 \end{LTXexample}
1013
1014 %<*en>
1015 Note that there is no command named \verb+\setmonojfont+, since it is
1016 popular for Japanese fonts that nearly all Japanese glyphs have same
1017 widths.  Also note that the kerning feature is set off by default in
1018 these 7~commands, since this feature and \textbf{JAglue} will clash (see
1019 \ref{para-kern}).
1020 %</en>
1021 %<*ja>
1022 和文フォントについては全ての和文文字のグリフがほぼ等幅であるのが普通であるため,
1023 \verb+\setmonojfont+ コマンドは存在しないことに注意.また,これらの和文用の7つのコマ
1024 ンドでは Kerning feature はデフォルトでは off となっている.これはこの
1025 feature が \textbf{JAglue} と衝突するためである(\ref{para-kern} 節を見よ).
1026 %</ja>
1027
1028 %<en>\section{Changing Parameters}
1029 %<ja>\section{パラメータの変更}
1030
1031 %<*en>
1032 There are many parameters in \LuaTeX-ja. And due to the behavior of \LuaTeX,
1033 most of them are not stored as internal register of \TeX, but as an
1034 original storage system in \LuaTeX-ja. Hence, to assign or acquire those
1035 parameters, you have to use commands \verb+\ltjsetparameter+ and
1036 \verb+\ltjgetparameter+.
1037 %</en>
1038 %<*ja>
1039 \LuaTeX-ja には多くのパラメータが存在する.そして \LuaTeX の振る舞いのために,
1040 その多くは \TeX のレジスタにではなく,\LuaTeX-ja 独自の方法で保持されている.
1041 そのため,これらのパラメータを設定・取得するためには \verb+\ltjsetparameter+ と
1042 \verb+\ltjgetparameter+ を用いなければならない.
1043 %</ja>
1044
1045 %<en>\subsection{Editing the range of \textbf{JAchar}s}
1046 %<ja>\subsection{\textbf{JAchar} の範囲の設定}
1047
1048 %<*en>
1049 To edit the range of \textbf{JAchar}s, you have to assign a non-zero
1050 natural number which is less than 217 to the character range first. This
1051 can be done by using \verb+\ltjdefcharrange+ primitive. For example, the
1052 next line assigns whole characters in Supplementary Multilingual Plane
1053 and the character `漢' to the range number~100.
1054 %</en>
1055 %<*ja>
1056 \textbf{JAchar} の範囲を設定するためには,まず文字範囲に0より大きく217より小さい
1057 自然数を割り当てる必要がある.これには \verb+\ltjdefcharrange+ プリミティブを用いる.
1058 例えば,次のように書くことで追加多言語面 (SMP) にある全ての文字と `漢' の範囲番号が
1059 100に設定される.
1060 %</ja>
1061 \begin{lstlisting}
1062 \ltjdefcharrange{100}{"10000-"1FFFF,`漢}
1063 \end{lstlisting}
1064 %<*en>
1065 This assignment of numbers to ranges are always global, so you should
1066 not do this in the middle of a document. 
1067 %</en>
1068 %<*ja>
1069 この文字範囲への番号の割り当てはいつもグローバルであり,したがって文書の途中で
1070 この操作をするべきではない.
1071 %</ja>
1072
1073 %<*en>
1074 If some character has been belonged to some non-zero numbered range,
1075 this will be overwritten by the new setting. For example, whole SMP
1076 belong to the range~4 in the default setting of \LuaTeX-ja, and if you
1077 specify the above line, then SMP will belong to the range~100 and be
1078 removed from the range~4.
1079 %</en>
1080 %<*ja>
1081 もし指定されたある文字がある非零番号の範囲に属していたならば,これは新しい設定で
1082 上書きされる.例えば,SMP は全て \LuaTeX-ja のデフォルトでは4番の文字範囲に
1083 属しているが,上記の指定を行えば SMP は100番に属すようになり,4番からは除かれる.
1084 %</ja>
1085
1086 %<*en>
1087 After assigning numbers to ranges, the \textsf{jacharrange} parameter can
1088 be used to customize which character range will be treated as ranges of
1089 \textbf{JAchar}s, as the following line (this is just the default
1090 setting of \LuaTeX-ja):
1091 %</en>
1092 %<*ja>
1093 文字範囲に番号を割り当てた後は,\textsf{jacharrange} パラメータが \textbf{JAchar} と
1094 して扱われる文字の範囲を設定するために用いられる.例えば,以下は \LuaTeX-ja の
1095 初期設定である:
1096 %</ja>
1097 \begin{verbatim}
1098 \ltjsetparameter{jacharrange={-1, +2, +3, -4, -5, +6, +7, +8}}
1099 \end{verbatim}
1100 %<*en>
1101 The argument to \textsf{jacharrange} parameter is a list of integer. 
1102 Negative integer $-n$ in the list means that `the characters that belong to 
1103 range~$n$ are treated as \textbf{ALchar}', and positive integer $+n$ means
1104 that `the characters that belong to range~$n$ are treated as \textbf{JAchar}'.
1105 %</en>
1106 %<*ja>
1107 \textsf{jacharrange} パラメータには整数のリストを与える.
1108 リスト中の負の整数 $-n$ は「文字範囲 $n$ に属する文字は \textbf{ALchar} として
1109 扱われる」ことを意味し,正の整数 $+n$ は \textbf{JAchar} として扱うことを意味する.
1110 %</ja>
1111
1112 %<*en>
1113 \paragraph{Default Setting}
1114 \LuaTeX-ja predefines eight character ranges for convenience. They are
1115 determined from the following data:
1116 %</en>
1117 %<*ja>
1118 \paragraph{初期設定}
1119 \LuaTeX-ja では8つの文字範囲を設定している.これらは以下のデータに基づいて決定して
1120 いる.
1121 %</ja>
1122 \begin{itemize}
1123 %<*en>
1124 \item Blocks in Unicode~6.0.
1125 %</en>
1126 %<*ja>
1127 \item Unicode~6.0 のブロック.
1128 %</ja>
1129 %<*en>
1130 \item The \texttt{Adobe-Japan1-UCS2} mapping between a CID Adobe-Japan1-6 and Unicode.
1131 %</en>
1132 %<*ja>
1133 \item \texttt{Adobe-Japan1-UCS2} による Adobe-Japan1-6 の CID と Unicode の間の
1134       マッピング.
1135 %</ja>
1136 %<*en>
1137 \item The \texttt{PXbase} bundle for \upTeX\ by Takayuki Yato.
1138 %</en>
1139 %<*ja>
1140 \item 八登崇之氏による \upTeX 用の \texttt{PXbase} バンドル.
1141 %</ja>
1142 \end{itemize}
1143
1144 %<*en>
1145 Now we describe these eight ranges. The alphabet `J' or `A' after the
1146 number shows whether characters in the range is treated as
1147 \textbf{JAchar}s or not by default. These settings are similar to the 
1148 \texttt{prefercjk} settings defined in \texttt{PXbase} bundle.
1149 %</en>
1150 %<*ja>
1151 以下ではこれら8つの文字範囲について記述する.番号のあとのアルファベット `J' と `A'
1152 はデフォルトで \textbf{JAchar} として扱われるかどうかを示す.これらの設定は
1153 \texttt{PXbase} バンドルで定義されている \texttt{prefercjk} と類似のものである.
1154 %</ja>
1155 \begin{description}
1156 %<*en>
1157 \item[Range~8${}^{\text{J}}$] Symbols in the intersection of the upper half of ISO~8859-1
1158          (Latin-1 Supplement) and JIS~X~0208 (a basic character set for Japanese). This character range
1159          consists of the following characters:
1160 %</en>
1161 %<*ja>
1162 \item{範囲 8${}^{\text{J}}$} ISO~8869~1 の上半分(ラテン1補助)と 
1163                              JIS~X~0208 の共通部分にある記号.この文字範囲は
1164                              以下の文字で構成される:
1165 %</ja>
1166 \begin{multicols}{2}
1167 \begin{itemize}
1168 \def\ch#1#2{\item \char"#1\ (\texttt{U+00#1}, #2)}%"
1169 %<*en>
1170 \ch{A7}{Section Sign}
1171 \ch{A8}{Diaeresis}
1172 \ch{B0}{Degree sign}
1173 \ch{B1}{Plus-minus sign}
1174 \ch{B4}{Spacing acute}
1175 \ch{B6}{Paragraph sign}
1176 \ch{D7}{Multiplication sign}
1177 \ch{F7}{Division Sign}
1178 %</en>
1179 %<*ja>
1180 \ch{A7}{節記号}
1181 \ch{A8}{トレマ}
1182 \ch{B0}{度}
1183 \ch{B1}{正又は負符号}
1184 \ch{B4}{アキュート・アクセント}
1185 \ch{B6}{段落記号}
1186 \ch{D7}{乗算記号}
1187 \ch{F7}{除算記号}
1188 %</ja>
1189 \end{itemize}
1190 \end{multicols}
1191
1192 %<*en>
1193 \item[Range~1${}^{\text{A}}$] Latin characters that some of them are included in Adobe-Japan1-6.
1194 This range consist of the following Unicode ranges, \emph{except characters in the range~8 above}:
1195 %</en>
1196 %<*ja>
1197 \item{範囲 1${}^{\text{A}}$} ラテン文字.一部はAdobe-Japan1-6 にも含まれている.
1198                              この範囲は以下の Unicode のブロックから構成されている.
1199                              \textbf{ただし,範囲 8 は除く.}
1200 %</ja>
1201 \begin{multicols}{2}
1202 \begin{itemize}
1203 %<*en>
1204 \item \texttt{U+0080}--\texttt{U+00FF}: Latin-1 Supplement
1205 \item \texttt{U+0100}--\texttt{U+017F}: Latin Extended-A
1206 \item \texttt{U+0180}--\texttt{U+024F}: Latin Extended-B
1207 \item \texttt{U+0250}--\texttt{U+02AF}: IPA Extensions
1208 \item \texttt{U+02B0}--\texttt{U+02FF}: Spacing Modifier Letters
1209 \item \texttt{U+0300}--\texttt{U+036F}: Combining Diacritical Marks
1210 \item \texttt{U+1E00}--\texttt{U+1EFF}: Latin Extended Additional
1211 %</en>
1212 %<*ja>
1213 \item \texttt{U+0080}--\texttt{U+00FF}: ラテン1補助
1214 \item \texttt{U+0100}--\texttt{U+017F}: ラテン文字拡張A
1215 \item \texttt{U+0180}--\texttt{U+024F}: ラテン文字拡張B
1216 \item \texttt{U+0250}--\texttt{U+02AF}: IPA拡張(国際音声記号)
1217 \item \texttt{U+02B0}--\texttt{U+02FF}: 前進を伴う修飾文字
1218 \item \texttt{U+0300}--\texttt{U+036F}: ダイアクリティカルマーク(合成可能)
1219 \item \texttt{U+1E00}--\texttt{U+1EFF}: ラテン文字拡張追加
1220 %</ja>
1221 \par\ 
1222 \end{itemize}
1223 \end{multicols}
1224 %<*en>
1225 \item[Range~2${}^{\text{J}}$] Greek and Cyrillic letters. JIS~X~0208 (hence most of Japanese
1226            fonts) has some of these characters.
1227 %</en>
1228 %<*ja>
1229 \item[範囲 2${}^{\text{J}}$] ギリシャ文字とキリル文字.JIS~X~0208(したがって多くの
1230                              和文フォント)はこれらの文字を持つ.
1231 %</ja>
1232 \begin{multicols}{2}
1233 \begin{itemize}
1234 %<*en>
1235 \item \texttt{U+0370}--\texttt{U+03FF}: Greek and Coptic
1236 \item \texttt{U+0400}--\texttt{U+04FF}: Cyrillic
1237 \item \texttt{U+1F00}--\texttt{U+1FFF}: Greek Extended
1238 %</en>
1239 %<*ja>
1240 \item \texttt{U+0370}--\texttt{U+03FF}: ギリシア文字及びコプト文字
1241 \item \texttt{U+0400}--\texttt{U+04FF}: キリル文字
1242 \item \texttt{U+1F00}--\texttt{U+1FFF}: キリル文字補助
1243 %</ja>
1244 \\\ 
1245 \end{itemize}
1246 \end{multicols}
1247 %<*en>
1248 \item[Range~3${}^{\text{J}}$] Punctuations and Miscellaneous symbols. The block list is
1249            indicated in Table~\ref{table-rng3}.
1250 %</en>
1251 %<*ja>
1252 \item[範囲 3${}^{\text{J}}$] 句読点と記号類.ブロックのリストは表~\ref{table-rng3}
1253                              に示してある.
1254 %</ja>
1255 \begin{table}[!tb]
1256 %<*en>
1257 \caption{Unicode blocks in predefined character range~3.}
1258 %</en>
1259 %<*ja>
1260 \caption{文字範囲 3 に指定されている Unicode ブロック.}
1261 %</ja>
1262 \label{table-rng3}
1263 \catcode`\"=13\def"#1#2#3#4{\texttt{U+#1#2#3#4}}%"
1264 \begin{center}\small
1265 \begin{tabular}{llll}
1266 %<*en>
1267 "2000--"206F&General Punctuation&
1268 "2070--"209F&Superscripts and Subscripts\\
1269 "20A0--"20CF&Currency Symbols&
1270 "20D0--"20FF&Comb.\ Diacritical Marks for Symbols\\
1271 "2100--"214F&Letterlike Symbols&
1272 "2150--"218F&Number Forms\\
1273 "2190--"21FF&Arrows&
1274 "2200--"22FF&Mathematical Operators\\
1275 "2300--"23FF&Miscellaneous Technical&
1276 "2400--"243F&Control Pictures\\
1277 "2500--"257F&Box Drawing&
1278 "2580--"259F&Block Elements\\
1279 "25A0--"25FF&Geometric Shapes&
1280 "2600--"26FF&Miscellaneous Symbols\\
1281 "2700--"27BF&Dingbats&
1282 "2900--"297F&Supplemental Arrows-B\\
1283 "2980--"29FF&Misc.\ Mathematical Symbols-B&
1284 "2B00--"2BFF&Miscellaneous Symbols and Arrows\\
1285 "E000--"F8FF&Private Use Area&
1286 %</en>
1287 %<*ja>
1288 "2000--"206F&一般句読点&
1289 "2070--"209F&上付き・下付き\\
1290 "20A0--"20CF&通貨記号&
1291 "20D0--"20FF&記号用ダイアクリティカルマーク(合成可能)\\
1292 "2100--"214F&文字様記号&
1293 "2150--"218F&数字に準じるもの\\
1294 "2190--"21FF&矢印&
1295 "2200--"22FF&数学記号(演算子)\\
1296 "2300--"23FF&その他の技術用記号&
1297 "2400--"243F&制御機能用記号\\
1298 "2500--"257F&罫線素片&
1299 "2580--"259F&ブロック要素\\
1300 "25A0--"25FF&幾何学模様&
1301 "2600--"26FF&その他の記号\\
1302 "2700--"27BF&装飾記号&
1303 "2900--"297F&補助矢印B\\
1304 "2980--"29FF&その他の数学記号B&
1305 "2B00--"2BFF&その他の記号及び矢印\\
1306 "E000--"F8FF&私用領域(外字領域)&
1307 %</ja>
1308 \end{tabular}
1309 \end{center}
1310 \end{table}
1311 %<*en>
1312 \item[Range~4${}^{\text{A}}$] Characters usually not in Japanese fonts. This range consists
1313            of almost all Unicode blocks which are not in other
1314            predefined ranges. Hence, instead of showing the block list,
1315            we put the definition of this range itself:
1316 %</en>
1317 %<*ja>
1318 \item[範囲 4${}^{\text{A}}$] 通常和文フォントには含まれていない文字.
1319                              この範囲は他の範囲にないほとんど全ての Unicode ブロック
1320                              で構成されている.したがって,ブロックのリストを示す
1321                              代わりに,範囲の定義そのものを示す:
1322 %</ja>
1323 \begin{lstlisting}
1324 \ltjdefcharrange{4}{%
1325    "500-"10FF, "1200-"1DFF, "2440-"245F, "27C0-"28FF, "2A00-"2AFF, 
1326   "2C00-"2E7F, "4DC0-"4DFF, "A4D0-"A82F, "A840-"ABFF, "FB50-"FE0F, 
1327   "FE20-"FE2F, "FE70-"FEFF, "FB00-"FB4F, "10000-"1FFFF} % non-Japanese
1328 \end{lstlisting}
1329 %<*en>
1330 \item[Range~5${}^{\text{A}}$] Surrogates and Supplementary Private Use Areas.
1331 %</en>
1332 %<*ja>
1333 \item[範囲 5${}^{\text{A}}$] 代用符号と補助私用領域.
1334 %</ja>
1335 %<*en>
1336 \item[Range~6${}^{\text{J}}$] Characters used in Japanese. The block list is indicated in Table~\ref{table-rng6}.
1337 %</en>
1338 %<*ja>
1339 \item[範囲 6${}^{\text{J}}$] 日本語で用いられる文字.ブロックのリストは
1340                              表~\ref{table-rng6} に示す.
1341 %</ja>
1342 \begin{table}[!tb]
1343 %<*en>
1344 \caption{Unicode blocks in predefined character range~6.}
1345 %</en>
1346 %<*ja>
1347 \caption{文字範囲 6 に指定されている Unicode ブロック.}
1348 %</ja>
1349 \label{table-rng6}
1350 \catcode`\"=13\def"#1#2#3#4{\texttt{U+#1#2#3#4}}%"
1351 \begin{center}\small
1352 \begin{tabular}{llll}
1353 %<*en>
1354 "2460--"24FF&Enclosed Alphanumerics&
1355 "2E80--"2EFF&CJK Radicals Supplement\\
1356 "3000--"303F&CJK Symbols and Punctuation&
1357 "3040--"309F&Hiragana\\
1358 "30A0--"30FF&Katakana&
1359 "3190--"319F&Kanbun\\
1360 "31F0--"31FF&Katakana Phonetic Extensions&
1361 "3200--"32FF&Enclosed CJK Letters and Months\\
1362 "3300--"33FF&CJK Compatibility&
1363 "3400--"4DBF&CJK Unified Ideographs Extension A\\
1364 "4E00--"9FFF&CJK Unified Ideographs&
1365 "F900--"FAFF&CJK Compatibility Ideographs\\
1366 "FE10--"FE1F&Vertical Forms&
1367 "FE30--"FE4F&CJK Compatibility Forms\\
1368 "FE50--"FE6F&Small Form Variants&
1369 "{20}000--"{2F}FFF&(Supplementary Ideographic Plane)
1370 %</en>
1371 %<*ja>
1372 "2460--"24FF&囲み英数字&
1373 "2E80--"2EFF&CJK部首補助\\
1374 "3000--"303F&CJKの記号及び句読点&
1375 "3040--"309F&平仮名\\
1376 "30A0--"30FF&片仮名&
1377 "3190--"319F&漢文用記号(返り点)\\
1378 "31F0--"31FF&片仮名拡張&
1379 "3200--"32FF&囲みCJK文字・月\\
1380 "3300--"33FF&CJK互換用文字&
1381 "3400--"4DBF&CJK統合漢字拡張A\\
1382 "4E00--"9FFF&CJK統合漢字&
1383 "F900--"FAFF&CJK互換漢字\\
1384 "FE10--"FE1F&縦書き形&
1385 "FE30--"FE4F&CJK互換形\\
1386 "FE50--"FE6F&小字形&
1387 "{20}000--"{2F}FFF&(追加多言語面)
1388 %</ja>
1389 \end{tabular}
1390 \end{center}
1391 \end{table}
1392 %<*en>
1393 \item[Range~7${}^{\text{J}}$] Characters used in CJK languages, but not included in  Adobe-Japan1-6.
1394 The block list is indicated in Table~\ref{table-rng7}.
1395 %</en>
1396 %<*ja>
1397 \item[範囲 7${}^{\text{J}}$] CJK 言語で用いられる文字のうち,Adobe-Japan1-6 に
1398                             含まれていないもの.
1399                             ブロックのリストは表~\ref{table-rng7} に示す.
1400 %</ja>
1401 \begin{table}[!tb]
1402 %<*en>
1403 \caption{Unicode blocks in predefined character range~7.}
1404 %</en>
1405 %<*ja>
1406 \caption{文字範囲 7 に指定されている Unicode ブロック.}
1407 %</ja>
1408 \label{table-rng7}
1409 \catcode`\"=13\def"#1#2#3#4{\texttt{U+#1#2#3#4}}%"
1410 \begin{center}\small
1411 \begin{tabular}{llll}
1412 %<*en>
1413 "1100--"11FF&Hangul Jamo&
1414 "2F00--"2FDF&Kangxi Radicals\\
1415 "2FF0--"2FFF&Ideographic Description Characters&
1416 "3100--"312F&Bopomofo\\
1417 "3130--"318F&Hangul Compatibility Jamo&
1418 "31A0--"31BF&Bopomofo Extended\\
1419 "31C0--"31EF&CJK Strokes&
1420 "A000--"A48F&Yi Syllables\\
1421 "A490--"A4CF&Yi Radicals&
1422 "A830--"A83F&Common Indic Number Forms\\
1423 "AC00--"D7AF&Hangul Syllables&
1424 "D7B0--"D7FF&Hangul Jamo Extended-B
1425 %</en>
1426 %<*ja>
1427 "1100--"11FF&ハングル字母&
1428 "2F00--"2FDF&康熙部首\\
1429 "2FF0--"2FFF&漢字構成記述文字&
1430 "3100--"312F&注音字母 (注音符号)\\
1431 "3130--"318F&ハングル互換字母&
1432 "31A0--"31BF&注音字母拡張\\
1433 "31C0--"31EF&CJKの筆画&
1434 "A000--"A48F&イ文字\\
1435 "A490--"A4CF&イ文字部首&
1436 "A830--"A83F&共通インド数字に準じるもの\\
1437 "AC00--"D7AF&ハングル音節文字&
1438 "D7B0--"D7FF&ハングル字母拡張B
1439 %</ja>
1440 \end{tabular}
1441 \end{center}
1442 \end{table}
1443 \end{description}
1444
1445
1446 %<en>\subsection{\Param{kanjiskip} and \Param{xkanjiskip}}
1447 %<ja>\subsection{\Param{kanjiskip} と \Param{xkanjiskip}}
1448 \label{subs-kskip}
1449 \textbf{JAglue} is divided into the following three categories:
1450 \begin{itemize}
1451 \item Glues/kerns specified in JFM. If \verb+\inhibitglue+ is issued
1452       around a Japanese character, this glue will be not inserted at the
1453       place.
1454 \item The default glue which inserted between two \textbf{JAchar}s (\textsf{
1455       kanjiskip}).
1456 \item The default glue which inserted between a \textbf{JAchar} and an
1457       \textbf{ALchar} (\Param{xkanjiskip}).
1458 \end{itemize}
1459 The value (a skip) of \Param{kanjiskip} or \Param{xkanjiskip} can be
1460 changed as the following.
1461 \begin{lstlisting}
1462 \ltjsetparameter{kanjiskip={0pt plus 0.4pt minus 0.4pt}, 
1463                  xkanjiskip={0.25\zw plus 1pt minus 1pt}}
1464 \end{lstlisting}
1465
1466
1467 It may occur that JFM contains the data of `ideal width of \textsf{kanjiskip}' 
1468 and/or `ideal width of \Param{xkanjiskip}'.
1469 To use these data from JFM, set the value of \Param{kanjiskip} or 
1470 \Param{xkanjiskip} to \verb+\maxdimen+.
1471
1472 %<en>\subsection{Insertion Setting of \Param{xkanjiskip}}
1473 %<ja>\subsection{\Param{xkanjiskip} の設定の挿入}
1474 It is not desirable that \Param{xkanjiskip} is inserted between every
1475 boundary between \textbf{JAchar}s and \textbf{ALchar}s. For example,
1476 \Param{xkanjiskip} should not be inserted after opening parenthesis
1477 (\textit{e.g.}, compare `(あ' and `(\hskip\ltjgetparameter{xkanjiskip}あ').
1478
1479 \LuaTeX-ja can control whether \Param{xkanjiskip} can be inserted
1480 before/after a character, by changing \Param{jaxspmode} for \textbf{JAchar}s and
1481 \Param{alxspmode} parameters \textbf{ALchar}s respectively. 
1482 \begin{LTXexample}
1483 \ltjsetparameter{jaxspmode={`あ,preonly}, alxspmode={`\!,postonly}} 
1484 pあq い!う
1485 \end{LTXexample}
1486
1487 The second argument \texttt{preonly} means `the insertion of
1488 \Param{xkanjiskip} is allowed before this character, but not after'.
1489 the other possible values are \texttt{postonly}, \texttt{allow} and \texttt{
1490 inhibit}. For the compatibility with \pTeX, natural numbers between
1491 0~and~3 are also allowed as the second argument\footnote{But we don't
1492 recommend this: since numbers 1~and~2 have opposite meanings in
1493 \Param{jaxspmode} and \Param{alxspmode}.}.
1494
1495 If you want to enable/disable all insertions of \Param{kanjiskip} and
1496 \Param{xkanjiskip}, set \Param{autospacing} and \Param{autoxspacing}
1497 parameters to \texttt{false}, respectively.
1498
1499
1500 %<en>\subsection{Shifting Baseline}
1501 %<ja>\subsection{ベースラインの移動}
1502 To make a match between a Japanese font and an alphabetic font, sometimes
1503 shifting of the baseline of one of the pair is needed. In \pTeX, this is achieved
1504 by setting \verb+\ybaselineshift+ to a non-zero length (the
1505 baseline of alphabetic fonts is shifted below). However, for documents
1506 whose main language is not Japanese, it is good to shift the baseline of
1507 Japanese fonts, but not that of alphabetic fonts.
1508 Because of this, \LuaTeX-ja can independently set the shifting amount
1509 of the baseline of alphabetic fonts (\Param{yalbaselineshift}
1510 parameter) and that of Japanese fonts (\Param{yjabaselineshift}
1511 parameter). 
1512
1513 \begin{LTXexample}
1514 \vrule width 150pt height 0.4pt depth 0pt\hskip-120pt
1515 \ltjsetparameter{yjabaselineshift=0pt, yalbaselineshift=0pt}abcあいう
1516 \ltjsetparameter{yjabaselineshift=5pt, yalbaselineshift=2pt}abcあいう
1517 \end{LTXexample}
1518 Here the horizontal line in above is the baseline of a line.
1519
1520 There is an interesting side-effect: characters in different size can be
1521 vertically aligned center in a line, by setting two parameters appropriately.
1522 The following is an example (beware the value is not well tuned):
1523 \begin{LTXexample}
1524 xyz漢字 
1525 {\scriptsize
1526   \ltjsetparameter{yjabaselineshift=-1pt, 
1527     yalbaselineshift=-1pt}
1528   XYZひらがな
1529 }abcかな
1530 \end{LTXexample}
1531
1532
1533 %<en>\subsection{Cropmark}
1534 %<ja>\subsection{トンボ}
1535 Cropmark is a mark for indicating 4~corners and horizontal/vertical
1536 center of the paper. In Japanese, we call cropmark as tombo(w).
1537 \pLaTeX\ and this \LuaTeX-ja support `tombow' by their kernel.
1538 The following steps are needed to typeset cropmark:
1539
1540 \begin{enumerate}
1541 \item First, define the banner which will be printed at the upper left
1542       of the paper. This is done by assigning a token list to
1543       \verb+\@bannertoken+.
1544
1545 For example, the following sets banner as `\texttt{filename (2012-01-01 17:01)}':
1546 \begin{verbatim}
1547 \makeatletter
1548
1549 \hour\time \divide\hour by 60 \@tempcnta\hour \multiply\@tempcnta 60\relax
1550 \minute\time \advance\minute-\@tempcnta
1551 \@bannertoken{%
1552    \jobname\space(\number\year-\two@digits\month-\two@digits\day
1553    \space\two@digits\hour:\two@digits\minute)}%
1554 \end{verbatim}
1555
1556 \item ...
1557 \end{enumerate}
1558
1559
1560 %<en>\part{Reference}
1561 %<ja>\part{リファレンス}
1562 \label{part-ref}
1563 %<en>\section{Font Metric and Japanese Font}
1564 %<ja>\section{フォントメトリックと日本語フォント}
1565 %<en>\subsection{\texttt{\char92jfont} primitive}
1566 %<ja>\subsection{\texttt{\char92jfont} プリミティブ}
1567 To load a font as a Japanese font, you must use the
1568 \verb+\jfont+ primitive instead of~\verb+\font+, while
1569 \verb+\jfont+ admits the same syntax used in~\verb+\font+. 
1570 \LuaTeX-ja automatically loads \Pkg{luaotfload} package,
1571 so TrueType/OpenType fonts with features can be used for Japanese fonts:
1572 \begin{LTXexample}
1573 \jfont\tradgt={file:ipaexg.ttf:script=latn;%
1574   +trad;-kern;jfm=ujis} at 14pt
1575 \tradgt{}当/体/医/区
1576 \end{LTXexample}
1577
1578 Note that the defined control sequence
1579 (\verb+\tradgt+ in the example above) using \verb+\jfont+ is not a
1580 \textit{font\_def} token, hence the input like \verb+\fontname\tradgt+
1581 causes a error.  We denote control sequences which are defined in
1582 \verb+\jfont+ by <jfont\_cs>.
1583
1584 \paragraph{Prefix \texttt{psft}}
1585 Besides \texttt{file:}\ and \texttt{name:}\ prefixes, \texttt{psft:}\
1586 can be used a prefix in \verb+\jfont+ (and~\verb+\font+) primitive.
1587 Using this prefix, you can specify a `name-only' Japanese font which
1588 will be not embedded to PDF. Typical use of this prefix is to specify
1589 the `standard' Japanese fonts, namely, `Ryumin-Light' and
1590 `GothicBBB-Medium'. For kerning or other information, that of Kozuka
1591 Mincho Pr6N Regular (this is a font by Adobe Inc., and included in
1592 Japanese Font Packs for Adore Reader) will be used.
1593
1594
1595 \paragraph{JFM}
1596 As noted in Introduction, a JFM has measurements of characters and
1597 glues/kerns that are automatically inserted for Japanese
1598 typesetting. The structure of JFM will be described in the next
1599 subsection. At the calling of \verb+\jfont+ primitive, you must specify
1600 which JFM will be used for this font by the following keys:
1601
1602 \begin{list}{}{\def\makelabel{\ttfamily}\def\{{\char`\{}\def\}{\char`\}}}
1603 \item[jfm=<name>]
1604 Specify the name of JFM. A file named \texttt{jfm-<name>.lua} will be searched and/or loaded.
1605
1606 The followings are JFMs shipped with \LuaTeX-ja:
1607 \begin{description}
1608 \item[\tt jfm-ujis.lua] A standard JFM in \LuaTeX-ja. This JFM is
1609       based on \verb+upnmlminr-h.tfm+, a metric for UTF/OTF package that
1610       is used in \upTeX. When you use the \Pkg{luatexja-otf} package, please use this JFM.
1611 \item[\tt jfm-jis.lua] A counterpart for \verb+jis.tfm+, `JIS font
1612            metric' which is widely used in \pTeX. A major difference of
1613            \texttt{jfm-ujis.lua} and this \texttt{jfm-jis.lua} is that
1614            most characters under \texttt{jfm-ujis.lua} are square-shaped,
1615            while that under \texttt{jfm-jis.lua} are horizontal
1616            rectangles.
1617
1618 \item[\tt jfm-min.lua] A counterpart for \verb+min10.tfm+, which is one
1619            of the default Japanese font metric shipped with \pTeX. There
1620            are notable difference between this JFM and other 2~JFMs, as
1621            shown in Table~\ref{tab-difjfm}.
1622 \end{description}
1623
1624 \item[jfmvar=<string>] Sometimes there is a need that 
1625 \end{list}
1626
1627 \begin{table}[t]
1628 \caption{Differences between JFMs shipped with \LuaTeX-ja}
1629 \label{tab-difjfm}
1630 \ltjsetparameter{jacharrange={+3}}
1631 \begin{center}
1632 \def\r#1{{\jfont\g=psft:Ryumin-Light:jfm=#1 at 14.43324pt \g
1633 \setbox0=\vtop{\hsize=7\zw\noindent ◆◆◆◆◆◆◆
1634 ある日モモちゃんがお使いで迷子になって泣きました.}\copy0
1635 \vrule height 0pt depth \dp0}}
1636 \def\s#1{{\jfont\g=psft:Ryumin-Light:jfm=#1 at 14.43324pt \g
1637 \setbox0=\vtop{\hsize=7\zw\noindent ちょっと!何}\copy0}}
1638 \def\t#1{{\jfont\g=psft:Ryumin-Light:jfm=#1 at 19.24432pt \g
1639 \setbox0=\hbox{漢}%
1640 \vrule width 0.4pt height\ht0 depth\dp0\kern-.2pt\copy0
1641 \kern-\wd0\vrule width\wd0height .2pt depth .2pt
1642 \kern-\wd0\raise\ht0\hbox{\vrule width\wd0height .2pt depth .2pt}%
1643 \kern-\wd0\lower\dp0\hbox{\vrule width\wd0height .2pt depth .2pt}%
1644 \kern-.2pt\vrule width 0.4pt height\ht0 depth \dp0}}
1645 \begin{tabular}{rccc}
1646 \toprule
1647 &\tt jfm-ujis.lua&\tt jfm-jis.lua&\tt jfm-min.lua\\
1648 \midrule
1649 Example~1&\r{ujis}&\r{jis}&\r{min}\\
1650 Example~2&\s{ujis}&\s{jis}&\s{min}\\
1651 Bounding Box&\t{ujis}&\t{jis}&\t{min}\\
1652 \bottomrule
1653 \end{tabular}
1654 \end{center}
1655 \ltjsetparameter{jacharrange={-3}}
1656 \end{table}
1657
1658 \paragraph{Note: kern feature}\label{para-kern}
1659 Some fonts have information for inter-glyph spacing. However, this
1660 information is not well-compatible with \LuaTeX-ja.  More concretely,
1661 this kerning space from this information are inserted \emph{before} the
1662 insertion process of \textbf{JAglue}, and this causes incorrect spacing
1663 between two characters when both a glue/kern from the data in the font
1664 and it from JFM are present.
1665
1666 \begin{itemize}
1667 \item You should specify \texttt{-kern} in
1668 \texttt{\char92jfont} primitive, when you want to use other font features,
1669       such as \texttt{script=...}\,.
1670 \item If you want to use Japanese fonts in proportional width, and use
1671       information from this font, use \texttt{jfm-prop.lua} for its JFM, and ...
1672
1673 TODO: kanjiskip?
1674 \end{itemize}
1675
1676
1677 %<en>\subsection{Structure of JFM file}
1678 %<ja>\subsection{JFM ファイルの構造}
1679 A JFM file is a Lua script which has only one function call:
1680 \begin{verbatim}
1681 luatexja.jfont.define_jfm { ... }
1682 \end{verbatim}
1683 Real data are stored in the table which indicated above by
1684 \verb+{ ... }+.  So, the rest of this subsection are devoted to describe the
1685 structure of this table.  Note that all lengths in a JFM file are
1686 floating-point numbers in design-size unit.
1687
1688 \begin{list}{}{\def\makelabel{\ttfamily}\def\{{\char`\{}\def\}{\char`\}}}
1689 \item[dir=<direction>] (required)
1690
1691 The direction of JFM. At the present, only \texttt{'yoko'} is supported.
1692
1693 \item[zw=<length>] (required)
1694
1695 The amount of the length of the `full-width'.
1696
1697 \item[zh=<length>] (required)
1698
1699 \item[kanjiskip=\{<natural>, <stretch>, <shrink>\}] (optional)
1700
1701 This field specifies the `ideal' amount of \Param{kanjiskip}. As noted
1702              in Subsection~\ref{subs-kskip}, if the parameter
1703              \Param{kanjiskip} is \verb+\maxdimen+, the value specified
1704              in this field is actually used (if this field is not specified in
1705              JFM, it is regarded as 0\,pt). Note that <stretch> and <shrink>
1706              fields are in design-size unit too.
1707
1708
1709 \item[xkanjiskip=\{<natural>, <stretch>, <shrink>\}] (optional)
1710
1711 Like the \Param{kanjiskip} field, this field specifies the `ideal'
1712              amount of \Param{xkanjiskip}.
1713
1714 \end{list}
1715
1716 Besides from above fields, a JFM file have several sub-tables those
1717 indices are natural numbers.  The table indexed by~$i\in\omega$ stores
1718 information of `character class'~$i$. At least, the character class~0 is
1719 always present, so each JFM file must have a sub-table whose index is
1720 \texttt{[0]}.  Each sub-table (its numerical index is denoted by $i$) has
1721 the following fields:
1722
1723 \begin{list}{}{\def\makelabel{\ttfamily}\def\{{\char`\{}\def\}{\char`\}}}
1724 \item[chars=\{<character>, ...\}] (required except character class~0)
1725
1726 This field is a list of characters which are in this character
1727              type~$i$. This field is not required if $i=0$, since all
1728              \textbf{JAchar} which are not in any character class other
1729              than 0 (hence, the character class~0 contains most of
1730              \textbf{JAchar}s). In the list, a character can be
1731              specified by its code number, or by the character itself
1732              (as a string of length~1). Moreover, there are `imaginary
1733              characters' which specified in the list. We will describe these later.
1734
1735 \item[width=<length>, height=<length>, depth=<length>, italic=<length>]\ (required)
1736
1737 Specify width of characters in character class~$i$, height, depth and
1738 the amount of italic correction. All characters in character class~$i$ are regarded that its width, height and depth are
1739 as values of these fields. 
1740 But there is one exception: if \texttt{'prop'} is specified in \texttt{width} field, width of a character becomes that of its `real' glyph 
1741
1742 \item[left=<length>, down=<length>, align=<align>]\ 
1743
1744 These fields are for adjusting the position of the `real' glyph. Legal
1745              values of \texttt{align} field are \texttt{'left'},
1746              \texttt{'middle'} and \texttt{'right'}. If one of these
1747              3~fields are omitted, \texttt{left} and \texttt{down} are
1748              treated as~0, and \texttt{align} field is treated as
1749              \texttt{'left'}.
1750 The effects of these 3~fields are indicated in Figure~\ref{fig-pos}.
1751
1752 In most cases, \texttt{left} and \texttt{down} fields are~0, while
1753 it is not uncommon that the \texttt{align} field is \texttt{'middle'} or \texttt{'right'}.
1754 For example, setting the \texttt{align} field to \texttt{'right'} is practically needed 
1755 when the current character class is the class for opening delimiters'. 
1756 \begin{figure}[!tb]
1757 \begin{minipage}{0.4\textwidth}%
1758 \begin{center}\unitlength=10pt\small
1759 \begin{picture}(15,12)(-1,-4)
1760 \color{black!10!white}% real glyph :step1
1761 \put(0,0){\vrule width 12\unitlength height 8\unitlength depth 3\unitlength}
1762
1763 \color{red!20!white}% real glyph :step1
1764 \put(-1,-1.5){\vrule width 6\unitlength height 7\unitlength depth 2.5\unitlength}
1765
1766 \color{red}% real glyph
1767 \thicklines
1768 \put(-1,-1.5){\vector(0,1){7}\vector(0,-1){2.5}\vector(1,0){6}}
1769 \put(5,-1.5){\line(0,1){7}\line(0,-1){2.5}}
1770 \put(-1,5.5){\line(1,0){6}}
1771 \put(-1,-4){\line(1,0){6}}
1772
1773 \color{green!20!white}% real glyph :step1
1774 \put(3,0){\vrule width 6\unitlength height 7\unitlength depth 2.5\unitlength}
1775
1776 \color{black}% real glyph :step1
1777 \thicklines
1778 \put(0,0){\vector(0,1){8}\line(0,-1){3}\vector(1,0){12}}
1779 \put(12,0){\line(0,1){8}\vector(0,-1){3}}
1780 \put(0,8){\line(1,0){12}}
1781 \put(0,-3){\line(1,0){12}}
1782 \put(0.2,4){\makebox(0,0)[l]{\texttt{height}}}
1783 \put(12.2,-1.5){\makebox(0,0)[l]{\texttt{depth}}}
1784 \put(6,0.2){\makebox(0,0)[b]{\texttt{width}}}
1785
1786 \color{green!50!black}% real glyph :step1
1787 \thicklines
1788 \put(3,0){\vector(0,1){7}\vector(0,-1){2.5}\vector(1,0){6}}
1789 \put(9,0){\line(0,1){7}\line(0,-1){2.5}}
1790 \put(3,7){\line(1,0){6}}
1791 \put(3,-2.5){\line(1,0){6}}
1792 \newsavebox{\eqdist}
1793 \savebox{\eqdist}(0,0)[b]{%
1794   \thinlines
1795   \put(-0.08,0.2){\line(0,-1){0.4}}%
1796   \put(0.08,0.2){\line(0,-1){0.4}}}
1797 \put(1.5,0){\usebox{\eqdist}}
1798 \put(10.5,0){\usebox{\eqdist}}
1799
1800 \color{blue}% shifted
1801 \thicklines
1802 \put(3,-1.5){\vector(-1,0){4}}
1803 \put(1,-1.7){\makebox(0,0)[t]{\texttt{left}}}
1804 \put(3,0){\vector(0,-1){1.5}}
1805 \put(3.2,-0.75){\makebox(0,0)[l]{\texttt{down}}}
1806 \end{picture} 
1807 \end{center}
1808 \end{minipage}%
1809 \begin{minipage}{0.6\textwidth}%
1810 Consider a node containing Japanese character whose value of the \texttt{align} 
1811 field is \texttt{'middle'}.
1812 \begin{itemize}
1813 \item The black rectangle is a frame of the node.
1814 Its width, height and depth are specified by JFM.
1815 \item Since the \texttt{align} field is \texttt{'middle'}, 
1816 the `real' glyph is centered horizontally (the green rectangle).
1817 \item Furthermore, the glyph is shifted according to values of fields
1818       \texttt{left} and \texttt{down}. The ultimate position of the real
1819       glyph is indicated by the red rectangle.
1820 \end{itemize}
1821 \end{minipage}
1822 \caption{The position of the `real' glyph.}
1823 \label{fig-pos}
1824 \end{figure}
1825
1826
1827 \item[kern={\{[$j$]=<kern>, ...\}}]
1828
1829 \item[glue={\{[$j$]=\{<width>, <stretch>, <shrink>\}, ...\}}]
1830 \end{list}
1831
1832 %<*en>
1833 \begin{list}{}{\def\makelabel{\ttfamily}\def\{{\char`\{}\def\}{\char`\}}}
1834 \item['lineend'] An ending of a line. 
1835 \item['diffmet'] Used at a boundary between two \textbf{JAchar}s whose JFM or size is different.
1836 \item['boxbdd'] The beginning/ending of a horizontal box, and the beginning of a noindented paragraph.
1837 \item['parbdd'] The beginning of an (indented) paragraph.
1838 \item['jcharbdd'] A boundary between \textbf{JAchar} and anything else
1839              (such as \textbf{ALchar}, kern, glue, ...).
1840 \item[$-1$] The left/right boundary of an inline math formula.
1841 \end{list}
1842 %</en>
1843
1844 %<*ja>
1845 上で説明した通り,\texttt{chars}フィールド中にはいくつかの「特殊文字」も
1846 指定可能である.これらは,大半が\pTeX のJFMグルーの挿入処理ではみな「文字
1847 クラス0の文字」として扱われていた文字であり,その結果として\pTeX より細か
1848 い組版調整ができるようになっている.以下のその一覧を述べる:
1849 \begin{list}{}{\def\makelabel{\ttfamily}\def\{{\char`\{}\def\}{\char`\}}}
1850 \item['lineend'] 行の終端を表す.
1851 \item['diffmet'] 
1852
1853 \item['boxbdd'] hboxの先頭と末尾,及びインデントされていない
1854              (\verb+\noindent+で開始された)段落の先頭を表す.
1855 \item['parbdd'] 通常の(\verb+\noindent+で開始されていない)段落の先頭.
1856 \item['jcharbdd'] 和文文字と「その他のもの」(欧文文字,glue,kern等)との境界.
1857 \item[$-1$] 行中数式と地の文との境界.
1858 \end{list}
1859
1860 \paragraph{\pTeX 用和文フォントメトリックの移植}
1861 以下に,\pTeX 用和文フォントメトリックを\LuaTeX-ja用に移植する場合の注意点を挙げておく.
1862 \begin{itemize}
1863 \item 実際に出力される和文フォントのサイズがdesign sizeとなる.
1864 このため,例えば$1\,\textrm{zw}$がdesign sizeの0.962216倍であるJISフォン
1865       トメトリック等を移植する場合は,
1866 \begin{itemize}
1867 \item JFM中の全ての数値を$1/0.962216$倍しておく.
1868 \item \TeX ソース中で使用するところで,サイズ指定を0.962216倍にする.
1869       \LaTeX でのフォント宣言なら,例えば次のように:
1870 \begin{verbatim}
1871 \DeclareFontShape{JY3}{mc}{m}{n}{<-> s*[0.962216] psft:Ryumin-Light:jfm=jis}{}
1872 \end{verbatim}
1873 \end{itemize}
1874 \item 上に述べた特殊文字は,\texttt{'boxbdd'}を除き文字クラスを全部0とする
1875       (JFM中に単に書かなければよい).
1876 \item \texttt{'boxbdd'}については,それのみで一つの文字クラスを形成し,その
1877       文字クラスに関してはglue/kernの設定はしない.
1878
1879 これは,\pTeX では,
1880       hboxの先頭・末尾とインデントされていない(\verb+\noindent+で開始さ
1881       れた)段落の先頭にはJFMグルーは入らないという仕様を実現させるためである.
1882 \item \pTeX の組版を再現させようというのが目的であれば以上の注意を守れば十分である.
1883
1884 ところで,\pTeX では通常の段落の先頭にJFMグルーが残るという仕様があるので,
1885       段落先頭の開き括弧は全角二分下がりになる.全角下がりを実現させるに
1886       は,段落の最初に手動で\verb+\inhibitglue+を追加するか,あるいは
1887       \verb+\everypar+のhackを行い,それを自動化させるしかなかった.
1888
1889 一方,\LuaTeX-jaでは,\texttt{'parbdd'}によって,それがJFM側で調整できるよ
1890 うになった.例えば,\LuaTeX-ja同梱のJFMのように,\texttt{'boxbdd'}と同じ文字クラスに
1891 \texttt{'parbdd'}を入れれば全角下がりとなる.
1892
1893 \ltjsetparameter{jacharrange={+3}}
1894 \begin{LTXexample}
1895 \jfont\g=psft:Ryumin-Light:jfm=test \g
1896 \parindent1\zw\noindent{}◆◆◆◆◆
1897 \par{}「◆◆←二分下がり
1898 \par{}【◆◆←全角下がり
1899 \par{}〔◆◆←全角二分下がり
1900 \end{LTXexample}
1901 \end{itemize}
1902 \ltjsetparameter{jacharrange={-3}}
1903 %</ja>
1904
1905 %<en>\subsection{Math Font Family}
1906 %<ja>\subsection{数式フォントファミリ}
1907 \TeX\ handles fonts in math formulas by 16~font families\footnote{Omega,
1908 Aleph, \LuaTeX~and $\varepsilon$-\kern-.125em(u)\pTeX can handles 256~families, but
1909 an external package is needed to support this in plain \TeX\ and
1910 \LaTeX.}, and each family has three fonts:
1911 \verb+\textfont+, \verb+\scriptfont+ and \verb+\scriptscriptfont+.
1912
1913 \LuaTeX-ja's handling of Japanese fonts in math formulas is similar;
1914 Table~\ref{tab-math} shows counterparts to \TeX's primitives for math
1915 font families. There is no relation between the value of
1916 \verb+\fam+ and that of \verb+\jfam+; with appropriate settings, 
1917 you can set both \verb+\fam+ and \verb+\jfam+ to~the same value.
1918
1919 \begin{table}[!tb]
1920 \caption{Primitives for Japanese math fonts.}
1921 \label{tab-math}
1922 \begin{center}\def\{{\char`\{}\def\}{\char`\}}
1923 \begin{tabular}{lll}
1924 \toprule
1925 &Japanese fonts&alphabetic fonts\\
1926 \midrule
1927 font family&\verb+\jfam+${}\in [0,256)$&\verb+\fam+\\
1928 text size&\tt\Param{jatextfont}\,=\{<jfam>,<jfont\_cs>\}&\tt\verb+\textfont+<fam>=<font\_cs>\\
1929 script size&\tt\Param{jascriptfont}\,=\{<jfam>,<jfont\_cs>\}&\tt\verb+\scriptfont+<fam>=<font\_cs>\\
1930 scriptscript size&\tt\Param{jascriptscriptfont}\,=\{<jfam>,<jfont\_cs>\}&\tt\verb+\scriptscriptfont+<fam>=<font\_cs>\\
1931 \bottomrule
1932 \end{tabular}
1933 \end{center}
1934 \end{table}
1935
1936 %<en>\subsection{Callbacks}
1937 %<ja>\subsection{コールバック}
1938 Like \LuaTeX\ itself, \LuaTeX-ja also has callbacks. These callbacks can
1939 be accessed via \verb+luatexbase.add_to_callback+ function and so on, as other callbacks
1940 \begin{list}{}%
1941 {\def\makelabel#1{\bfseries#1}}
1942 \item[\texttt{luatexja.load\_jfm} callback]
1943 With this callback you can overwrite JFMs. 
1944 This callback is called when a new JFM is loaded.
1945
1946 \begin{verbatim}
1947 function (<table> jfm_info, <string> jfm_name)
1948   return <table> new_jfm_info
1949 end
1950 \end{verbatim}
1951
1952 The argument \verb+jfm_info+ contains a table similar to the table in a JFM file, except 
1953 this argument has \texttt{chars} field which contains character codes
1954              whose character class is not~0.
1955
1956 An example of this callback is the \texttt{ltjarticle} class, with
1957              forcefully assigning character class~0 to \texttt{'parbdd'}
1958              in the JFM \texttt{jfm-min.lua}. This callback doesn't
1959              replace any code of \LuaTeX-ja.
1960
1961 \item[\texttt{luatexja.define\_font} callback]
1962 This callback and the next callback form a pair, and you can assign letters which don't have
1963              fixed code points in Unicode to non-zero character classes.
1964 This \texttt{luatexja.define\_font} callback is called just when new Japanese font is loaded.
1965 \begin{verbatim}
1966 function (<table> jfont_info, <number> font_number)
1967   return <table> new_jfont_info
1968 end
1969 \end{verbatim}
1970
1971 You may assume that \verb+jfont_info+ has the following fields:
1972 \begin{description}
1973 \item[\tt jfm] The index number of JFM.
1974 \item[\tt size] Font size in a scaled point (${}=2^{-16}\,\textrm{pt}$).
1975 \item[\tt var] The value specified in \texttt{jfmvar=...} at a call of \verb+\jfont+.
1976 \end{description}
1977
1978 The returned table \verb+new_jfont_info+ also should include these three fields. 
1979 The \verb+font_number+ is a font number. 
1980
1981 A good example of this and the next callbacks is the \Pkg{luatexja-otf}
1982              package, supporting \verb+"AJ1-xxx"+ form for Adobe-Japan1
1983              CID characters in a JFM. This callback doesn't replace any
1984              code of \LuaTeX-ja.
1985
1986
1987 \item[\texttt{luatexja.find\_char\_class} callback]
1988 This callback is called just when \LuaTeX-ja inready to determine which
1989              character class a character \verb+chr_code+ belongs.
1990 A function used in this callback should be in the following form:
1991 \begin{lstlisting}[numbers=left]
1992 function (<number> char_class, <table> jfont_info, <number> chr_code)
1993   if char_class~=0 then return char_class
1994   else
1995     ....
1996     return (<number> new_char_class or 0)
1997   end
1998 end
1999 \end{lstlisting}
2000
2001 The argument \verb+char_class+ is the result of \LuaTeX-ja's default
2002              routine or previous function calls in this callback, hence
2003              this argument may not be 0. Moreover, the returned
2004              \verb+new_char_class+ should be as same as \verb+char_class+ when \verb+char_class+
2005              is not~0, otherwise you will overwrite the \LuaTeX-ja's
2006              default routine.
2007
2008 This callback doesn't replace any code of \LuaTeX-ja.
2009
2010 \item[\texttt{luatexja.set\_width} callback]
2011 This callback is called when \LuaTeX-ja is trying to encapsule a
2012              \textbf{JAchar} \textit{glyph\_node}, to adjust its
2013              dimension and position.
2014 \begin{lstlisting}[numbers=left]
2015 function (<table> shift_info, <table> jfont_info, <number> char_class)
2016   return <table> new_shift_info
2017 end
2018 \end{lstlisting}
2019
2020 The argument \verb+shift_info+ and the returned \verb+new_shift_info+ have 
2021 \texttt{down} and \texttt{left} fields, which are the amount of shifting
2022              down/left the character in a scaled-point.
2023
2024 %<*ja>
2025 良い例が\Pkg{test/valign.lua}である.このファイルが読み込まれた状態では,
2026              JFM内で規定された文字クラス0の文字における$(\hbox{高
2027              さ}):(\hbox{深さ})$の比になるように,実際のフォントの出力上
2028              下位置が自動調整される.例えば,
2029 \begin{itemize}
2030 \item JFM側の設定:$(\hbox{高さ})=88x$, $(\hbox{深さ})=12x$%
2031 (和文OpenTypeフォントの標準値)
2032 \item 実フォント側の数値:$(\hbox{高さ})=28y$, $(\hbox{深さ})=5y$(和文TrueTypeフォントの標準値)
2033 \end{itemize}
2034 となっていたとする.すると,実際の文字の出力位置は,
2035 \[
2036  \frac{88x}{88x+12x} (28y+5y) - 28y = \frac{26}{825}y= 0.03\dot1\dot5y
2037 \]
2038 だけ上にずらされることになる,
2039 %</ja>
2040 \end{list}
2041
2042
2043
2044 %<en>\section{Parameters}
2045 %<ja>\section{パラメータ}
2046 %<en>\subsection{\texttt{\char92 ltjsetparameter} primitive}
2047 %<ja>\subsection{\texttt{\char92 ltjsetparameter} プリミティブ}
2048 As noted before, \verb+\ltjsetparameter+ and \verb+\ltjgetparameter+ are
2049 primitives for accessing most parameters of \LuaTeX-ja. One of the main
2050 reason that \LuaTeX-ja didn't adopted the syntax similar to that of \pTeX\ 
2051 (\textit{e.g.},~\verb+\prebreakpenalty`)=10000+) 
2052 is the position of \verb+hpack_filter+ callback in the source
2053 of \LuaTeX, see Section~\ref{sec-para}.
2054
2055 \verb+\ltjsetparameter+ and \verb+\ltjglobalsetparameter+ are primitives
2056 for assigning parameters. These take one argument which is a
2057 \texttt{<key>=<value>} list. Allowed keys are described in the next
2058 subsection.  
2059 The difference between
2060 \verb+\ltjsetparameter+ and \verb+\ltjglobalsetparameter+ is only the
2061 scope of assignment;
2062 \verb+\ltjsetparameter+ does a local assignment and 
2063 \verb+\ltjglobalsetparameter+ does a global one. 
2064 They also obey the value of \verb+\globaldefs+,
2065 like other assignment.
2066
2067 \verb+\ltjgetparameter+ is the primitive for acquiring parameters. It
2068 always takes a parameter name as first argument, and also takes the
2069 additional argument---a character code, for example---in some cases.
2070 \begin{LTXexample}
2071 \ltjgetparameter{differentjfm}, 
2072 \ltjgetparameter{autospacing},
2073 \ltjgetparameter{prebreakpenalty}{`)}.
2074 \end{LTXexample}
2075 \emph{The return value of\/ {\normalfont\tt\char92ltjgetparameter} is
2076 always a string}. This is outputted by \texttt{tex.write()}, so any
2077 character other than space~`\texttt{\char32}'~(U+0020) has the category code
2078 12~(other), while the space has 10~(space).
2079
2080 %<en>\subsection{List of Parameters}
2081 %<ja>\subsection{パラメータ一覧}
2082 The following is the list of parameters which can be specified by the
2083 \verb+\ltjsetparameter+ command. [\verb+\cs+] indicates the counterpart
2084 in \pTeX, and symbols beside each parameter has the following meaning:
2085 \begin{itemize}
2086 \item No mark: values at the end of the paragraph or the hbox are
2087       adopted in the whole paragraph/hbox.
2088 \item `\ast' : local parameters, which can change everywhere inside a paragraph/hbox.
2089 \item `\dagger': assignments are always global.
2090 \end{itemize}
2091
2092 \begin{list}{}{\def\makelabel{\ttfamily}\def\{{\char`\{}\def\}{\char`\}}}
2093 \item[\Param{jcharwidowpenalty}\,=<penalty>] [\verb+\jcharwidowpenalty+]
2094
2095 Penalty value for suppressing orphans. This penalty is inserted just
2096              after the last \textbf{JAchar} which is not regarded as a
2097              (Japanese) punctuation mark.
2098
2099 \item[\Param{kcatcode}\,=\{<chr\_code>,<natural number>\}]\
2100
2101 An additional attributes having each character whose character code is <chr\_code>.  
2102 At the present version, the lowermost bit of <natural number> indicates
2103              whether the character is considered as a punctuation mark
2104              (see the description of \Param{jcharwidowpenalty} above).
2105
2106
2107 \item[\Param{prebreakpenalty}\,=\{<chr\_code>,<penalty>\}] [\verb+\prebreakpenalty+]\ 
2108 %<*ja>
2109 文字コード<chr\_code>の\textbf{JAchar}が行頭にくることを抑止するために,
2110              この文字の前に挿入/追加されるペナルティの量を指定する.
2111
2112 例えば閉じ括弧「〗」は絶対に行頭にきてはならないので,標準で読み込まれる
2113              \texttt{luatexja-kinsoku.tex}において
2114 \begin{verbatim}
2115 \ltjsetparameter{prebreakpenalty={`〙,10000}}
2116 \end{verbatim}
2117 と,最大値の10000が指定されている.他にも,小書きのカナなど,絶対禁止とい
2118              うわけではないができれば行頭にはきて欲しくない場合に,0と
2119              10000の間の値を指定するのも有用であろう.
2120 \begin{verbatim}
2121 \ltjsetparameter{prebreakpenalty={`ゕ,150}}
2122 \end{verbatim}
2123 %</ja>
2124
2125 \item[\Param{postbreakpenalty}\,=\{<chr\_code>,<penalty>\}] [\verb+\postbreakpenalty+]
2126 %<*ja>
2127 文字コード<chr\_code>の\textbf{JAchar}が行末にくることを抑止するために,
2128              この文字の後に挿入/追加されるペナルティの量を指定する.
2129
2130 \pTeX では,\verb+\prebreakpenalty+, \verb+\postbreakpenalty+において,
2131 \begin{itemize}
2132 \item 一つの文字に対して,pre, postどちらか一つしか指定することができなかっ
2133       た(後から指定した方で上書きされる).
2134 \item pre, post合わせて256文字分の情報を格納することしかできなかった.
2135 \end{itemize}
2136 という制限があったが,\LuaTeX-ja ではこれらの制限は解消されている.
2137 %</ja>
2138
2139 \item[\Param{jatextfont}\,=\{<jfam>,<jfont\_cs>\}] [\verb+\textfont+ in \TeX]
2140 \item[\Param{jascriptfont}\,=\{<jfam>,<jfont\_cs>\}] [\verb+\scriptfont+ in \TeX]
2141 \item[\Param{jascriptscriptfont}\,=\{<jfam>,<jfont\_cs>\}] [\verb+\scriptscriptfont+ in \TeX]
2142 \item[\Param{yjabaselineshift}\,=<dimen>$^\ast$]\ 
2143 \item[\Param{yalbaselineshift}\,=<dimen>$^\ast$] [\verb+\ybaselineshift+]
2144
2145 \item[\Param{jaxspmode}\,=\{<chr\_code>,<mode>\}] [\verb+\inhibitxspcode+]
2146
2147 Setting whether inserting  \Param{xkanjiskip} is allowed before/after a \textbf{JAchar} whose character code is <chr\_code>.
2148 The followings are allowed for <mode>:
2149 \begin{description}
2150 \item[0, \texttt{inhibit}] Insertion of \Param{xkanjiskip} is inhibited before the character, nor after the character.
2151 \item[2, \texttt{preonly}] Insertion of \Param{xkanjiskip} is allowed before the character, but not after.
2152 \item[1, \texttt{postonly}] Insertion of \Param{xkanjiskip} is allowed after the character, but not before.
2153 \item[3, \texttt{allow}] Insertion of \Param{xkanjiskip} is allowed before the character and after the character.
2154 This is the default value.
2155 \end{description}
2156
2157 \item[\Param{alxspmode}\,=\{<chr\_code>,<mode>\}] [\verb+\xspcode+]
2158
2159 Setting whether inserting \Param{xkanjiskip} is allowed before/after a
2160              \textbf{ALchar} whose character code is <chr\_code>.
2161 The followings are allowed for <mode>:
2162 \begin{description}
2163 \item[0, \texttt{inhibit}] Insertion of \Param{xkanjiskip} is inhibited
2164            before the character, nor after the character.
2165 \item[1, \texttt{preonly}] Insertion of \Param{xkanjiskip} is allowed
2166            before the character, but not after.
2167 \item[2, \texttt{postonly}] Insertion of \Param{xkanjiskip} is allowed
2168            after the character, but not before.
2169 \item[3, \texttt{allow}] Insertion of \Param{xkanjiskip} is allowed both
2170            before the character and after the character.
2171 This is the default value.
2172 \end{description}
2173 Note that parameters \Param{jaxspmode} and \Param{alxspmode} use a common table.
2174
2175 \item[\Param{autospacing}\,=<bool>$^\ast$] [\verb+\autospacing+]
2176 \item[\Param{autoxspacing}\,=<bool>$^\ast$] [\verb+\autoxspacing+]
2177 \item[\Param{kanjiskip}\,=<skip>] [\verb+\kanjiskip+]
2178 \item[\Param{xkanjiskip}\,=<skip>] [\verb+\xkanjiskip+]
2179
2180 \item[\Param{differentjfm}\,=<mode>$^\dagger$]
2181
2182 Specify how glues/kerns between two \textbf{JAchar}s whose JFM (or size) are different. 
2183 The allowed arguments are the followings:
2184 \begin{description}
2185 \item[\texttt{average}]
2186 \item[\texttt{both}]
2187 \item[\texttt{large}]
2188 \item[\texttt{small}]
2189 \end{description}
2190
2191 \item[\Param{jacharrange}\,=<ranges>$^\ast$]
2192 \item[\Param{kansujichar}\,=\{<digit>, <chr\_code>\}] [\verb+\kansujichar+]
2193 \end{list}
2194
2195
2196 %<en>\section{Other Primitives}
2197 %<ja>\section{その他のプリミティブ}
2198 %<en>\subsection{Primitives for Compatibility}
2199 %<ja>\subsection{互換プリミティブ}
2200 The following primitives are implemented for compatibility with \pTeX:
2201 \begin{list}{}{\def\makelabel{\ttfamily\char92 }}
2202 \item[kuten]
2203 \item[jis]
2204 \item[euc]
2205 \item[sjis]
2206 \item[ucs]
2207 \item[kansuji]
2208 \end{list}
2209 %<en>\subsection{\texttt{\char92 inhibitglue} primitive}
2210 %<ja>\subsection{\texttt{\char92 inhibitglue} プリミティブ}
2211 The primitive \verb+\inhibitglue+ suppresses the insertion of \textbf{JAglue}.
2212 The following is an example, using a special JFM that there will be a glue between 
2213 the beginning of a box and `あ', and also between `あ' and `ウ'.
2214
2215 \begin{LTXexample}
2216 \jfont\g=psft:Ryumin-Light:jfm=test \g
2217 あウあ\inhibitglue{}ウ\inhibitglue\par
2218 あ\par\inhibitglue{}あ
2219 \par\inhibitglue\hrule{}あoff\inhibitglue ice
2220 \end{LTXexample}
2221
2222 With the help of this example, we remark the specification of \verb+\inhibitglue+:
2223 \begin{itemize}
2224 \item The call of \verb+\inhibitglue+ in the (internal) vertical mode is
2225       effective at the beginning of the next paragraph. This is realized
2226       by hacking \verb+\everypar+.
2227 \item The call of \verb+\inhibitglue+ in the (restricted) horizontal
2228       mode is only effective on the spot; does not get over boundary of
2229       paragraphs. Moreover, \verb+\inhibitglue+ cancels ligatures and
2230       kernings, as shown in line~4 of above example.
2231 \item The call of \verb+\inhibitglue+ in math mode is just ignored.
2232 \end{itemize}
2233
2234 %<en>\section{Control Sequences for \LaTeXe}
2235 %<ja>\section{\LaTeXe 用のコントロールシーケンス}
2236 %<en>\subsection{Patch for NFSS2}
2237 %<ja>\subsection{NFSS2 へのパッチ}
2238 \label{ssub-nfsspat}
2239 As described in Subsection~\ref{ssec-ltx}, \LuaTeX-ja simply adopted
2240 \texttt{plfonts.dtx} in \pLaTeXe\ for the Japanese patch for NFSS2.
2241 For an convenience, we will describe
2242 commands which are not described in Subsection~\ref{ssub-chgfnt}.
2243
2244 \begin{cslist}%
2245 \item[DeclareYokoKanjiEncoding\{<encoding>\}\{<text-settings>\}\{<math-settings>\}]
2246 In NFSS2 under \LuaTeX-ja, distinction between alphabetic font families
2247              and Japanese font families is only made by its
2248              encoding. For example, encodings OT1 and T1 are for
2249              alphabetic font families, and a Japanese font family cannot
2250              have these encodings. This command defines a new encoding
2251              scheme for Japanese font family (in horizontal direction).
2252
2253 \item[DeclareKanjiEncodingDefaults\{<text-settings>\}\{<math-settings>\}]
2254 \item[DeclareKanjiSubstitution\{<encoding>\}\{<family>\}\{<series>\}\{<shape>\}]
2255 \item[DeclareErrorKanjiFont\{<encoding>\}\{<family>\}\{<series>\}\{<shape>\}\{<size>\}]
2256
2257 The above 3~commands are just the counterparts for \verb+DeclareFontEncodingDefaults+ and~others.
2258
2259 \item[reDeclareMathAlphabet\{<unified-cmd>\}\{<al-cmd>\}\{<ja-cmd>\}]
2260 和文・欧文の数式用フォントファミリを一度に変更する命令を作成する.
2261 具体的には,欧文数式用フォントファミリ変更の命令<al-cmd>と,和文数式用フォ
2262              ントファミリ変更の命令<ja-cmd>の2つを同時に行う命令として
2263              <unified-cmd>を(再)定義する.実際の使用では<unified-cmd>と
2264              <al-cmd>に同じものを指定する,すなわち,<al-cmd>に和文側も変
2265              更させるようにするのが一般的と思われる.
2266
2267 本コマンドの使用については,\pLaTeX 配布中の\texttt{plfonts.dtx}に詳しく
2268              注意点が述べられているので,そちらを参照されたい.
2269
2270 \item[DeclareRelationFont\{<ja-encoding>\}\{<ja-family>\}\{<ja-series>\}\{<ja-shape>\}\\
2271   \hfill\{<al-encoding>\}\{<al-family>\}\{<al-series>\}\{<al-shape>\}]
2272 %<*en>
2273 This command sets the `accompanied' alphabetic font family (given by the latter 4~arguments) 
2274 with respect to a Japanese font family given by the former 4~arguments. 
2275 %</en>
2276 %<*ja>
2277 いわゆる「従属欧文」を設定するための命令である.前半の4引数で表される和文フォントファミリに対して,
2278 そのフォントに対応する「従属欧文」フォントファミリを後半の4引数により与える.
2279 %</ja>
2280 \item[SetRelationFont]
2281 This command is almost same as \verb+\DeclareRelationFont+, except that this command does a local 
2282 assignment, where \verb+\DeclareRelationFont+ does a global assignment.
2283 \item[userelfont]
2284 Change current alphabetic font encoding/family/\dots\ to the `accompanied' alphabetic
2285              font family with respect to current Japanese font family,
2286              which was set by
2287              \verb+\DeclareRelationFont+ or \verb+SetRelationFont+.
2288 Like \verb+\fontfamily+, \verb+\selectfont+ is required to take an effect.
2289
2290 \item[adjustbaseline]
2291 ...
2292
2293 \item[fontfamily\{<family>\}]
2294 {\let\item\origitem
2295 As in \LaTeXe, this command changes current font family (alphabetic, Japanese,~\emph{or both}) 
2296 to <family>. Which family will be changed is determined as follows:
2297 \begin{itemize}
2298 \item Let current encoding scheme for Japanese fonts be
2299       <ja-enc>. Current Japanese font family will be changed to
2300       <family>, if one of the following two conditions is met:
2301 \begin{itemize}
2302 \item The family <fam> under the encoding <ja-enc> is already defined by
2303       \verb+\DeclareKanijFamily+.
2304 \item A font definition named \texttt{<enc><ja-enc>.fd} (the file name is
2305       all lowercase) exists.
2306 \end{itemize}
2307 \item Let current encoding scheme for Japanese fonts be
2308       <al-enc>. For alphabetic font family, the criterion as above is used.
2309 \item There is a case which none of the above applies, that is, the font
2310       family named <family> doesn't seem to be defined neither under the
2311       encoding <ja-enc>, nor under <al-enc>. 
2312
2313 In this case, the default family for font substitution is used for
2314       alphabetic and Japanese fonts. Note that current encoding will not
2315       be set to <family>, unlike the original implementation in \LaTeX.
2316 \end{itemize}
2317 }
2318 \end{cslist}
2319
2320 As closing this subsection, we shall introduce an example of
2321 \verb+SetRelationFont+ and \verb+\userelfont+:
2322 \begin{LTXexample}
2323 \gtfamily{}あいうabc
2324 \SetRelationFont{JY3}{gt}{m}{n}{OT1}{pag}{m}{n}
2325 \userelfont\selectfont{}あいうabc
2326 \end{LTXexample}
2327
2328
2329 %<en>\subsection{Cropmark/`tombow'}
2330 %<ja>\subsection{トンボ}
2331
2332 %<en>\section{Extensions}
2333 %<ja>\section{拡張}
2334 \subsection{\texttt{luatexja-fontspec.sty}}
2335
2336 \subsection{\texttt{luatexja-otf.sty}}
2337 This optional package supports typesetting characters in
2338 Adobe-Japan1. \texttt{luatexja-otf.sty} offers the following 2~low-level
2339 commands:
2340 \begin{list}{}{\def\makelabel{\ttfamily}\def\{{\char`\{}\def\}{\char`\}}}
2341 \item[\char92CID\{<number>\}]
2342 Typeset a character whose CID number is <number>.
2343 \item[\char92UTF\{<hex\_number>\}]
2344 Typeset a character whose character code is <hex\_number> (in hexadecimal).
2345 This command is similar to \verb+\char"+<hex\_number>,\ %"
2346 but please remind remarks below.
2347 \end{list}
2348
2349 \paragraph{Remarks}
2350 Characters by \verb+\CID+ and \verb+\UTF+ commands are different from
2351 ordinary characters in the following points:
2352 \begin{itemize}
2353 \item Always treated as \textbf{JAchar}s.
2354 \item Processing codes for supporting OpenType features (\textit{e.g.},
2355       glyph replacement and kerning) by the \Pkg{luaotfload} package
2356       is not performed to these characters.
2357 \end{itemize}
2358
2359
2360 \paragraph{Additionally Syntax of JFM}
2361 \texttt{luatexja-otf.sty} extends the syntax of JFM; the entries of \texttt{
2362 chars} table in JFM now allows a string in the form
2363 \verb+'AJ1-xxx'+, which stands for the character 
2364 whose CID number in Adobe-Japan1 is \verb+xxx+. 
2365
2366 %<en>\part{Implementations}
2367 %<ja>\part{実装}
2368 \label{part-imp}
2369 %<en>\section{Storing Parameters}
2370 %<ja>\section{パラメータの保持}
2371 \label{sec-para}
2372 %<en>\subsection{Used Dimensions, Attributes and whatsit nodes}
2373 %<ja>\subsection{用いられる寸法レジスタ,属性レジスタ,whatsit ノード}
2374 Here the following is the list of dimensions and attributes which are used in \LuaTeX-ja.
2375 \begin{list}{}{%
2376 \def\makelabel{\ttfamily}
2377 \def\dim#1{\item[\char92 #1\ \textrm{(dimension)}]}
2378 \def\attr#1{\item[\char92 #1\ \textrm{(attribute)}]}
2379 }
2380
2381 \dim{jQ}
2382 As explained in Subsection~\ref{ssec-plain}, \verb+\jQ+ is equal to
2383                         $1\,\textrm{Q}=0.25\,\textrm{mm}$, where `Q'~(also called `級') is
2384                         a unit used in Japanese phototypesetting. So one should not change the value of this dimension. 
2385 \dim{jH}
2386 There is also a unit called `歯' which equals to $0.25\,\textrm{mm}$ and
2387                         used in Japanese phototypesetting. This
2388                         \verb+\jH+ is a synonym of \verb+\jQ+.
2389 \dim{ltj@zw} A temporal register for the `full-width' of current Japanese font.
2390 \dim{ltj@zh} A temporal register for the `full-height' (usually the sum of height of imaginary body and its depth) of current Japanese font.
2391 \attr{jfam} Current number of Japanese font family for math formulas.
2392 \attr{ltj@curjfnt} The font index of current Japanese font.
2393 \attr{ltj@charclass} The character class of Japanese \textit{glyph\_node}.
2394 \attr{ltj@yablshift} The amount of shifting the baseline of alphabetic
2395                         fonts in scaled point ($2^{-16}\,\textrm{pt}$).
2396 \attr{ltj@ykblshift} The amount of shifting the baseline of Japanese
2397                         fonts in scaled point ($2^{-16}\,\textrm{pt}$).
2398 \attr{ltj@autospc} Whether the auto insertion of \Param{kanjiskip} is allowed at the node.
2399 \attr{ltj@autoxspc} Whether the auto insertion of \Param{xkanjiskip} is allowed at the node.
2400 \attr{ltj@icflag} An attribute for distinguishing `kinds' of a node. One of the following value is
2401                         assigned to this attribute:
2402 \begin{description}
2403 \item[\textit{italic} (1)] Glues from an italic correction
2404            (\verb+\/+). This distinction of origins of glues 
2405            (from explicit \verb+\kern+, or from \verb+\/+)
2406            is needed in the insertion process of \Param{xkanjiskip}.
2407 \item[\textit{packed} (2)] 
2408 \item[\textit{kinsoku} (3)] Penalties inserted for the word-wrapping  process of Japanese characters (\emph{kinsoku}).
2409 \item[\textit{from\_jfm} (4)] Glues/kerns from JFM.
2410 \item[\textit{line\_end} (5)] Kerns for ...
2411 \item[\textit{kanji\_skip} (6)] Glues for \Param{kanjiskip}.
2412 \item[\textit{xkanji\_skip} (7)] Glues for \Param{xkanjiskip}.
2413 \item[\textit{processed} (8)] Nodes which is already processed by ...
2414 \item[\textit{ic\_processed} (9)] Glues from an italic correction, but also already processed.
2415 \item[\textit{boxbdd} (15)] Glues/kerns that inserted just the beginning or the ending of an hbox or a paragraph.
2416 \end{description}
2417 \attr{ltj@kcat$i$} Where $i$~is a natural number which is less than~7.
2418 These 7~attributes store bit~vectors indicating which character block is regarded as a block of \textbf{JAchar}s.
2419 \end{list}
2420
2421 Furthermore, \LuaTeX-ja uses several `user-defined' whatsit nodes for
2422 typesetting. All those nodes store a natural number (hence the node's
2423 \texttt{type} is 100).
2424 \begin{description}
2425 \item[30111] Nodes for indicating that \verb+\inhibitglue+ is
2426            specified. The \texttt{value} field of these nodes doesn't matter.
2427 \item[30112] Nodes for \LuaTeX-ja's stack system (see the next
2428            subsection). The \texttt{value} field of these nodes is
2429            current group.
2430 \item[30113] Nodes for Japanese Characters which the callback process of
2431            luaotfload won't be applied, and the character code is
2432            stored in the \texttt{value} field. Each node having this
2433            \verb+user_id+ is converted to a `glyph\_node' \emph{after}
2434            the callback process of luaotfload.
2435 \end{description}
2436 These whatsits will be removed during the process of inserting \textbf{JAglue}s.
2437
2438 %<en>\subsection{Stack System of \LuaTeX-ja}
2439 %<ja>\subsection{\LuaTeX-ja のスタックシステム}
2440 \label{ssec-stack}
2441 \paragraph{Background}
2442 \LuaTeX-ja has its own stack system, and most parameters of \LuaTeX-ja
2443 are stored in it.  To clarify the reason, imagine the parameter
2444 \Param{kanjiskip} is stored by a skip, and consider the following
2445 source:
2446 \begin{LTXexample}
2447 \ltjsetparameter{kanjiskip=0pt}ふがふが.%
2448 \setbox0=\hbox{\ltjsetparameter{kanjiskip=5pt}ほげほげ}
2449 \box0.ぴよぴよ\par
2450 \end{LTXexample}
2451
2452 As described in Part~\ref{part-ref}, the only effective value of
2453 \Param{kanjiskip} in an hbox is the latest value, so the value of
2454 \Param{kanjiskip} which applied in the entire hbox should be 5\,pt.
2455 However, by the implementation method of \LuaTeX, this `5\,pt' cannot be
2456 known from any callbacks.  In the \texttt{tex/packaging.w} (which is a
2457 file in the source of \LuaTeX), there are the following codes:
2458 \begin{lstlisting}
2459 void package(int c)
2460 {
2461     scaled h;                   /* height of box */
2462     halfword p;                 /* first node in a box */
2463     scaled d;                   /* max depth */
2464     int grp;
2465     grp = cur_group;
2466     d = box_max_depth;
2467     unsave();
2468     save_ptr -= 4;
2469     if (cur_list.mode_field == -hmode) {
2470         cur_box = filtered_hpack(cur_list.head_field,
2471                                  cur_list.tail_field, saved_value(1),
2472                                  saved_level(1), grp, saved_level(2));
2473         subtype(cur_box) = HLIST_SUBTYPE_HBOX;
2474 \end{lstlisting}
2475 Notice that \verb+unsave+ is executed \emph{before}
2476 \verb+filtered_hpack+ (this is where \verb+hpack_filter+ callback is
2477 executed): so `5\,pt' in the above source is orphaned at
2478 \texttt+unsave+, and hence it can't be accessed from \verb+hpack_filter+
2479 callback.
2480
2481 \paragraph{The method}
2482 The code of stack system is based on that in a post of Dev-luatex mailing list\footnote{%
2483 \texttt{[Dev-luatex] tex.currentgrouplevel}, a post at 2008/8/19 by Jonathan Sauer.}.
2484
2485 These are two \TeX\ count registers for maintaining information:
2486 \verb+\ltj@@stack+ for the stack level, and \verb+\ltj@@group@level+ for
2487 the \TeX's group level when the last assignment was done.  Parameters
2488 are stored in one big table named \texttt{charprop\_stack\_table}, where
2489 \texttt{charprop\_stack\_table[$i$]} stores data of stack level~$i$. If
2490 a new stack level is created by \verb+\ltjsetparameter+, all data of the
2491 previous level is copied.
2492
2493 To resolve the problem mentioned in `Background' above, \LuaTeX-ja uses
2494 another thing: When a new stack level is about to be created, a whatsit
2495 node whose type, subtype and value are 44~(\textit{user\_defined}),
2496 30112, and current group level respectively is appended to the current
2497 list (we refer this node by \textit{stack\_flag}). This enables us to
2498 know whether assignment is done just inside a hbox. Suppose that the
2499 stack level is~$s$ and the \TeX's group level is~$t$ just after the hbox
2500 group, then:
2501 \begin{itemize}
2502 \item If there is no \textit{stack\_flag} node in the list of hbox, then
2503       no assignment was occurred inside the hbox. Hence values of
2504       parameters at the end of the hbox are stored in the stack
2505       level~$s$.
2506 \item If there is a \textit{stack\_flag} node whose value is~$t+1$, then
2507       an assignment was occurred just inside the hbox group. Hence
2508       values of parameters at the end of the hbox are stored in the
2509       stack level~$s+1$.
2510 \item If there are \textit{stack\_flag} nodes but all of their values
2511       are more than~$t+1$, then an assignment was occurred in the box,
2512       but it is done is `more internal' group. Hence values of
2513       parameters at the end of the hbox are stored in the stack
2514       level~$s$.
2515 \end{itemize}
2516
2517 Note that to work this trick correctly, assignments to
2518 \verb+\ltj@@stack+ and \verb+\ltj@@group@level+ have to be local always, 
2519 regardless the value of \verb+\globaldefs+.
2520 This problem is resolved by using
2521 \hbox{\verb+\directlua{tex.globaldefs=0}+} (this assignment is local).
2522
2523
2524 %<en>\section{Linebreak after Japanese Character}
2525 %<ja>\section{和文文字直後の改行}
2526 \label{sec-lbreak}
2527 %<en>\subsection{Reference: Behavior in \pTeX}
2528 %<ja>\subsection{参考: \pTeX の挙動}
2529 %<*en>
2530 In~\pTeX, a line break after a Japanese character doesn't emit a space,
2531 since words are not separated by spaces in Japanese writings. However,
2532 this feature isn't fully implemented in \LuaTeX-ja due to the
2533 specification of callbacks in~\LuaTeX. To clarify the difference between
2534 \pTeX~and~\LuaTeX, We briefly describe the handling of a line break in~\pTeX, in
2535 this subsection. 
2536
2537 \pTeX's input processor can be described in terms of a finite state
2538 automaton, as that of~\TeX\ in~Section~2.5 of~\cite{texbytopic}. The
2539 internal states are as follows:
2540 \begin{itemize}
2541 \item State~$N$: new line
2542 \item State~$S$: skipping spaces
2543 \item State~$M$: middle of line
2544 \item State~$K$: after a Japanese character
2545 \end{itemize}
2546 The first three states---$N$, $S$~and~$M$---are as same as \TeX's input
2547 processor.  State~$K$ is similar to state~$M$, and is entered after
2548 Japanese characters.  The diagram of state transitions are indicated in
2549 Figure~\ref{fig-ptexipro}.  Note that \pTeX\ doesn't leave state~$K$
2550 after `beginning/ending of a group' characters.
2551 %</en>
2552
2553 %<*ja>
2554 欧文では文章の改行は単語間でしか行わない.そのため,\TeX では,(文字の直後の)改行は
2555 空白文字と同じ扱いとして扱われる.一方,和文ではほとんどどどこでも改行が可能なため,
2556 \pTeX では和文文字の直後の改行は単純に無視されるようになっている.
2557
2558 このような動作は,\pTeX が\TeX からエンジンとして拡張されたことによって可能になったことである.
2559 \pTeX の入力処理部は,\TeX におけるそれと同じように,有限オートマトンとして記述することができ,
2560 以下に述べるような4状態を持っている.
2561
2562 \begin{itemize}
2563 \item State~$N$: 行の開始.
2564 \item State~$S$: 空白読み飛ばし.
2565 \item State~$M$: 行中.
2566 \item State~$K$: 行中(和文文字の後).
2567 \end{itemize}
2568 また,状態遷移は,図~\ref{fig-ptexipro} のようになっており,図中の数字は
2569 カテゴリーコードを表している.最初の3状態は\TeX の入力処理部と同じであり,
2570 図中から状態$K$と「$j$」と書かれた矢印を取り除けば,\TeX の入力処理部と同
2571 じものになる.
2572
2573 この図から分かることは,
2574 \begin{quote}
2575 行が和文文字(とグループ境界文字)で終わっていれば,改行は無視される
2576 \end{quote}
2577 ということである.
2578 %</ja>
2579
2580 \begin{figure}[!tb]
2581 \begin{gather*}
2582  \def\sp{\texttt{\char32}}
2583  \xymatrix{&&
2584    {\text{scan a cs}}\ar@(r,ul)[dr]&\\
2585 \ar[r]&
2586    *++[o][F-]{N}\ar[ur]^0\ar[dd]_{d,\ g}\ar[u]^{5\ (\texttt{\char92par})}
2587      \ar@{->}@(d,l)[ddrr]_(0.45){j}&&
2588    *++[o][F-]{S}\ar@(l,dr)[ul]^0\ar@(l,ur)[ddll]_{d,\ g}\ar[u]_{5}
2589      \ar@{->}@(r,r)[dd]^{j}\\&\\&
2590    *++[o][F-]{M}\ar[uuur]^0\ar@(r,dl)[uurr]_(0.55){10\ (\sp)}
2591      \ar[d]_{5\ ({\sp})}\ar@{->}@(dr,dl)[rr]_{j}&&
2592    *++[o][F-]{K}\ar@{->}@(ul,d)[uuul]^0\ar@{->}[ll]^{d}
2593      \ar@{->}@(ur,dr)[uu]^{10\ (\sp)}\ar@{->}[d]_5\\
2594    &&&
2595  }\\
2596  d:=\{3,4,6,7,8,11,12,13\},\quad g:=\{1,2\},\quad j:=(\text{Japanese characters})
2597 \end{gather*}
2598 \begin{itemize}
2599 \item Numbers represent category codes.
2600 \item Category codes 9~(ignored), 14~(comment)~and~15~(invalid) are omitted in above diagram.
2601 \end{itemize}
2602 \caption{State transitions of \pTeX's input processor.}
2603 \label{fig-ptexipro}
2604 \end{figure}
2605
2606
2607 %<en>\subsection{Behavior in \LuaTeX-ja}
2608 %<ja>\subsection{\LuaTeX-ja の挙動}
2609 %<*en>
2610 States in the input processor of \LuaTeX\ is the same as that of \TeX,
2611 and they can't be customized by any callbacks. Hence, we can only use
2612 \verb+process_input_buffer+ and \verb+token_filter+ callbacks for to
2613 suppress a space by a line break which is after Japanese characters.
2614
2615 However, \verb+token_filter+ callback cannot be used either, since a
2616 character in category code 5~(end-of-line) is converted into an space
2617 token \emph{in the input processor}.  So we can use only the
2618 \verb+process_input_buffer+ callback.  This means that suppressing a
2619 space must be done \emph{just before} an input line is read.
2620
2621 Considering these situations, handling of an end-of-line in \LuaTeX-ja are as follows:
2622 \begin{quote}
2623 A character U+FFFFF (its category code is set to 14~(comment) by
2624 \LuaTeX-ja) is appended to an input line, \emph{before \LuaTeX\ actually
2625 process it}, if and only if the following two conditions are satisfied:
2626 \begin{enumerate}
2627 \item The category code of the character $\langle${return}$\rangle$
2628       (whose character code is 13) is 5~(end-of-line).
2629 \item The input line matches the following `regular expression':
2630 \[
2631   (\text{any char})^*(\textbf{JAchar})
2632   \bigl(\{\text{catcode}=1\}\cup\{\text{catcode}=2\}\bigr)^*
2633 \]
2634 \end{enumerate}
2635 \end{quote}
2636
2637 \paragraph{Remark}
2638 The following example shows the major difference from the behavior of \pTeX:
2639 \begin{LTXexample}
2640 \ltjsetparameter{autoxspacing=false}
2641 \ltjsetparameter{jacharrange={-6}}xあ
2642 y\ltjsetparameter{jacharrange={+6}}zあ
2643 u
2644 \end{LTXexample}
2645 \begin{itemize}
2646 \item There is no space between `x' and `y', since the line~2 ends with a \textbf{JAchar} `あ'
2647 (this `あ' considered as an \textbf{JAchar} at the ending of line~1).
2648 \item There is no space between `あ' (in the line~3) and `u', since the
2649       line~3 ends with an \textbf{ALchar}
2650 (the letter `あ' considered as an \textbf{ALchar} at the ending of line~2).
2651 \end{itemize}
2652 %</en>
2653
2654 %<*ja>
2655 \LuaTeX の入力処理部は\TeX のそれと全く同じであり,callbackによりユーザが
2656 カスタマイズすることはできない.このため,改行抑制の目的でユーザが利用で
2657 きそうなcallbackとしては,\verb+process_input_buffer+や
2658 \verb+token_filter+に限られてしまう.しかし,\TeX の入力処理部をよく見る
2659 と,後者も役には経たないことが分かる:改行文字は,入力処理部によってトー
2660 クン化される時に,カテゴリーコード10の32番文字へと置き換えられてしまうた
2661 め,\verb+token_filter+で非標準なトークン読み出しを行おうとしても,空白文
2662 字由来のトークンと,改行文字由来のトークンは区別できないのだ.
2663
2664 すると,我々のとれる道は,\verb+process_input_buffer+を用いて
2665 \LuaTeX の入力処理部に引き渡される前に入力文字列を編集するというものしかない.
2666 以上を踏まえ,\LuaTeX-jaにおける「和文文字直後の改行抑制」の処理は,次のようになっている:
2667
2668 \begin{quote}
2669 各入力行に対し,\textbf{その入力行が読まれる前の内部状態で}
2670 以下の2条件が満たされている場合,\LuaTeX-jaはU+FFFFF番の文字
2671 \footnote{この文字はコメント文字として扱われるように\LuaTeX-ja内部で設定をしている.}
2672 を末尾に追加する.よって,その場合に改行は空白とは見做されないこととなる.
2673 \begin{enumerate}
2674 \item 改行文字(文字コード13番)のカテゴリーコードが5~(end-of-line)である.
2675 \item 入力行は次の「正規表現」にマッチしている:
2676 \[
2677   (\text{any char})^*(\textbf{JAchar})
2678   \bigl(\{\text{catcode}=1\}\cup\{\text{catcode}=2\}\bigr)^*
2679 \]
2680 \end{enumerate}
2681 \end{quote}
2682
2683 この仕様は,前節で述べた\pTeX の仕様にできるだけ近づけたものとなっている.最初の条件は,
2684 \texttt{verbatim}系環境などの日本語対応マクロを書かなくてすませるためのものである.
2685 しかしながら,完全に同じ挙動が実現できたわけではない.
2686 差異は,次の例が示すように,和文文字の範囲を変更した行の改行において見られる:
2687 \begin{LTXexample}
2688 \ltjsetparameter{autoxspacing=false}
2689 \ltjsetparameter{jacharrange={-6}}xあ
2690 y\ltjsetparameter{jacharrange={+6}}zあ
2691 u
2692 \end{LTXexample}
2693 もし\pTeX とまったく同じ挙動を示すならば,出力は
2694 「\hbox{\ltjsetparameter{autoxspacing=false}x yzあu}」となるべきである.しかし,実際には
2695 上のように異なる挙動となっている.
2696 \begin{itemize}
2697 \item 2行目は「あ」という和文文字で終わる(2行目を処理する前の時点では,
2698       「あ」は和文文字扱いである)ため,直後の改行文字は無視される.
2699 \item 3行目は「あ」という欧文文字で終わる(2行目を処理する前の時点では,
2700       「あ」は欧文文字扱いである)ため,直後の改行文字は空白に置き換わる.
2701 \end{itemize}
2702 このため,トラブルを避けるために,和文文字の範囲を\verb+\ltjsetparameter+で編集した場合,
2703 その行はそこで改行するようにした方がいいだろう.
2704 %</ja>
2705
2706
2707 %<en>\section{Insertion of JFM glues, \Param{kanjiskip} and \Param{xkanjiskip}}
2708 %<ja>\section{JFM グルーの挿入,\Param{kanjiskip} と \Param{xkanjiskip}}
2709 %<en>\subsection{Overview}
2710 %<ja>\subsection{概要}
2711 %<*en>
2712 NOT COMPLETED
2713 %</en>
2714
2715 %<*ja>
2716 \LuaTeX-ja における和文処理グルーの挿入方法は,\pTeX のそれとは全く異なる.
2717 \pTeX では次のような仕様であった:
2718 \begin{itemize}
2719 \item JFMグルーの挿入は,和文文字を表すトークンを元に水平リストに(文字を表す)<char\_node>を
2720 追加する過程で行われる.
2721 \item \Param{xkanjiskip}の挿入は,hboxへのパッケージングや行分割前に行われる.
2722 \item \Param{kanjiskip}はノードとしては挿入されない.パッケージングや行分割の計算時に
2723 「和文文字を表す2つの<char\_node>の間には\Param{kanjiskip}がある」ものとみなされる.
2724 \end{itemize}
2725 しかし,\LuaTeX-jaでは,hboxへのパッケージングや行分割前に全ての
2726 \textbf{JAglue},即ちJFMグルー・\Param{xkanjiskip}・\Param{kanjiskip}の
2727 3種類を一度に挿入することになっている.これは,\LuaTeX において欧文の合字・
2728 カーニング処理がノードベースになったことに対応する変更である.
2729
2730 \LuaTeX-jaにおける\textbf{JAglue}挿入処理では,下の図\ref{fig-clu}のよう
2731 に「塊」を単位にして行われる.大雑把にいうと,「塊」は文字とそれに付随す
2732 るノード達(アクセント位置補正用のkernや,イタリック補正)をまとめたもの
2733 であり,2つの塊の間には,ペナルティ,\verb+\vadjust+,whatsitなど,行組版
2734 には関係しないものがある.そのため,……
2735 %</ja>
2736
2737 % \begin{figure}[!tb]
2738 % \unitlength=10mm
2739 % \end{figure}
2740
2741 %<en>\subsection{Definition of a `cluster'}
2742 %<ja>\subsection{「クラスタ」の定義}
2743
2744 \begin{defn}
2745 A \emph{cluster} is a list of nodes in one of the following forms, with the \textit{id} of it:
2746 \begin{enumerate}
2747 \item Nodes whose value of\ \verb+\ltj@icflag+ is in $[3,15)$.  These
2748       nodes come from a hbox which is already packaged, by unpackaging
2749       (\verb+\unhbox+).
2750       The \textit{id} is \textit{id\_pbox}.
2751 \item A inline math formula, including two \textit{math\_node}s at the boundary of it:
2752 HOGE
2753       The \textit{id} is \textit{id\_math}.
2754 \item A \textit{glyph\_node} with nodes which relate with it: 
2755 HOGE
2756 The \textit{id} is \textit{id\_jglyph} or
2757 \textit{id\_glyph}, according to whether the \textit{glyph\_node}
2758 represents a Japanese character or not.
2759 \item An box-like node, that is, an hbox, an vbox and an rule (\verb+\vrule+). 
2760 The \textit{id} is \textit{id\_hlist} if the node is an
2761       hbox which is not shifted vertically, or \textit{id\_box\_like}
2762       otherwise.
2763 \item A glue, a kern whose subtype is not 2~(\textit{accent}), and a discretionary break.
2764 The \textit{id} is \textit{id\_glue}, \textit{id\_kern}
2765       and \textit{id\_disc}, respectively.
2766 %Just a node which will \dots, \textit{i.e.}, a node which is \emph{not} one of the following:
2767 %\textit{ins\_node}, \textit{mark\_node}, \textit{adjust\_node}, \textit{whatsit\_node}
2768 %and \textit{penalty\_node}.
2769 \end{enumerate}
2770 We denote a cluster by \textit{Np}, \textit{Nq} and \textit{Nr}.
2771 \end{defn}
2772
2773 Internally, a cluster is represented by a table $\textit{Np}$ with the following fields.
2774
2775 \begin{description}
2776 \def\makelabel#1{\textbf{\textit{#1}}}
2777 \item[first, last] The first/last node of the cluster.
2778 \item[id] The \textit{id} in above definition.
2779 \item[nuc]
2780
2781 % jachar
2782 \item[auto\_kspc, auto\_xspc]
2783 \item[xspc\_before, xspc\_after]
2784
2785 % alchar, jachar
2786 \item[pre, post]
2787 \item[char]
2788 \item[class]
2789 \item[lend]
2790 \item[met, var]
2791 \end{description}
2792 \end{document}