Merge branch 'kmaeda-manual' into kitagawa_test

[luatex-ja/luatexja.git] / doc / sample1.tex

diff --git a/doc/sample1.tex b/doc/sample1.tex
index e5e4e07..b6178f3 100644 (file)
--- a/doc/sample1.tex
+++ b/doc/sample1.tex
@@ -11,7 +11,6 @@
 \def\XyM{X\kern-.30em\smash{\raise.50ex\hbox{\UPSILON}}\kern-.30em{M}}%
 \def\XyMTeX{\XyM\kern-.1em\TeX}%
 
-
 % main matter
 \centerline{\big Lua\TeX-jaパッケージ}\bigskip
 \centerline{\large\the\year/\the\month/\the\day}\medskip
@@ -20,7 +19,7 @@
 
 本パッケージは，（最低でもp\TeX と同等の水準の）日本語組版をLua\TeX 上で実現させることを
 目標としたマクロである．まだまだ足りないところはあるが，とりあえず動くようになった？ので公開する． 
-
+{\bf 本文章の更新は停止しています．以降の更新は{\tt manual.dtx}と，そこから作られる{\tt man-en.pdf}, {\tt man-ja.pdf}で行います．}
 
 \beginparagraph 特徴
 
@@ -31,7 +30,8 @@
 ほげほげ）{\gt （ふがふが}
 \endtt
 \item 欧文や和文のベースライン補正が可能．
-\item p\TeX とある程度コマンド名が互換．
+\item p\TeX とある程度コマンド名が互換ではあるが，{\bf 内部動作についてはp\TeX との100\%互換は
+目指していません{\small （p\TeX で不自然なところがあれば，積極的に改める）\inhibitglue}}．
 \enditem
 
 \beginparagraph 制限
@@ -52,34 +52,66 @@
 
 \beginparagraph ファイル構成
 
-
-\item {\tt luatexja-core.sty}: 
-コア部分．拡張子は{\tt sty}であるが，この単一のファイルでplain \TeX と\LaTeX 両方に
-対応するように設計する方針である．しかし，
-{\bf 現時点で\LaTeX での使用は全く考慮されていない．}
-\item {\tt luatexja-core.lua}: コア部分に使われるLuaコード．
-\item {\tt luatexja-jfont.lua}: 和文フォント定義部のLuaコード．
-\item {\tt luatexja-xkanji.lua}: |\[x]kanjiskip|自動挿入処理のLuaコード．
-\item {\tt luatexja-rmlgbm-data.lua}: 非埋込和文フォント用のデータ（小塚明朝Pr6N R由来）．
-\item {\tt luatexja-rmlgbm.lua}: 非埋込和文フォント (Ryumin-Light etc.) 定義部．
-\item {\tt mk-rmlgbm-data.tex}: {\tt luatexja-rmlgbm-data.lua}作成用スクリプト
+\item {\tt src/}: 核となる\TeX ソースとLuaコードはこのディレクトリ内に入っている．
+\itemitem \TeX 用スタイルファイル達
+\itemT {\tt luatexja.sty}: 利用者はこのファイルを読み込む．
+拡張子は{\tt sty}であるが，plain \TeX と\LaTeX 両方に対応させる方針である．
+\itemT {\tt luatexja-core.sty}: 
+\itemT {\tt luatexja-base.sty}: 
+\itemT {\tt luatexja-cctbreg.sty}: 
+\itemT {\tt luatexja-compat.sty}: p\TeX 互換用primitive（|\euc|, |\kansuji|）定義部．
+\itemT {\tt luatexja-compat-ptex.sty}: 
+\itemT {\tt luatexja-plain.sty}: 
+\itemT {\tt luatexja-kinsoku.tex}: 禁則用ペナルティ等のパラメータを書いたファイル．
+{\tt ukinsoku.tex} (in up\TeX-0.30) から自動生成されたもの．
+
+\itemT {\tt mk-rmlgbm-data.tex}: {\tt luatexja-rmlgbm-data.lua}作成用スクリプト
 {\small（小塚明朝を{\tt luaotfload}で読み込んだ時のキャッシュが必要）\inhibitglue}．
-\item {\tt luatexja-kinsoku.tex}: 禁則用ペナルティ等のパラメータを書いたファイル．
-下のファイルによって{\tt ukinsoku.tex} (in up\TeX-0.30) から自動生成されたもの．
-\item {\tt jfm-ujis.lua}: up\TeX-0.30の{\tt ujis.tfm}ベースのメトリックサンプル．
-\item {\tt jfm-mono.lua}: 「全文字が全角幅」のメトリックサンプル．
+
+\itemitem \LaTeX 用スタイルファイル達
+\itemT {\tt luatexja-latex.sty}: 
+\itemT {\tt lltjdefs.sty}: 
+\itemT {\tt lltjfont.sty}: 
+
+
+\itemitem Luaコード達（旧フォーマット）
+\itemT {\tt luatexja-core.lua}: コア部分に使われるLuaコード．
+\itemT {\tt luatexja-rmlgbm-data.lua}: 非埋込和文フォント用のデータ（小塚明朝Pr6N R由来）．
+\itemT {\tt jfm-ujis.lua}: up\TeX-0.30の{\tt ujis.tfm}ベースのメトリックサンプル．
+\itemT {\tt jfm-mono.lua}: 「全文字が全角幅」のメトリックサンプル．
+
+\itemitem Luaコード達（新フォーマット，{\tt src/luatexja/}以下）
+
+\itemT {\tt base.lua}
+\itemT {\tt compat.lua}: p\TeX 互換用primitive（|\euc|, |\kansuji|）実装部．
+\itemT {\tt jisx0208.lua}: |\euc|等で使うJIS~X~0208→Unicode変換表．
+\itemT {\tt infomute.lua}
+\itemT {\tt jfont.lua}: 和文フォント定義部のLuaコード．
+\itemT {\tt rmlgbm.lua}: 非埋込和文フォント (Ryumin-Light etc.) 定義用コード．
+\itemT {\tt jfmglue.lua}: 和文処理に伴う空白の挿入処理部．
+\itemT {\tt math.lua}: 数式モード中の和文文字のフォント置換部分．
+\itemT {\tt tangle.lua}
+\itemT {\tt charrange.lua}: 「和文文字の範囲」管理部．
+\itemT {\tt debug.lua}
+\itemT {\tt inputbuf.lua}: 「和文文字直後の改行」処理用．
+\itemT {\tt stack.lua}: Lua\TeX-ja スタック管理システム．
 \enditem
 
 \beginsection 使用方法
 
-大é\9b\91æ\8a\8aã\81«è¨\80ã\81\86ã\81¨ï¼\8cplain \TeX ã\81®ç\8a¶æ³\81ã\81§ï¼\8c以ä¸\8bã\81®ã\82\88ã\81\86ã\81«ã\81\99ã\82\8cã\81°ã\82\88ã\81\84ï¼\8e
+大é\9b\91æ\8a\8aã\81«è¨\80ã\81\86ã\81¨ï¼\8cplain \TeX ã\81®ç\8a¶æ³\81ã\81§ï¼\8c以ä¸\8bã\81®ã\82\88ã\81\86ã\81«ã\81\99ã\82\8bã\81\8bï¼\8c
 \begintt
-\input luatexja-core.sty               % ←マクロ本体を読み込み
+\input luatexja.sty               % ←マクロ本体を読み込み
 \jfont\tenipam={file:ipam.ttf:jfm=ujis} at 13.5\jQ 
 \tenipam\parindent=1\zw 
 
 \rm\tenipam abcほげほげ）（あいう本文本文……
 \endtt
+\LaTeX において preamble 部で
+\begintt
+\usepackage{luatexja}
+\endtt
+と書けばよい．標準では非埋込の標準和文フォントRyumin-Light, GothicBBB-Mediumが使われる．
 
 \beginparagraph 和文フォントの定義
 
@@ -317,7 +349,9 @@ $n\notin [1,216]$の場合は，「どの文字範囲にも属さない|U+0080|
 
 \beginparagraph その他の命令
 
-\item dimen |\zw|, |\zh|: 現在の和文フォントの「幅」/「高さ」（メトリックから指定）
+\item |\zw|, |\zh|: 現在の和文フォントの「幅」/「高さ」（メトリックにより指定）\hfil\break
+今の版では，これは純粋なdimenレジスタではなくなっている．
+
 \item dimen |\jQ|, |\jH|${}= 0.25\,{\rm mm}$.
 \item |\inhibitglue|: 
 指定箇所でのJFM由来のglue/kernの挿入を禁止する．
@@ -331,7 +365,7 @@ Lua\TeX-jaで用いる和文用のメトリック情報は，次のようなLua
 見本として，|jfm-ujis.lua|を入れてある．
 
 \begintt
-ltj.define_jfm {
+luatexja.jfont.define_jfm {
    dir = 'yoko', zw = 1.0, zh = 1.0,
    [0] = {
       align = 'left', left = 0.0, down = 0.0,
@@ -358,7 +392,7 @@ ltj.define_jfm {
 }
 \endtt
 
-全体は，「関数|ltj.define_jfm|にテーブルを引数として与える」という構造になっている．
+全体は，「関数|luatexja.jfont.define_jfm|にテーブルを引数として与える」という構造になっている．
 以下に，テーブルの中身を述べる．
 \item |dir|: 組方向を指定する．将来的にはいずれ縦組（|'tate'|）を実装したいが，
 現時点では横組（|'yoko'|）のみの対応．
@@ -493,7 +527,7 @@ $p$は「現在の和文フォント」の番号もattribute |\ltj@curjfnt|と
 
 \item {\bf 和文処理グルーの挿入: |pre_linebreak_filter|, |hpack_filter| callbacks}
 
-動作については，{\tt jfmglue.pdf}（未完）を参照．
+å\8b\95ä½\9cã\81®è©³ç´°ã\81«ã\81¤ã\81\84ã\81¦ã\81¯ï¼\8c{\tt jfmglue.pdf}ï¼\88æ\9cªå®\8cï¼\89ã\82\92å\8f\82ç\85§ï¼\8e
 
 \item {\bf ベースライン補正: |pre_linebreak_filter|, |hpack_filter| callbacks}