ドキュメントの起草

PostgreSQL 8.4.1文書
前のページ | 巻戻し | 付録 I. ドキュメント作成 | 早送り | 次のページ

# I.4. ドキュメントの起草

SGMLとDocBookを起草する際に、オープンソースとなっている数ある文章編集ツールの中からどれを選んだらよいか悩むことはありません。 最も一般的なツールは相応の編集モードを備えたEmacs/XEmacsエディタです。 いくつかのシステムにおいては、典型的なフルインストレーションを行った場合、使えるようになっています。

## I.4.1. Emacs/PSGML

PSGMLはSGMLドキュメントを編集する上で最も一般的で最も強力なモードです。 正確に設定されていればEmacsでタグを挿入したりマークアップの整合性をチェックできます。 HTMLに対しても同じように使えます。 ダウンロード、インストール手順、そして詳しいドキュメントについてはPSGML Webサイトを参照してください。

PSGMLについて1つ重要なことがあります。 ここで本書では、使用する環境としてSGML DTDのメインディレクトリは`/usr/local/lib/sgml`であると想定しています。 本章の例題のように`/usr/local/share/sgml`となっている場合には、`SGML_CATALOG_FILES`環境変数で設定するかもしくは（マニュアルでどのようにするかは説明されています）PSGMLのインストールをカスタマイズしなくてはなりません。

（パス名をシステムに合わせ）以下を`~/.emacs`ファイルに書いてください。

    ; ********** for SGML mode (psgml)

    (setq sgml-omittag t)
    (setq sgml-shorttag t)
    (setq sgml-minimize-attributes nil)
    (setq sgml-always-quote-attributes t)
    (setq sgml-indent-step 1)
    (setq sgml-indent-data t)
    (setq sgml-parent-document nil)
    (setq sgml-default-dtd-file "./reference.ced")
    (setq sgml-exposed-tags nil)
    (setq sgml-catalog-files '("/usr/local/share/sgml/catalog"))
    (setq sgml-ecat-files nil)

    (autoload 'sgml-mode "psgml" "Major mode to edit SGML files." t )

そして同じファイルに（既に）ある`auto-mode-alist`にSGMLの項目を加えます。

    (setq
      auto-mode-alist
      '(("\\.sgml$" . sgml-mode)
       ))

PostgreSQL配布物の中には、構文解析済みDTD定義ファイル`reference.ced`があります。 PSGMLを使う場合、分冊にまたがる独立したファイルを気軽に操作するには、ファイルを編集している時に適切な`DOCTYPE`宣言を挿入してください。 例えば、このソースを操作しているのであれば、付録の章ですので最初の行を以下のようにして、ドキュメントをDocBookドキュメントの"appendix"インスタンスとしてください。

    <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.2//EN">

これが意味するところは、SGMLを読む全てのまたどんなものにでも正しく処理ができるようにすることで、`nsgmls -s docguide.sgml`コマンドでドキュメントを検証できます （とは言っても、全てのドキュメント一式を作成する時にはこの行を削除しなければなりません）。

## I.4.2. その他のEmacsモード

GNU Emacsには異なるSGMLモードが含まれています。 これはPSGMLほど強力ではありませんが、よりわかりやすく、かつ、軽快に動きます。 同時に構文を強調表示（フォントロック）させることができるのでとても便利です。

Norm Walshがフォントロックと入力作業を軽減させるいくつかの機能を付けたDocBook専用のメジャーモードを提供しています。

前のページ | ホーム | 次のページ
ドキュメントのビルド | 上に戻る | スタイルガイド