Next: Info Files, Previous: Reporting Bugs, Up: Overview
Texinfoを使用し,普通の本のような形態の印刷ドキュメントの作成が可能で, それは,章,セクション,相互参照,そして索引が含まれます.同じTexinfoの ソースファイルから,ノード,メニュー,相互参照,そして索引を用いた,メ ニュー駆動形式のオンラインInfoファイルを作成することが可能です.また,同 じソースファイルから,ウェブブラウザの利用に適したHTML出力ファイルやXML ファイルを作成することも可能です.The GNU Emacs Manualは,このマ ニュアル同様,Texinfo ファイルの良い例です.
印刷ドキュメントを作成するTexinfoソースファイルを,TeX植字プログラム を使用して処理します(しかし,Texinfo言語はTeXの普通の言語のプレーン TeXと比べてかなり異なっていて,より厳密になっています).これは,本や レポートのように植字して印刷することが可能なDVIファイルを作成します (see Hardcopy).
Infoファイルを出力するため,Texinfoソースファイルを,makeinfo
ユー
ティリティか,Emacsのtexinfo-format-buffer
コマンドで処理してくだ
さい.結果をInfoツリーにインストールすることが可能です(see Installing an Info File).
HTMLファイルを出力するために,Texinfoソースファイルでmakeinfo
--html
を実行してください.(例えば)結果をウェブサイトに配置することが可
能です.
XMLファイルを出力するために,Texinfoソースファイルでmakeinfo
--xml
を実行してください.DocBook(XMLの特殊な形式)を出力するために,
makeinfo --docbook
を実行してください.DocbookからTexinfoに
変換したい場合は,http://docbook2X.sourceforge.net/を参照してくだ
さい.
もしあなたがプログラマで,Texinfoに対する出力フォーマットの追加項目を実
装し,GNU プロジェクトに貢献したいというのは素晴らしいことです.しかし,
好みのフォーマットfooのに対して個別に書かれている変換フィルタ
texi2foo
を書かないでください! そうすることで,その作業を行なうの
も困難ですが,その後のメンテナンスで余分な仕事が発生します.なぜなら,
Texinfo言語は拡張と更新が続いているためです.その代わりの最善のアプロー
チは,makeinfo
を,現在Info,プレーンテキスト,HTML,XML,そして
DocBook を生成しているように,新しいフォーマットを生成するよう修正するこ
とです.
TeXは,ほとんど全てのプリンタで動作します.Infoは,ほとんど全てのコン ピュータ端末で動作します.HTML出力はほとんど全てのブラウザで動作します. このため,Texinfoはほとんどの全てのコンピュータユーザが利用可能です.
Texinfoソースファイルはプレーンのasciiファイルで,テキストと,植字 と書式化のプログラムに何を行なうのかを伝える@-コマンド (@-commands)(‘@’ を前置する単語)から成り立っています.Texinfoファ イルをテキストエディタで編集してもかまいませんが,GNU Emacsを使用すると 便利で,それはそのエディタにはTexinfoモードという特別なモードがあり,そ れは様々なTexinfoに関する機能を提供しているためです.(See Texinfo Mode.)
Texinfoソースファイルを書く前に,ノード,メニュー,相互参照,そしてその 他の,例えばこのマニュアルの読み方を学ぶべきです.
オンラインヘルプと印刷マニュアルの両方を作成するため,Texinfoを使用する ことが可能です.さらにTexinfoは自由に再配布できます.この理由のため, TexinfoはGNUプロジェクトの公式はドキュメントフォーマットになっています. 詳細は,GNU documentation web pageで利用 可能です.
時々,伝統的なUnix manページをTexinfoから生成できるようにして欲しいと提 案されます.これはサポートされる可能性は今のところ高くはなく,それはman ページには非常に厳密な伝統的な書式があるためです.makeinfoを troffフォーマットを出力するよう単に拡張するだけでは不十分です.それゆえ, 良いmanページを出力するには,良いユーザへのチュートリアルと良いリファレ ンスマニュアルを書き出す通常のTexinfoアプリケーションと比較すると,完全 に異なるソースが必要になります.このことは,生成されたmanページが,異な る出力形式に対し,異なる方法で,同じ情報を文章にするという,Texinfoのデ ザインの目的に矛盾します.manページを直接書く方が良いでしょう.
manページがまだ存在していてそれをサポートしたい場合,プログラム help2manが役に立つかもしれません.それは,プログラムの ‘--help’出力から伝統的なmanページを生成します.これは現在,Texinfo プログラム自身のmanページの生成に実際に使用されています.それはGNUのソフ トウェアで,Brendan O'Deaによって書かれていて, ftp://ftp.gnu.org/gnu/help2man/で利用可能です.