Next: Verbatim Copying License, Previous: Short Sample Texinfo File, Up: Sample Texinfo Files
以下はGNUマニュアルで使用されるべき完全なテキストを用いたTexinfoドキュメ ントの見本です.
法的なテキストと同様に,GNUシステムがマニュアルに影響を与える要素の数の 実際の例として提供しています.これら個別のすべての要素に慣れていなくても 心配しないでください.それらは要求されているわけではなく,完全な良いマニュ アルではそれ無しで書かれているはずです.多くのマニュアルにはきっと(おそ らく)利点となるので,それでも以下には含めています.
Texinfoファイルの最小限の例はSee Short Sample. 最小限の例の完全な説 明は,See Beginning a File.
以下は例の注意事項です.
$Id: texinfo-ja.texi,v 1.1 2003/01/04 10:43:13 futoshi Exp $
(これはマニュアルだけでなく,バージョンコントロールを使用するすべてのソー
スで役に立ちます.ドキュメントのバージョンを完全に明確に引用したい場合,
@copying
のテキストに‘$Id:’コメントを含めたいかもしれません.)
@include
コマンドのversion.texiは,Automakeで自動的に管理
されます(see Introduction).それは,他
で使用されている‘VERSION’と‘UPDATED’の値を設定します.配布物で
Automakeを使用しておらず,Emacsは使用している場合,time-stamp.el パッケー
ジが役に立つことが分かるでしょう(see Time Stamps).
@syncodeindex
コマンドでは,読者が索引項目を探し易いようにするた
め,可能な場合は推奨されている一つの索引だけを使用するように考えます.
@dircategory
は,Infoディレクトリを構築するためのものです.推奨さ
れる様々なカテゴリの名前がある,See Installing Dir Entries.
FDLは,特定の条件の下でそれ自身を省略するために提供されていますが,その 場合,ここで与えられてテキストを編集する必要があります.See GNU Free Documentation License.
見本のドキュメントは以下のようになります.
\input texinfo @c -*-texinfo-*- @comment $Id: texinfo-ja.texi,v 1.1 2003/01/04 10:43:13 futoshi Exp $ @comment %**start of header @setfilename sample.info @include version.texi @settitle GNU Sample @value{VERSION} @syncodeindex pg cp @comment %**end of header @copying This manual is for GNU Sample (version @value{VERSION}, @value{UPDATED}), which is an example in the Texinfo documentation. Copyright @copyright{} 2002 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,'' and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License.'' (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify this GNU Manual, like GNU software. Copies published by the Free Software Foundation raise funds for GNU development.'' @end quotation @end copying @dircategory Texinfo documentation system @direntry * sample: (sample)Invoking sample. @end direntry @titlepage @title GNU Sample @subtitle for version @value{VERSION}, @value{UPDATED} @author A.U. Thor (@email{bug-texinfo@@gnu.org}) @page @vskip 0pt plus 1filll @insertcopying @end titlepage @contents @ifnottex @node Top @top GNU Sample @insertcopying @end ifnottex @menu * Invoking sample:: * Copying This Manual:: * Index:: @end menu @node Invoking sample @chapter Invoking sample @pindex sample @cindex invoking @command{sample} This is a sample manual. There is no sample program to invoke, but if there was, you could see its basic usage and command line options here. @node Copying This Manual @appendix Copying This Manual @menu * GNU Free Documentation License:: License for copying this manual. @end menu @include fdl.texi @node Index @unnumbered Index @printindex cp @bye