[ << ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
メニュー(Menus)は,従属的なノードへのポインタを含みます. (7)Infoで は,メニューをそのようなノードへ行くために使用します.メニューは印刷され たマニュアルで効果がなく,それらには現れません.
慣習で,メニューを使用する読者がそれ以降のテキストを見ない可能性があるの で,メニューはノードの終りに置かれます.さらに,メニューがあるノードは多 くのテキストを含むべきではありません.多くのテキストとメニューがある場合 は,テキストのほとんどを -- 数行以外全て -- 新しいサブノードに移動して ください.そうしない場合,数行しか表示できない端末を使用している読者は, メニューとそれに関連するテキストが見えません.実際問題として,メニューは ノードの最初の20行以内に配置すべきです.
Menus Need Short Nodes | Put a menu in a short node. | |
7.1 メニューを書く | What is a menu? | |
7.2 メニューの部品 | A menu entry has three parts. | |
7.3 バラバラでないメニュー項目 | Two part menu entry. | |
7.4 メニューの例 | Two and three part menu entries. | |
7.5 他のInfoファイルへの参照 | How to refer to a different Info file. |
メニューの前の短いテキストは,印刷されたマニュアルで不様に見えるかもしれ
ません.これを避けるため,メニューをそのノードの最初の方に書き,メニュー
を@node
行で続け,その後で@heading
行を@ifinfo
と
@end ifinfo
の間に書くことが可能です.こうすることで,
@node
行のメニューとタイトルはInfoファイルでしか現れず,印刷され
たドキュメントには現れません.
例えば,前の二つの段落は,Infoのみのメニュー@node
行と見出しが続き,
以下のように見えます.
@menu * Menu Location:: Put a menu in a short node. * Writing a Menu:: What is a menu? * Menu Parts:: A menu entry has three parts. * Less Cluttered Menu Entry:: Two part menu entry. * Menu Example:: Two and three part entries. * Other Info Files:: How to refer to a different Info file. @end menu @node Menu Location, Writing a Menu, , Menus @ifinfo @heading Menus Need Short Nodes @end ifinfo |
このドキュメントのTexinfoファイルは,1ダース以上のこの手続きの例を含んで います.一つはこの章の最初にあります.もう一つはこの章の最初にあります.
メニューは,単独行の@menu
コマンドと,それに続く項目行やメニュー
コメント行と,その後の単独行の@end menu
コマンドから成り立ちます.
メニューは,以下のようになります.
@menu Larger Units of Text * Files:: All about handling files. * Multiples: Buffers. Multiple buffers; editing several files at once. @end menu |
メニューでは,`* 'で始まる全ての行はメニュー項目(menu entry)です.(アスタリスクの後のスペースに注意してください.)`* 'で始まらない行もメニューに現すこともできます.そのような行はメニュー項 目ではなく,Info ファイルに現れるメニューのコメント行になります.上記の 例では,`Larger Units of Text'はメニューのコメント行です. `* 'で始まる二行はメニュー 項目です.メニューのスペース文字はそのまま維持されます.これで,メニュー を望み通りに書式化できます.
メニュー項目は,三つの部品があり,二番目のみ必要です.
メニュー項目のテンプレートは以下のようになります.
* menu-entry-name: node-name. description |
メニュー項目名に,一つのコロンを続け,ノード名にタブ,カンマ,ピリオド, または改行を続けてください.
Infoでは,ユーザはノードをm(Info-menu
)コマンドで選択します.
メニュー項目名は,ユーザがmコマンドの後で入力するものです.
メニュー項目の三番目の部分は記述的な句または文です.メニュー項目名とノー ド名は短い場合が多くなります.記述は,読者に何について書かれているノード かを説明します.役立つ記述は,繰り返しではなくノード名への補完になります. 追加の記述は,二行以上に分けることができます.そうする場合,著作者は最初 (と他の全て)と同列にするより,二行目を字下げするほうを好みます.それはお 好みでお願いします.
メニュー項目名とノード名が同じとき,行の最初でアスタリスクとスペースの直 後に名前を書き,名前に二つのコロンを続けることが可能です.
例えば,以下のように書きます.
* Name:: description |
以下の代わりです.
* Name: Name. description |
メニューが見た目バラバラに散らばるので,可能な場合はノード名をメニュー項 目名として使用すべきです.
Texinfoでは,メニューは以下のようになります.
@menu * menu entry name: Node name. A short description. * Node name:: This form is preferred. @end menu |
これは,以下を生成します.
* menu: * menu entry name: Node name. A short description. * Node name:: This form is preferred. |
Texinfoファイルで見られる例は以下のようになります.
@menu Larger Units of Text * Files:: All about handling files. * Multiples: Buffers. Multiple buffers; editing several files at once. @end menu |
これは,以下を生成します.
* menu: Larger Units of Text * Files:: All about handling files. * Multiples: Buffers. Multiple buffers; editing several files at once. |
この例ではメニューに二つの項目があります.`Files'はメニュー項目とそ の名前で参照されるノード名です.`Multiples'はメニュー項目名です.そ れは,`Buffers'という名前のノードで参照します.`Larger Units of Text'はコメントです.それはメニューには現れますが項目ではありません.
`Files'や`Buffers'でファイル名が指定されていないので,それらは 同じInfoファイルでのノード名にする必要があります.(see section Referring to Other Info Files).
ノード名の直前のカッコにファイル名を書くことで,Infoの読者が他のInfoファ イルのノードへ行くことを可能にするメニュー項目を作成することが可能です. この場合,三つの部分のメニュー項目の書式を使用するべきで,それで読者はファ イル名を入力することを省略できます.
書式は,以下のようになります.
@menu * first-entry-name:(filename)nodename. description * second-entry-name:(filename)second-node. description @end menu |
例えば,Emacs Manualで直接`Outlining'と`Rebinding'ノー ドを参照するため,メニューを以下のように書きます.
@menu * Outlining: (emacs)Outline Mode. The major mode for editing outlines. * Rebinding: (emacs)Rebinding. How to redefine the meaning of a key. @end menu |
ノード名をリストアップせずファイル名だけにする場合,Infoは`Top'ノードを 参照しているものと推測します.
Infoのメインメニューを含む`dir'ファイルには,ファイル名のみを列挙し たメニュー項目があります.これで,それぞれのInfoドキュメントの`Top'ノー ドへ直接行くことができます(see section 20.2 Infoファイルのインストール).
例えば,以下のようになります.
* Info: (info). Documentation browsing system. * Emacs: (emacs). The extensible, self-documenting text editor. |
(Infoシステムのための`dir'のトップレベルディレクトリは,Texinfoファ イルではなくInfoファイルですが,メニュー項目はどちらの形式のファイルでも 同じように見えます.)
GNU Emacs Texinfoモードでのメニュー更新コマンドは,現在のバッファのノー ドでのみ動作するので,他のファイルを参照するメニューを作成するために使用 することは不可能です.そのようなメニューは手で書く必要があります.
[ << ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |