X-Git-Url: http://git.osdn.jp/view?a=blobdiff_plain;f=doc%2Fluatexja.dtx;h=bb3a8cf39d9dcd4d013700803ef647441d2843c8;hb=ec6db6e5cb650db4e2209f30896e7b2e3ae31c82;hp=b7809c9a2c03001daceca6bf2fbd3f557decd92c;hpb=2530f35ee3fc227da8df0bcfe8839cdf1c4ad505;p=luatex-ja%2Fluatexja.git

diff --git a/doc/luatexja.dtx b/doc/luatexja.dtx
index b7809c9..bb3a8cf 100644
--- a/doc/luatexja.dtx
+++ b/doc/luatexja.dtx
@@ -571,7 +571,7 @@ and \emph{Japanese fonts} for fonts used in \textbf{JAchar}.
 \item \Pkg{luaotfload} v2.5 (or later)
 \item \Pkg{adobemapping} (Adobe cmap and pdfmapping files)
 \item \Pkg{everysel} (if you want to use \LuaTeX-ja with \LaTeXe)
-%<en>\item \emph{IPAex fonts(\url{http://ipafont.ipa.go.jp/})}
+%<en>\item \emph{IPAex fonts}(\url{http://ipafont.ipa.go.jp/})
 %<ja>\item \emph{IPAexフォント(\url{http://ipafont.ipa.go.jp/})}
 \end{itemize}
 
@@ -1033,6 +1033,37 @@ Okumura), namely, \Pkg{ltjclasses}\footnote{%
 %</ja>
 %%% ↑は英訳しない
 
+%<*en>
+\paragraph{\Pkg{geometry} package and classes for vertical writing}
+It is well-known that the \Pkg{geometry} package produces the following error, when classes for
+vertical writing is used:
+%</en>
+%<*ja>
+\paragraph{縦組での\Pkg{geometry}パッケージ}
+\pLaTeX の縦組用標準クラスファイルでは\Pkg{geometry}パッケージを利用することは出来ず，
+%</ja>
+\begin{lstlisting}
+! Incompatible direction list can't be unboxed.
+\@begindvi ->\unvbox \@begindvibox 
+                                   \global \let \@begindvi \@empty 
+\end{lstlisting}
+%<*en>
+Now, \LuaTeX-ja automatically applies the patch \Pkg{lltjp-geometry} to the
+\Pkg{geometry} package, when the direction of the document is \emph{tate} (vertical
+writing).
+This patch \Pkg{lltjp-geometry} also can be used in \pLaTeX; for the detail, please refer 
+\url{lltjp-geometry.pdf}~(Japanese).
+%</en>
+%<*ja>
+というようなエラーが発生することが知られている．
+\LuaTeX-jaでは， \texttt{ltjtarticle.cls} といった縦組クラスの下でも
+\Pkg{geometry}パッケージが利用できるようにパッチ\Pkg{lltjp-geometry}パッケージを自動的に当てている．
+
+なお，\Pkg{lltjp-geometry}パッケージは\pTeX 系列でも明示的に読み込むことによって
+使用可能である．詳細や注意事項は \url{lltjp-geometry.pdf} を参照のこと．
+%</ja>
+
+
 %<en>\section{Changing Fonts}
 %<ja>\section{フォントの変更}
 
@@ -2284,7 +2315,7 @@ Japanese fonts&\Param{yjabaselineshift}
 %</en>
 %<*ja>
 和文フォントと欧文フォントを合わせるためには，時々どちらかのベースラインの移動が
-必要になる．\pTeX ではこれは \cs{ybaselineshift} を設定することで
+必要になる．\pTeX ではこれは \cs{ybaselineshift}（または\cs{tbaselineshift}）を設定することで
 なされていた（\textbf{ALchar}のベースラインがその分だけ下がる）．しかし，日本語が主ではない
 文書に対しては，欧文フォントではなく和文フォントのベースラインを移動した方がよい．
 このため，\LuaTeX-jaでは欧文フォントのベースラインのシフト量
@@ -4725,7 +4756,7 @@ of \LuaTeX, see Section~\ref{sec-para}.
 %</en>
 %<*ja>
 先に述べたように，\LuaTeX-jaのほとんどの内部パラメータにアクセスするには
-\cs{ltjsetparameter} と \cs{ltjgetparameter} を用いる．
+\cs{ltjsetparameter}（または \cs{ltjglobalsetparameter}）と \cs{ltjgetparameter} を用いる．
 \LuaTeX-jaが\pTeX のような文法（例えば，\verb+\prebreakpenalty`）=10000+）を
 採用しない理由の一つは，\LuaTeX のソースにおける \verb+hpack_filter+
 コールバックの位置にある．\ref{sec-para}章を参照．
@@ -4735,24 +4766,22 @@ of \LuaTeX, see Section~\ref{sec-para}.
 \cs{ltjsetparameter} and \cs{ltjglobalsetparameter} are commands
 for assigning parameters. These take one argument which is a
 \texttt{<key>=<value>} list.
-The list of allowed keys are described in the next subsection.
 The difference between
 \cs{ltjsetparameter} and \cs{ltjglobalsetparameter} is only the
 scope of assignment;
 \cs{ltjsetparameter} does a local assignment and
 \cs{ltjglobalsetparameter} does a global one.
-They also obey the value of \cs{globaldefs},
-like other assignment.
+They also obey the value of \cs{globaldefs}, like other assignments.
 %</en>
 %<*ja>
 \cs{ltjsetparameter} と \cs{ltjglobalsetparameter} はパラメータを
-指定するための命令である．これらは\texttt{<key>=<value>}のリストを
-引数としてとる．許されるキーの一覧は次の節にある．
+指定するための命令で，\texttt{<key>=<value>}のリストを
+引数としてとる．
 \cs{ltjsetparameter} と \cs{ltjglobalsetparameter} の違いはスコープの
 違いのみで，
-\cs{ltjsetparameter} はローカルな指定，\cs{ltjglobalsetparameter} は
-グローバルな指定を行う．
-これらは他のパラメータ指定と同様に \cs{globaldefs} の値に従う．
+\cs{ltjsetparameter} はローカルな設定を行うのに対し，
+\cs{ltjglobalsetparameter} はグローバルな設定を行う．
+また，他のパラメータ指定と同様に \cs{globaldefs} の値にも従う．
 %</ja>
 
 %<*en>
@@ -4763,7 +4792,7 @@ in \pTeX, and symbols beside each parameter has the following meaning:
 %<*ja>
 以下は \cs{ltjsetparameter} に指定することができるパラメータの一覧である．
 [\cs{cs}]は\pTeX における対応物を示す．
-また，それぞれのパラメータの右上にある記号には次の意味がある：
+また，それぞれのパラメータの右上の記号には次の意味がある：
 %</ja>
 \begin{itemize}
 %<*en>
@@ -4804,7 +4833,7 @@ At the present version, the lowermost bit of <natural number> indicates
 	     (see the description of \Param{jcharwidowpenalty} above).
 %</en>
 %<*ja>
-文字コードが<chr\_code>の文字が持つ付加的な属性値(attribute)．
+文字コードが<chr\_code>の文字が持つ付加的な属性値．
 現在のバージョンでは，<natural number>の最下位ビットが，その文字が句読点と
 みなされるかどうかを表している（上の\Param{jcharwidowpenalty}の記述を参照）．
 %</ja>
@@ -4843,9 +4872,9 @@ by default.
 
 \pTeX では，\cs{prebreakpenalty}, \cs{postbreakpenalty}において，
 \begin{itemize}
-\item 一つの文字に対して，pre, postどちらか一つしか指定することができなかっ
-      た（後から指定した方で上書きされる）．
-\item pre, post合わせて256文字分の情報を格納することしかできなかった．
+\item 一つの文字に対して，pre, postどちらか一つしか指定することができない%
+  \footnote{後から指定した方で上書きされる．}
+\item pre, post合わせて256文字分の情報を格納することしかできない
 \end{itemize}
 という制限があったが，\LuaTeX-jaではこれらの制限は解消されている．
 %</ja>
@@ -4857,7 +4886,7 @@ but they don't exist in \LuaTeX-ja:
 \begin{itemize}
  \item Both \cs{prebreakpenalty} and \cs{postbreakpenalty} cannot be set
 for the same character.
- \item We can set \cs{prebreakpenalty} and \cs{postbreakpenalty}  up to 256~characters.
+ \item We can set \cs{prebreakpenalty} and \cs{postbreakpenalty} up to 256~characters.
 \end{itemize}
 %</en>
 
@@ -5002,6 +5031,7 @@ the behavior of this assignment is undefined.
 
 \end{cslist}
 
+
 \subsection{\cs{ltjgetparameter}}
 \label{ssec-getpar}
 %<*en>
@@ -5021,8 +5051,8 @@ always takes a parameter name as first argument.
 
 %<*en>
 \emph{The return value of\/ \cs{ltjgetparameter} is
-always a string}. This is outputted by \texttt{tex.write()}, so any
-character other than space~``\texttt{\char32}''~(\texttt{U+0020}) has the category code
+always a string}, which is outputted by \texttt{tex.write()}.
+Hence any character other than space~``\texttt{\char32}''~(\texttt{U+0020}) has the category code
 12~(other), while the space has 10~(space).
 %</en>
 %<*ja>
@@ -5054,7 +5084,7 @@ returns 1 or 0, not
 %<*ja>
 \verb+\ltjgetparameter{autospacing}+ と \verb+\ltjgetparameter{autoxspacing}+ は，
 \texttt{true}や\texttt{false}を返すの\emph{ではなく}，
-1と0のいずれかを返すことに注意，
+1か0のいずれかを返すことに注意，
 %</ja>
 
 \item
@@ -5063,7 +5093,7 @@ If first argument is one of the
 following, an additional argument---a character code, for example---is needed.
 %</en>
 %<*ja>
-第1引数が次のいずれかの場合には，さらに文字コードを第二引数としてとる．
+第1引数が次のいずれかの場合には，さらに文字コードを第2引数としてとる．
 %</ja>
 \begin{quote}
 \sffamily
@@ -5172,9 +5202,133 @@ by the following:
   <chr\_code>\verb+}}+\\\null\hfill\verb+% 0 if JAchar, 1 if ALchar+
 \end{quote}
 
+%<*en>
+\item Because the returned value is string, the following conditionals do not work
+if \Param{kanjiskip} (or~\Param{xkanjiskip}) has the stretch part or the shrink part.
+\begin{lstlisting}
+\ifdim\ltjgetparameter{kanjiskip}>\z@ ... \fi
+\ifdim\ltjgetparameter{xkanjiskip}>\z@ ... \fi
+\end{lstlisting}
+The correct way is using a temporary register.
+\begin{lstlisting}
+\@tempskipa=\ltjgetparameter{kanjiskip} \ifdim\@tempskipa>\z@ ... \fi
+\@tempskipa=\ltjgetparameter{xkanjiskip}\ifdim\@tempskipa>\z@ ... \fi
+\end{lstlisting}
+%</en>
+%<*ja>
+\item 返り値が文字列であることから，\Param{kanjiskip}や\Param{xkanjiskip}を直接
+\ \cs{ifdim} を使って比較することは望ましくない．伸び量や縮み量を持っている時には，
+次はエラーを発生させる：
+\begin{lstlisting}
+\ifdim\ltjgetparameter{kanjiskip}>\z@ ... \fi
+\ifdim\ltjgetparameter{xkanjiskip}>\z@ ... \fi
+\end{lstlisting}
+レジスタに一旦代入するのが良い：
+\begin{lstlisting}
+\@tempskipa=\ltjgetparameter{kanjiskip} \ifdim\@tempskipa>\z@ ... \fi
+\@tempskipa=\ltjgetparameter{xkanjiskip}\ifdim\@tempskipa>\z@ ... \fi
+\end{lstlisting}
+%</ja>
+
+\end{itemize}
+
+%<*ja>
+\subsection{\cs{ltjsetparameter} の代替}
+原則として各種内部パラメータの設定には \cs{ltjsetparameter} もしくは
+\ \cs{ltjglobalsetparameter}\ を用いることになるが，
+\cs{ltjsetparameter} の実行には時間がかかるという難点があり，
+\LuaTeX-ja の内部ではより高速に実行できる別の形式を用いている．
+\emph{本節は一般利用者むけの内容ではない．}
+
+\paragraph{\Param{kanjiskip}, \Param{xkanjiskip} の設定}
+\pLaTeXe 新ドキュメントクラスでは，
+\begin{lstlisting}
+\def\@setfontsize#1#2#3{%
+  ...
+  \kanjiskip=0zw plus .1zw minus .01zw
+  \ifdim\xkanjiskip>\z@
+    \if@slide \xkanjiskip=0.1em \else
+      \xkanjiskip=0.25em plus 0.15em minus 0.06em
+    \fi
+  \fi}
+\end{lstlisting}
+と，フォントサイズを変更するごとに \cs{kanjiskip}, \cs{xkanjiskip} を変更している．
+この \cs{@setfontsize} は文書の中で多数回実行されるので．
+\LuaTeX-ja 用に素直に書き換えた
+\begin{lstlisting}
+  \ltjsetparameter{kanjiskip=0\zw plus .1\zw minus .01\zw}
+  \@tempskipa=\ltjgetparameter{xkanjiskip}
+  \ifdim\@tempskipa>\z@
+    \if@slide 
+      \ltjsetparameter{xkanjiskip=0.1em}
+    \else
+      \ltjsetparameter{xkanjiskip=0.25em plus 0.15em minus 0.06em}
+    \fi
+  \fi
+\end{lstlisting}
+としたのではタイプセットが遅くなってしまう．
+そこで，\cs{ltjsetparameter} の中で
+\begin{itemize}
+\item \cs{globaldefs} の値を読み取る \cs{ltj@setpar@global}
+\item \Param{kanjiskip} の設定を行う \cs{ltjsetkanjiskip}
+\item \Param{xkanjiskip} の設定を行う \cs{ltjsetxkanjiskip}
 \end{itemize}
+を独立させ，\Pkg{ltjsclasses}では，
+\begin{lstlisting}
+  \ltj@setpar@global
+  \ltjsetkanjiskip{\z@ plus .1\zw minus .01\zw}
+  \@tempskipa=\ltjgetparameter{xkanjiskip}
+  \ifdim\@tempskipa>\z@
+    \if@slide 
+      \ltjsetxkanjiskip{0.1em}
+    \else
+      \ltjsetxkanjiskip{0.25em plus 0.15em minus 0.06em}
+    \fi
+  \fi
+\end{lstlisting}
+としている．
+\cs{ltj@setpar@global}を直前に実行せず，単独で
+\cs{ltjsetkanjiskip}, \cs{ltjsetxkanjiskip}を実行することは想定されていないので注意．
+
+
+
+\paragraph{ベースライン補正量の設定}
+\pLaTeX の\Pkg{ascmac}パッケージでは，縦組の欧文ベースライン補正量の一時待避・復帰処理に
+\ \cs{@saveybaselineshift}\ という寸法レジスタを用い
+\begin{lstlisting}
+\@savetbaselineshift\tbaselineshift\tbaselineshift\z@
+...
+\tbaselineshift\@savetbaselineshift
+\end{lstlisting}
+という処理を行っている．
 
+これを\LuaTeX-ja 用に \cs{ltjsetparameter} を使って書き直すと，
+\begin{lstlisting}
+\@savetbaselineshift\ltjgetparameter{talbaselineshift}
+\ltjsetparameter{talbaselineshift=\z@}
+...
+\ltjsetparameter{talbaselineshift=\@savetbaselineshift}
+\end{lstlisting}
+となる．
 
+さて，縦組の欧文ベースライン補正量\Param{talbaselineshift}は，
+実際には \cs{ltj@tablshift} という属性レジスタに格納されている
+（\ref{sec-para}\nobreak 節参照）．属性レジスタは長さではなく整数値を格納する\footnote{%
+  従って，\texttt{\textbackslash @savetbaselineshift=\textbackslash ltj@tablshift}\ 
+  のように記述することはできない．属性レジスタを \cs{tbaselineshift} という名称にしなかっ
+  たのはそのためである．
+}ものであり，\cs{ltj@tablshift} は補正量を sp 単位で保持することから，
+上記のコードと同じ内容をより速い以下のコードで実現することができる．
+\begin{lstlisting}
+\@savetbaselineshift\ltj@tablshift sp%
+\ltj@tablshift\z@
+...
+\ltj@tablshift\@savetbaselineshift
+\end{lstlisting}
+この手法は \Pkg{ascmac} パッケージの\LuaTeX-ja対応パッチ \Pkg{lltjp-tascmac.sty} で
+実際に用いられている．\Pkg{lltjp-tascmac.sty} は自動的に読み込まれるので，
+ユーザは何も気にせず普通に \Pkg{ascmac} パッケージを \cs{usepackage} で読みこめば良い．
+%</ja>
 
 
 %<en>\section{Other Commands for plain \TeX\ and \LaTeXe}
@@ -8118,7 +8272,7 @@ then the patch \Pkg{lltjp-listings} is loaded automatically at \verb+\begin{docu
 意識する必要はない．
 %</ja>
 
-%<en>\subsection{Notes}
+%<en>\subsection{Notes and additional keys}
 %<ja>\subsection{注意}
 %<*en>
 \paragraph{Escaping to \LaTeX}
@@ -8160,6 +8314,20 @@ instead of ``\verb+\ほげ+''.
 「\cs{}\IVSA FFFFF」というcontrol symbolが実行されることになる．
 %</ja>
 
+%<*en>
+\paragraph{Variation selectors}
+\Pkg{lltjp-listings} add two keys, namely \texttt{vsraw}~and~\texttt{vscmd},
+which specify how variation selectors are treated in 
+\texttt{lstlisting} or other enviroments.
+Note that these additional keys are not usable in the preamble, 
+since \Pkg{lltjp-listings} is loaded at \verb+\begin{document}+.
+
+\texttt{vsraw} is a key which takes a boolean value, and its default value is
+false.
+\begin{itemize}
+ \item If the \texttt{vsraw} key is true, then
+variation selectors are ``combined'' with the previous character.
+%</en>
 %<*ja>
 \paragraph{異体字セレクタの扱い}
 \texttt{lstlisting} 環境などの内部にある異体字セレクタを扱うため，
@@ -8172,21 +8340,31 @@ instead of ``\verb+\ほげ+''.
  \item trueの場合は，異体字セレクタは「直前の文字に続けて」出力される．
 もしもIVSサポート（\ref{ssec-ltjotf}節）が有効になっていた場合は，
 以下の例（左側は入力，右側はその出力）のようになる．
+%</ja>
 \begin{LTXexample}
 \begin{lstlisting}[vsraw=true]
 葛󠄀城市，葛󠄁飾区，葛西
 \end{lstlisting}
 \end{LTXexample}
+%<*en>
+\item If the \texttt{vsraw} key is false, then 
+variation selectors are typeset by an appropriate command, which is specified by
+      the \texttt{vscmd} key.
+The default setting of the \texttt{vscmd} key produces the following.
+%</en>
+%<*ja>
 \item falseの場合は，異体字セレクタは適当な命令によって「見える形で」出力される．
 どのような形で出力されるかを規定するのが \texttt{vscmd} キーであり，
 \Pkg{lltjp-listings} の標準設定では以下の例の右側のように出力される．
+%</ja>
 \begin{LTXexample}
 \begin{lstlisting}[vsraw=false,
    vscmd=\ltjlistingsvsstdcmd]
 葛󠄀城市，葛󠄁飾区，葛西
 \end{lstlisting}
 \end{LTXexample}
-ちなみに，本ドキュメントでは次のようにしている：
+%<ja> ちなみに，本ドキュメントでは次のようにしている：
+%<en> For example, the following code is the setting of the \texttt{vscmd} key in this document.
 \begin{lstlisting}[numbers=left]
 \def\IVSA#1#2#3#4#5{%
   \textcolor{blue}{\raisebox{3.5pt}{\tt%
@@ -8200,10 +8378,56 @@ instead of ``\verb+\ほげ+''.
 \lstset{vscmd=\IVSB}
 \end{lstlisting}
 \end{itemize}
-既定の出力命令を復活させたい場合は\ \verb+vsraw=\ltjlistingsvsstdcmd+\
+%<*en>
+The default output command of variation selectors is stored in \verb+\ltjlistingsvsstdcmd+.
+%</en>
+%<*ja>
+既定の出力命令を復活させたい場合は\ \verb+vscmd=\ltjlistingsvsstdcmd+\
 とすれば良い．
 %</ja>
 
+%<*en>
+\paragraph{The \texttt{doubleletterspace} key}
+Even the column format is \texttt{[c]fixed}, sometimes characters are not vertically aligned.
+The following example  is typeset with \texttt{basewidth=2em}, and
+you'll see the leftmost ``\texttt{H}'' are not vertically aligned.
+\begin{lstlisting}[basewidth=2em, basicstyle=\tt,numbers=left]
+:H:
+:HHHH:
+\end{lstlisting}
+
+\Pkg{lltjp-listing} adds the \texttt{doubleletterspace} key (not activated by default, for
+compatibility) to
+improve the situation, namely doubles inter-character space in each output unit.
+With this key, the above input now produces better output.
+\begin{lstlisting}[basewidth=2em, basicstyle=\tt,numbers=left, doubleletterspace]
+:H:
+:HHHH:
+\end{lstlisting}
+%</en>
+%<*ja>
+\paragraph{\texttt{doubleletterspace}キー}
+\Pkg{listings}パッケージで列揃えが \texttt{[c]fixed} となっている場合でも，
+場合によっては文字が縦に揃わない場合もある．
+例を以下に示そう．これは強調するために \texttt{basewidth=2em} を設定している．
+\begin{lstlisting}[basewidth=2em, basicstyle=\tt,numbers=left]
+:H:
+:HHHH:
+\end{lstlisting}
+1行目と2行目の「\texttt{H}」の位置が揃っていないが，
+これは出力単位ごとに，先頭・末尾・各文字間に同じ量の空白を挿入することによる．
+
+\Pkg{lltjp-listing}では，このような症状を改善させるために \texttt{doubleletterspace} キー
+を追加した（標準では互換性のために無効になっている）．このキーを有効にすると，
+出力単位中の各文字間の空白を2倍にすることで文字を揃いやすくしている．
+上と同じものを \texttt{doubleletterspace} キーを有効にして組んだものが以下であり，
+きちんと「\texttt{H}」の位置が揃っていることが分かる．
+\begin{lstlisting}[basewidth=2em, basicstyle=\tt,numbers=left, doubleletterspace]
+:H:
+:HHHH:
+\end{lstlisting}
+%</ja>
+
 %<en>\subsection{Class of Characters}
 %<ja>\subsection{文字種}
 
@@ -8325,7 +8549,7 @@ Prev&Kanji&\multicolumn{4}{c}{\hrulefill \ outputs\ \hrulefill}&collects\\
 \end{itemize}
 
 %<*en>
-Characters above \texttt{U+0080} \emph{except Variation Selectors}
+Characters above or equal to~\texttt{U+0080} \emph{except Variation Selectors}
 are classified into above 5~classes by the following rules:
 %</en>
 %<*ja>
@@ -8333,7 +8557,7 @@ are classified into above 5~classes by the following rules:
 Letter, Other, Kanji, Open, Closeのどれに属するかは次によって決まる：
 %</ja>
 \begin{itemize}
-%<en>\item \textbf{ALchar}s above \texttt{U+0080} are classified as Letter.
+%<en>\item \textbf{ALchar}s above or equal to~\texttt{U+0080} are classified as Letter.
 %<ja>\item （\texttt{U+0080}以降の）\textbf{ALchar}は，すべてLetter扱いである．
 
 %<en>\item \textbf{JAchar}s are classified in the order as follows:
@@ -8545,10 +8769,11 @@ OpenTypeフォントでもTrueTypeフォントでもIVS情報が格納されて
 \texttt{fontloader} の呼び出しでかなり時間を消費することから，
 %%% to_table を使わなくしたことで，メモリ使用量は減った
 IVS情報をキャッシュに保存することで2回目以降の実行時間を節約している．
+%</ja>
 
 
+%<*ja>
 \section{複数フォントの「合成」（未完）}
-
 \section{\LuaTeX-jaにおけるキャッシュ}
 \Pkg{luaotfload}パッケージが，各TrueType・OpenTypeフォントの情報を
 キャッシュとして保存しているのと同様の方法で，