 |
 |
 |
Python ドキュメントの作成 |  |
 |
|
|
|
|
Python ドキュメントの作成 | |
|
|
この節では、LaTeX の概念と構文法について簡単に紹介し、 ドキュメントの作者が ``TeXnician'' にならなくてもドキュメントを 十分生産的に書けるような情報を提供します。 この節を読んだからといって、LaTeX でドキュメントを書く上で必要な 全ては学べません; LaTeX が提供している標準の ``環境 (environment)'' については、ここでは説明しません。
おそらく、Python ドキュメントのマークアップにおいて心に留めておくべき 最も重要な概念は、TeX が非体系的なのに対して、LaTeX は TeX の上のレイヤとして設計されていて、本質的には構造化マークアップを サポートしているということです。 Python 特有のマークアップは、 標準の LaTeX ドキュメントクラスで提供されている構造を拡張し、 Python 特有の情報を書けるようサポートするためのものです。
LaTeX ドキュメントには、二つの構成要素: プリアンブルと本体が 入っています。プリアンブルは、タイトル、著者のリスト、日付、ドキュメント が属する クラス といった、ドキュメント自体に関するメタデータ を指定するために使います。その他の情報で、インデクスの生成や 参考文献データベースの使用を制御するものもプリアンブル内に置けます。 ほとんどの著者にとっては、既存のドキュメントからプリアンブルをコピーし、 いくつかの情報を修正するだけで、簡単にプリアンブルを作成できます。
ドキュメントのクラス は、ドキュメントをある広範なカテゴリに
分類し、そのカテゴリで共通の基本的なフォーマットプロパティを設定する
ために使います。 Python ドキュメントの場合、二つのクラス:
manual クラスと howto クラスを使います。
これらのクラスではまた、Python における概念やデータ構造を説明
する際に使うマークアップも定義しています。これらのクラスに
関する詳しい説明は、後述の 5 節、 ``ドキュメントクラス''
にあります。ドキュメントクラスの宣言はプリアンブルの先頭にあります。
クラス宣言の後ろには数多くのマクロ があり、ドキュメントに 関する詳細情報を宣言したり、追加のマークアップを設定しています。 プリアンブルからは何も出力生成されません; 自由文 (free text) は出力生成につながるため、プリアンブルに自由文をおくとエラーに なります。
ドキュメント本体はプリアンブルの後に続けます。本体には、出力すべき ドキュメントの構成要素を構造的にマークアップして入れます。 一般的なLaTeX の構造には、階層化された章節、番号付けリストや 箇条書きリスト、そしてドキュメントの概要や索引といった特殊な 構造があります。
|
|
|
Python ドキュメントの作成 | |
|
|