Next: , Previous: Customization, Up: Customization


13.1 すべての種類の項目に共通のキーワード

(変数やグループ、フェイスの)すべての種類のカスタマイズ宣言では、 さまざまな情報を指定するためのキーワード引数を受け付けます。 本節では、全種類に適用できるキーワードを説明します。

:tagを除くこれらのキーワードすべては、各項目で複数回使えます。 キーワードのそれぞれの使用には、独立の効果があります。 キーワード:tagは例外です。 任意の項目には名前を1つしか表示できないからです。

:tag name
カスタマイズメニューやカスタマイズバッファ内で 項目に付けるラベルとして、項目の名前のかわりに文字列nameを使う。
:group group
このカスタマイズ項目をグループgroupに入れる。 defgroupの中で:groupを使うと、 新たなグループをgroupの下位グループにする。

このキーワードを複数回使うと、 1つの項目を複数のグループに入れることができる。 それらのグループのどれを表示しても、この項目が表示される。 これを多用しすぎないように注意すること!

:link link-data
この項目に対する説明文字列のうしろに外部リンクを含める。 これは、他の説明文字列を参照するアクティブフィールドを含む文である。

link-dataとして使えるものは3種類ある。

(custom-manual info-node)
infoのノードへリンクする。 info-nodeは、"(emacs)Top"のようなノード名を指定する文字列。 リンクは、カスタマイズバッファでは‘[manual]’のように表示される。
(info-link info-node)
custom-manualと同様であるが、 カスタマイズバッファに現れるリンクはinfoのノード名になる。
(url-link url)
webページへリンクする。 urlは、urlを指定する文字列。 カスタマイズバッファに現れるリンクはurlになる。

link-dataの先頭要素のうしろに:tag nameを使うことで、 カスタマイズバッファに使うテキストを指定できる。 たとえば、(info-link :tag "foo" "(emacs)Top")とすると、 バッファでは‘foo’と表示されるEmacsマニュアルへのリンクを作れる。

1つの項目に複数個の外部リンクがあってもよいが、 ほとんどの項目には外部リンクはない。

:load file
このカスタマイズ項目を表示するまえにファイルfile(文字列)をロードする。 ファイルをすでにロードしていない場合に限り、 load-libraryでロードする。
:require feature
カスタマイズ機能を用いて保存するこの項目に対する値をインストールするときに 必要となる機能feature(シンボル)を指定する。 requireを呼び出す。

:requireを使うもっとも一般的な理由は、 変数がマイナモードなどの機能をオンにするとき、 そのモードを実装するコードをロードしてないと、 変数にはなんの効果もないからである。