yatex
view docs/yatexadd.doc @ 25:ab9c4c4f9f7a
version 1.50
| author | yuuji |
|---|---|
| date | Fri, 08 Jul 1994 19:38:30 +0000 |
| parents | cb9afa9c1213 |
| children | eb0512bfcb7f |
line source
1 ------------------------------------------------------------------------
2 野鳥用付加関数の作成方法
3 ------------------------------------------------------------------------
6 【付加関数とは】
8 begin 型補完で、「tabular 環境を入力している時に、"{|c|c|c|}" と
9 か、また、table 環境の入力時に"[tbp]" とかも一緒に入力すればいいの
10 に」などと思うことはありませんか。もちろんこれを自動入力する関数は
11 簡単にサポートできるでしょう。
13 しかし、tabular 環境に限らず、LaTeX の環境の引数には、各人お決ま
14 りのフォーマットがあるものです。たとえば凝った表を書く時の tabular
15 環境の引数は、かなり複雑なので、上のような自動入力関数よりも、
17 "{@{\vrule width 1pt\ }|||@{\ \vrule width 1pt}}"
19 を挿入するだけの単純な関数のほうが、嬉しい人もいるでしょう。あるい
20 は、「そんなの要らない。他の tabular をコピーして来たほうが早い。」
21 と思う人もいるでしょう。
23 YaTeX の付加関数は、あらかじめ○○環境用のお仕着せの特別関数を用
24 意しておくのではなく、○○環境用の特別関数が欲しくなったら独自の関
25 数を定義する、というコンセプトに基づくもので、付加関数の登録のため
26 の手続きをすることなく、関数を定義したその瞬間から使えるようになり
27 ます。「必要なのは、defun だけ」です。
30 【準備】
32 さすがに、関数を書くだけでは使えません:-)。yatex-mode 起動時には、
33 その関数を定義したファイルがロードされていなくてはなりません。関数
34 を定義するファイル名を yatexhks.el(またはバイトコンパイルした形式
35 の yatexhks.elc)にし、そのファイルを load-path 中に置いておけば、
36 野鳥が自動的にロードします。それ以外のファイル名にする場合は、
37 yatex-mode-load-hook に付加関数を定義する Emacs-Lisp ファイルをロー
38 ドするような仕掛けを書いておくのがよいでしょう。
41 【関数定義】
43 付加関数には、各LaTeXコマンドのオプション引数を返す形式のもの、
44 section型補完の引数を返すもの、の二種類があります。
46 前者は、以下の例のように、begin型補完では\begin{環境名}の直後に
47 付加する文字列、section型補完では LaTeX コマンド名と第一引数の間に
48 位置する文字列、maketitle型補完では LaTeX コマンド名の直後に位置す
49 る文字列を返すような関数です。便宜上この形の付加関数を、追加型付加
50 関数と呼ぶことにします。
52 (例) \begin{table}[ht] (付加関数名 YaTeX:table)
53 ~~~~
54 \put(100,200){} (付加関数名 YaTeX:put)
55 ~~~~~~~~~
56 \sum_{i=0}^{n} (付加関数名 YaTeX:sum)
57 ~~~~~~~~~~
59 追加型付加関数は『LaTeXコマンド名の前に YaTeX: をつけた名前』で定
60 義します。
62 後者は、以下のようにsection型コマンドの引数となる文字列を返す
63 関数です。この形の付加関数を引数型付加関数と呼ぶことにします。
65 (例) \newcommand{\foo}{bar} (付加関数名 YaTeX::newcommand)
66 ~~~~ ~~~
68 引数型付加関数は『LaTeXコマンド名の前に YaTeX:: をつけた名前』で定
69 義します。また引数型付加関数が呼ばれる時にはsection型コマンドの何
70 番目の引数を入力しているのかが関数への引数として渡されます。したがっ
71 て、引数型付加関数は整数の引数を一つ取るものとして定義し、その引数
72 の値により処理を決定することになります。
75 【定義例】
77 例えば、tabular環境のフォーマットとして、いつでも {|c|c|c|} を入
78 れるだけで良いのなら、
80 (defun YaTeX:tabular ()
81 "{|c|c|c|}")
83 とだけ書けばよく、前述の、複雑な定型 tabular フォーマットを挿入す
84 るための関数を定義する場合は次のようにします。
86 (defun YaTeX:tabular ()
87 "{@{\\vrule width 1pt\\ }|||@{\\ \\vrule width 1pt}}")
89 この時、Emacs-Lisp 中の文字列では、\ 自身は \\ と表記することなど
90 に注意して下さい。
92 また、{} の中を、補完時に直接キーボードから読み込ませたい時は、
94 (defun YaTeX:tabular ()
95 (concat "{" (read-string "Rule: ") "}"))
97 などとすれば良いでしょう。
99 次に、引数型付加関数として \newcommand の引数を読み込む関数を定
100 義する場合を例示します。\newcommand の第一引数は新たに定義するコマ
101 ンド名なので、必ず先頭に \ が来ます。第二引数はたいていの場合ミニ
102 バッファでは編集しづらいような複雑な定義を書くので、何も補完しない
103 方が良いでしょう。これを考慮して付加関数を定義すると以下のようなも
104 のになるでしょう。
106 (defun YaTeX::newcommand (n) ;nは引数の位置
107 (cond
108 ((= n 1) ;第一引数ならコマンド名
109 (read-string "Command: " "\\")) ;\を初期入力とする
110 ((= n 2) "") ;第二引数なら何もしない
111 (t nil)))
113 なお、引数型付加関数が nil を返した場合は、通常の引数入力関数が呼
114 ばれます。
117 【呼ばれ方】
119 野鳥本体は、begin型補完とsection型補完、およびmaketitle型補完の
120 入力時に付加関数の存在を調べてから呼び出します。begin型補完の場合
121 \begin{環境名} が自動入力された直後に呼び出されます。section型補完
122 では第一引数の補完の直前、maketitle型補完の場合は、コマンド名の直
123 後(一つのスペースを挿入する直前)に呼び出されます。引数型付加関数は、
124 section型コマンドの引数の入力時にその都度呼ばれます。
127 【参考】
129 付加関数の定義の例を yatexadd.el に用意しました。実際に独自の付
130 加関数を定義する時の参考として下さい。
132 有用と思われる関数について、簡単に説明します。
134 ・関数 YaTeX:read-position
135 引数 [] の中に入れてもよい文字を羅列した文字列。
136 説明 [htb] などのような location 指定を作成します。何も入力せず
137 リターンを押すと、[]自体も省略されます。[]の中に来るべき文
138 字が htbp に限られているなら、(YaTeX:read-position "htbp")
139 と呼び出します。
141 ・関数 YaTeX:read-coordinates
142 引数 基本プロンプト, X座標プロンプト, Y座標プロンプト(全て省略可)
143 説明 「基本プロンプト X座標プロンプト:」というプロンプトを出し
144 て、X座標を読み込み、「基本プロンプト Y座標プロンプト:」を
145 出して、Y座標を読み込み、(X座標,Y座標) の様な形式を作成します。
146 何も入力せずリターンを押しても、(,)が返されます。
147 各プロンプトのデフォルトはそれぞれ、Dimension, X, Y です。
149 ・関数 YaTeX:check-comletion-type
150 引数 'begin または、'section または、'maketitle
151 説明 付加関数が呼ばれる時に、行われている補完の形式が、引数で与
152 えたものであるかどうか調べ、そうでない場合にエラー終了する。
153 なお、変数 YaTeX-current-completion-type に現在の補完の型
154 を表わすシンボル(この関数の引数と同様)が格納されています。
157 【最後に】
159 快適な関数を定義したなら、そしてそれを公開してもよいと思われたな
160 ら、筆者までお送り下さい。次の yatexadd.el に取り込んで行きたいと
161 思います。
164 広瀬雄二
165 yuuji@ae.keio.ac.jp
166 pcs39334@asciinet.or.jp