DocBook の覚え書きを兼ねて DocBook を説明してみる。オープンソース系のドキュメントプロジェクトではよく利用されているし、普通にソフトウェアのドキュメントを書くために使えるツールだと思う。

Contents

  1. DocBook とは
    1. DocBook XSL Stylesheets
    2. よく使われる book と article
  2. メリット/デメリット
    1. メリット
    2. デメリット
  3. サンプル コード
  4. 必須のツール
  5. その他のツール
  6. XSL
  7. エレメント リファレンス
  8. 参考文献

DocBook とは

DocBook は SGML または XML を使用して構造化された文書を書くためのシステムを提供する。わかりやすくいえば、文書を構造化するマークアップ言語 - DTD である。コンピューター ハードウェアとソフトウェアの技術文書に適しているが、それらの分野に特化した制限は無く、他の種類の文書にも使用できる。

日本語で書かれた DocBook に関する体系的な文書がほとんど存在しないのが日本人にとっては難点である。しかし世界的にはドキュメントの作成に DocBook を使用しているプロジェクトが多数存在する。無償のドキュメント ツールとしてはデファクトスタンダードであると想像できる。

DocBook を用いて書かれた文書はプログラムで言えばソースコードに当たる。種々のツールを利用して DocBook から、HTML や PDF 文書など、他のフォーマットに変換することができる。DocBook もテキスト データとして保存され、そのテキストから HTML 文書や PDF 文書を出力するためのツールが存在する。プログラム開発でのソースコードとコンパイラとでも言うべき関係だ。

DocBook は SGML および XML で記述するが現在は XML が主流である。

O'REILLY から出版された Docbook: The Definitive Guide (洋書) がオンラインで無償で公開されている。ただしこの書籍は DocBook バージョン 3.x をサポートしたものであり、現在メジャーなバージョンである 4.x の文書は http://www.docbook.org/docs/ で入手可能。5.x のドキュメントも作業中ではあるが公開されている。

DocBook XSL Stylesheets

DocBook XML 文書は XSLT エンジン(xsltproc,Saxon)を利用して、異なる出力形式に変換する。そのためのスタイルシートが XSL Styleshets であり DocBook のための XSL をメインに開発しているのが The DocBook Project である。DocBook Project の成果物は MacPorts では docbook-xsl, Gentoo Linux では docbook-xsl-stylesheets というパッケージ名で配布されている。たいてい docbook の依存パッケージとして同時にインストールされるのかな？

DocBook XSL Stylesheets は次の出力形式のスタイルシートを用意している。これらのスタイルシートを指定して XSLT エンジン(XSLTプロセッサ)で処理してやれば任意のデータに変換できるわけだ。

スタンダードなスキーマ：

スライド用のスキーマ：

ウェブサイト用のスキーマ：

(「〜のスキーマ」って書いてるけどよくわかっていない。ウェブサイト用のは MacPorts には含まれていない模様)

よく使われる book と article

DocBook は本、本のセット、章、記事、リファレンス マニュアルを作成することができる。なかでも最も使われるのが本を書くための book と記事を書くための article だ。book は 章と節から成り、article は節の複合物である。book では論文を書いたり、名の通り書物に仕上げる事ができる。aritcle は新聞記事やコラムなど形式にとらわれない文章の作成に使う。

メリット/デメリット

HTML と比較した DocBook の利点と欠点。

メリット

デメリット

サンプル コード

(LATER)

必須のツール

その他のツール

XSL

(LATER)

エレメント リファレンス

(LATER)

参考文献

最終更新日 2009-05-03 15:38:58