1.10 Texinfoの短いサンプル

非常に短いが完全なTexinfoファイルは以下のようになり，前のセクションの六 つの慣習的な部分が列挙されているので，Texinfoソースをどのように表現する のかが実際に分かるでしょう．ファイルの最初の三つの部分は`\input texinfo'から`@end titlepage'までで，他より恐ろしく(?)¹見えます．素材のほとんどが標準的な常套 句です．マニュアルを書くとき，単純にこの部分を適切な名前に変更してくださ い．

ここでリストアップしているコマンドの完全なドキュメントは， See Beginning a File. GNUのマニュアルで使用されている完全なテキスト は，See GNU Sample Texts.

以下では，サンプルテキストは字下げされています．そこでのコメント はそうなっていません．散らかっているコメントの無い完全なファイルは， Short Sample Texinfo Fileで示されています．

Part 1: ヘッダ

ヘッダはInfoファイルにも印刷物にも現れません．それは様々な変数を設定し， それにはInfoファイルの名前とヘッダで使用されているタイトルが含まれていま す．

     \input texinfo   @c -*-texinfo-*-
     @c %**start of header
     @setfilename sample.info
     @settitle Sample Manual 1.0
     @c %**end of header

Part 2: 要約の記述と著作権

実際のマニュアルには，それを配布するライセンスに対応して，ここにより多く のテキストを含んでいます．See GNU Sample Texts.

     @copying
     This is a short example of a complete Texinfo file, version 1.0.
     
     Copyright @copyright{} 2002 Free Software Foundation, Inc.
     @end copying

Part 3: タイトルページ，目次，著作権

タイトルページの部分はオンラインの出力には現れず，印刷されたマニュアルの みに現れます．我々はもう一度書く代わりに，前のセクションから許可のテキス トを含めるために，@insertcopyingコマンドを使用しています．それは タイトルページの裏側に出力します．@contentsコマンドは目次を生成 します．

     @titlepage
     @title Sample Title
     
     @c The following two commands start the copyright page.
     @page
     @vskip 0pt plus 1filll
     @insertcopying
     @end titlepage
     
     @c Output the table of contents at the beginning.
     @contents

Part 4: `Top'ノードとマスターメニュー

`Top'ノードは，Infoファイルのマスターメニューを含んでいます．印刷された マニュアルはメニューではなく目次を使用するので，マスターメニューはオンラ インの出力だけに現れます．我々は，読書への利便性のためコピーに関するテキ ストも再び含めています．そして，コピーに関するテキストはマニュアルの短い 記述の一部で始まっているので，他のテキストは不要です．

     @ifnottex
     @node Top
     @end ifnottex

     @insertcopying
     
     @menu
     * First Chapter::    The first chapter is the
                            only chapter in this sample.
     * Index::            Complete index.
     @end menu

Part 5: ドキュメントの本体

本体の部分はドキュメントの全ての部分を含んでいますが，索引と目次は含まれ ていません．この例は，列挙されたリストを含んでいるノードと章を示していま す．

     @node First Chapter
     @chapter First Chapter
     
     @cindex chapter, first
     
     This is the first chapter.
     @cindex index entry, another
     
     Here is a numbered list.
     
     @enumerate
     @item
     This is the first item.
     
     @item
     This is the second item.
     @end enumerate

Part 6: ドキュメントの終り

終りの部分は，それ自身が番号付けされていない章とノードとして索引を生成す るコマンドと，ドキュメントの終りを示す@byeコマンドを含んでいます．

     @node Index
     @unnumbered Index
     
     @printindex cp
     
     @bye

その結果

サンプルの最初の章の内容のサンプルは以下のように見えます．

This is the first chapter.

Here is a numbered list.

1. This is the first item.
2. This is the second item.