yatex
view docs/yatexadd.doc @ 70:44e3a5e1e883
Fix makefile for Windows
Brush up label completion
\cite completion
Support much more about LaTeX2e
---
[yahtml]
English Info (By Jun Ohya)
Automatic pixel size detection for <img src="...">
Aware global-class of css definition
& for char-entity reference
| author | yuuji |
|---|---|
| date | Sun, 09 Apr 2000 03:37:47 +0000 |
| parents | 807c1e7e68b7 |
| children | 0734be649cb8 |
line source
1 ------------------------------------------------------------------------
2 野鳥用付加関数の作成方法
3 ------------------------------------------------------------------------
6 【付加関数とは】
8 begin 型補完で、「tabular 環境を入力している時に、わたしの好み
9 のスタイルが入らないなあ」などと思うことはありませんか。tabular
10 環境に限らず、LaTeX の環境の引数には、各人お決まりのフォーマット
11 があるものです。たとえば凝った表を書く時の tabular環境の引数は、
12 かなり複雑なので、デフォルトの自動入力関数よりも、
14 "{@{\vrule width 1pt\ }|||@{\ \vrule width 1pt}}"
16 を挿入するだけの単純な関数のほうが、嬉しい人もいるでしょう。あるい
17 は、「そんなの要らない。他の tabular をコピーして来たほうが早い。」
18 と思う人もいるでしょう。
20 YaTeX の付加関数は、あらかじめ○○環境用のお仕着せの特別関数を用
21 意しておくのではなく、○○環境用の特別関数が欲しくなったら独自の関
22 数を定義する、というコンセプトに基づくもので、付加関数の登録のため
23 の手続きをすることなく、関数を定義したその瞬間から使えるようになり
24 ます。「必要なのは、defun だけ」です。
27 【準備】
29 さすがに、関数を書くだけでは使えません:-)。yatex-mode 起動時には、
30 その関数を定義したファイルがロードされていなくてはなりません。関数
31 を定義するファイル名を yatexhks.el(またはバイトコンパイルした形式
32 の yatexhks.elc)にし、そのファイルを load-path 中に置いておけば、
33 野鳥が自動的にロードします。それ以外のファイル名にする場合は、
34 yatex-mode-load-hook に付加関数を定義する Emacs-Lisp ファイルをロー
35 ドするような仕掛けを書いておくのがよいでしょう。
38 【関数定義】
40 付加関数には、各LaTeXコマンドのオプション引数を返す形式のもの、
41 section型補完の引数を返すもの、の二種類があります。
43 前者は、以下の例のように、begin型補完では\begin{環境名}の直後に
44 付加する文字列、section型補完では LaTeX コマンド名と第一引数の間に
45 位置する文字列、maketitle型補完では LaTeX コマンド名の直後に位置す
46 る文字列を返すような関数です。便宜上この形の付加関数を、追加型付加
47 関数と呼ぶことにします。
49 (例) \begin{table}[ht] (付加関数名 YaTeX:table)
50 ~~~~
51 \put(100,200){} (付加関数名 YaTeX:put)
52 ~~~~~~~~~
53 \sum_{i=0}^{n} (付加関数名 YaTeX:sum)
54 ~~~~~~~~~~
56 追加型付加関数は『LaTeXコマンド名の前に YaTeX: をつけた名前』で定
57 義します。
59 後者は、以下のようにsection型コマンドの引数となる文字列を返す
60 関数です。この形の付加関数を引数型付加関数と呼ぶことにします。
62 (例) \newcommand{\foo}{bar} (付加関数名 YaTeX::newcommand)
63 ~~~~ ~~~
65 引数型付加関数は『LaTeXコマンド名の前に YaTeX:: をつけた名前』で定
66 義します。また引数型付加関数が呼ばれる時にはsection型コマンドの何
67 番目の引数を入力しているのかが関数への引数として渡されます。したがっ
68 て、引数型付加関数は整数の引数を一つ取るものとして定義し、その引数
69 の値により処理を決定することになります。
72 【定義例】
74 例えば、tabular環境のフォーマットとして、いつでも {|c|c|c|} を入
75 れるだけで良いのなら、
77 (defun YaTeX:tabular ()
78 "{|c|c|c|}")
80 とだけ書けばよく、前述の、複雑な定型 tabular フォーマットを挿入す
81 るための関数を定義する場合は次のようにします。
83 (defun YaTeX:tabular ()
84 "{@{\\vrule width 1pt\\ }|||@{\\ \\vrule width 1pt}}")
86 この時、Emacs-Lisp 中の文字列では、\ 自身は \\ と表記することなど
87 に注意して下さい。
89 また、{} の中を、補完時に直接キーボードから読み込ませたい時は、
91 (defun YaTeX:tabular ()
92 (concat "{" (read-string "Rule: ") "}"))
94 などとすれば良いでしょう。
96 次に、引数型付加関数として \newcommand の引数を読み込む関数を定
97 義する場合を例示します。\newcommand の第一引数は新たに定義するコマ
98 ンド名なので、必ず先頭に \ が来ます。第二引数はたいていの場合ミニ
99 バッファでは編集しづらいような複雑な定義を書くので、何も補完しない
100 方が良いでしょう。これを考慮して付加関数を定義すると以下のようなも
101 のになるでしょう。
103 (defun YaTeX::newcommand (n) ;nは引数の位置
104 (cond
105 ((= n 1) ;第一引数ならコマンド名
106 (read-string "Command: " "\\")) ;\を初期入力とする
107 ((= n 2) "") ;第二引数なら何もしない
108 (t nil)))
110 なお、引数型付加関数が nil を返した場合は、通常の引数入力関数が呼
111 ばれます。
114 【呼ばれ方】
116 野鳥本体は、begin型補完とsection型補完、およびmaketitle型補完の
117 入力時に付加関数の存在を調べてから呼び出します。begin型補完の場合
118 \begin{環境名} が自動入力された直後に呼び出されます。section型補完
119 では第一引数の補完の直前、maketitle型補完の場合は、コマンド名の直
120 後(一つのスペースを挿入する直前)に呼び出されます。引数型付加関数は、
121 section型コマンドの引数の入力時にその都度呼ばれます。
124 【参考】
126 付加関数の定義の例を yatexadd.el に用意しました。実際に独自の付
127 加関数を定義する時の参考として下さい。
129 有用と思われる関数について、簡単に説明します。
131 ・関数 YaTeX:read-position
132 引数 [] の中に入れてもよい文字を羅列した文字列。
133 説明 [htb] などのような location 指定を作成します。何も入力せず
134 リターンを押すと、[]自体も省略されます。[]の中に来るべき文
135 字が htbp に限られているなら、(YaTeX:read-position "htbp")
136 と呼び出します。
138 ・関数 YaTeX-cplread-with-learning
139 引数 プロンプト
140 デフォルト補完テーブル変数シンボル
141 ユーザ補完テーブル変数シンボル
142 ローカル補完テーブル変数シンボル
143 説明 「プロンプト」というプロンプトを出し、補完入力を行います。
144 三つの変数のテーブルの値を結合したものが補完候補として用
145 いられ、新しい単語を入力すると自動的に学習されます。学習
146 結果は ~/.yatexrc か ./.yatexrc に保存されます。使用例と
147 して YaTeX::documentstyle 関数の定義をごらんください。
149 ・関数 YaTeX:read-coordinates
150 引数 基本プロンプト、X座標プロンプト、Y座標プロンプト(全て省略可)
151 説明 「基本プロンプト X座標プロンプト:」というプロンプトを出し
152 て、X座標を読み込み、「基本プロンプト Y座標プロンプト:」を
153 出して、Y座標を読み込み、(X座標,Y座標) の様な形式を作成します。
154 何も入力せずリターンを押しても、(,)が返されます。
155 各プロンプトのデフォルトはそれぞれ、Dimension, X, Y です。
157 ・関数 YaTeX:check-comletion-type
158 引数 'begin または、'section または、'maketitle
159 説明 付加関数が呼ばれる時に、行われている補完の形式が、引数で与
160 えたものであるかどうか調べ、そうでない場合にエラー終了する。
161 なお、変数 YaTeX-current-completion-type に現在の補完の型
162 を表わすシンボル(この関数の引数と同様)が格納されています。
165 【最後に】
167 快適な関数を定義したなら、そしてそれを公開してもよいと思われたな
168 ら、筆者までお送り下さい。次の yatexadd.el に取り込んで行きたいと
169 思います。
172 広瀬雄二
173 yuuji@yatex.org