&fml8; のドキュメントでは、SGML の DTD "DOCBOOK" をごくごく普通に使うことにしています。 本章は SGML で書くために最小限必要な知識についてのメモです。 基本的な SGML の書式は、当たり前 HTML は SGML 形式の応用の(最も有名な)一例です。 そのため本質的なシンタックスは HTML と同じということになります。 ですが、正しい HTML の書き方と同様です。 本付録で、2、3 の典型的な SGML テンプレートをメモしておくので、 それらを適当に切り剥ぎしていけば、なんとかなるはずです。 SGML は本や短い文書(記事)を作成する際に使われます。 文章の論理構造を記述するための規格です。 HTML のもっと厳密なものだと思って下さい。 正確には「SGML の一部にフォーマッタの要素が合体したもの」が HTML です。 HTML の方がはるかに有名になってしまったので、 「HTML のもっと厳密なもの…」といった説明が良くされます :) たとえば、”本”という概念を考えてみます。 まず”本”には章、節といった構成単位があります。 節の中にはパラグラフがありますし、文には脚注がついたり、 図などが挟み込まれたりします。 これらの概念には、ある関係があります。 たとえば”章”は”節”を含みますが、”節”は”章”を含みません。 そして、文は必ず「あるパラグラフ」の中に「ある」ものです。 そういった概念をどう表現するべきか？を規定したものが DTD (Data Type Definition)といえます。 DTD は自由に定義できますが、定義自体が大変な作業です。 しかしながら 誰かが作った DTD コレクションが世の中にはあるので、 それを使うのが便利です。 我々は DTD として docbook というものを使う 我々が DOCBOOK を選んだ理由は簡単で、 多くの場所で使われているからです。 つまり、docbook のタグを書ける人が世の中に多いという意味でもあります。 ことにしています。 DOCBOOK は OASIS-0PEN.ORG が保守している DTD 集です。 非常に有名なもので、デファクトスタンダードといってもよいでしょう。 (わかりやすいかどうかは別として;)リファレンスがオライリーから本も出ていますし、 ドキュメントも豊富です。 Free の Unix などをはじめ、多くのプロジェクトで使われています。 つまり、SGML を使うことで得られる最大の意義は 「ある基準となるもの」に規格化ないしは強制されるということです。 これは SGML の構文による規制という意味ではありません。 ある概念に従うことに強制されようということです。 ここで”概念”といっているのであって、 ”見栄え”についてはふれていないことに注意して下さい。 たとえば HTML では概念と見栄えは(むしろ意識的に)はっきり分離していません。 見栄えは DTD とは別の何かで定義されます。 通常スタイルシートというものです。 HTML 4.0 の CSS と同じ概念です。 スタイルシートの記述にもプログラミング言語が必要です。 docbook では schema (lisp の一種) ベースの DSSSL (Document Style Semantics and Specification Language) を使います。 また SGML では論理構造しか記述しないので、 見栄えはコンバータ次第でどうとでもなります。 HTML、テキスト、ROFF、PS、PDF、RTF をはじめ、 いろいろなものへ変換するやり方が用意されています。 docbook DTD には book や article といった代表的な形式についての定義があります。 book スタイルの典型的な SGML のテンプレートは次のようになります。 <!doctype book public "-//OASIS//DTD DocBook V3.1//EN" [ <!entity % include SYSTEM "include.sgml"> %include; ]> <book> &bookinfo; &preface; <toc></toc> <part> <title> タイトル </title> <partintro> <para> 本パートは…目指しています。 </para> </partintro> <!-- 以下、各章が並ぶ --> &overview; </part> </book> part や title は文字通りの意味です。 ここで注目するべきは、SYSTEM というキーワードのある、 2 行目です。 これは include.sgml を読み込む( include する)命令です。 C 言語の #include や perl の require() と同様の働きをしています。 さらに、 include.sgml の中では次のような命令が定義されています。 <!-- include する SGML ファイル群 --> <!entity bookinfo SYSTEM "bookinfo.sgml"> <!entity overview SYSTEM "overview.sgml"> これらの定義により &bookinfo; 命令で bookinfo.sgml が include されるようになります。 このようにして、文書本体と include するべき定義ファイルを 分離することができます。 <itemizedlist> <listitem> <para> アイテム１ </para> </listitem> <listitem> <para> アイテム２ </para> </listitem> </itemizedlist> たとえば <itemizedlist> <listitem> <para> けんけんはきたきつね </para> </listitem> <listitem> <para> るどるどはばんざいベア </para> </listitem> </itemizedlist> は次のようになります。 けんけんはきたきつね るどるどはばんざいベア 数字付のアイテムは orderedlist です。 けんけんはきたきつね るどるどはばんざいベア <para> <table> <title> テーブルのタイトル </title> <tgroup cols=2> <thead> <row> <entry> キー </entry> <entry> 値 </entry> </row> </thead> <tbody> <row> <entry> キー 1 </entry> <entry> 値 1 </entry> </row> <row> <entry> キー 2 </entry> <entry> 値 2 </entry> </row> </tbody> </tgroup> </table> </para> たとえば <para> <table> <title> table description </title> <tgroup cols=2> <thead> <row> <entry> 名前 </entry> <entry> 説明 </entry> </row> </thead> <tbody> <row> <entry> けんけん </entry> <entry> きたきつね </entry> </row> <row> <entry> るど </entry> <entry> ばんざいベア </entry> </row> </tbody> </tgroup> </table> </para> は次のようになります。 名前 説明 けんけん きたきつね るど ばんざいベア SGML を HTML などに翻訳するために、いくつかのツールが必要です。 また DTD と DSL の規格文書群も必須です。 処理系としては openjade と opensp opensp は openjade パッケージに含まれています。 が必須のプログラムでしょう。 その他はオプショナルで、各自が好きにすればよいようです。 &fml8; では、 以下のプログラムを使って HTML やテキストファイルを作成しています。 openjade 1.3 以降 opensp 1.3.4 以降 多くの OS ではこれらのプログラムを附属のパッケージシステムで簡単に インストールできるでしょう。 また、SGML からの変換には fml/doc/share/sgml/ にある fml.dtd と fml.dsl を定義として使っています。 各 Makefile 内に、これらのファイルを各ツールでどう使うかの定義 (openjade に与えるオプション -c や -d オプション)が記述されています。 SGML は論理的な構造を記述している言語です。 HTML の各ページに URL をつけたいとか、画像をつけたいといった "見栄えの記述"を SGML で直接変更することはできません。 見栄えは DSL により記述をすることになります。 しかしながら、DSL は本質的に LISP (List Processor) 言語なので、 LISP を知らないとちょっと手が出ないでしょう。 見栄えは誰かが頑張った結果だけ使えということなのかもしれません。 ちなみに &fml8; の DSL の記述は fml/doc/share/sgml/fml.dsl にあります。 こういったものを書かないと見栄えを変えることができません ;) SGML の書き方については FreeBSD の初心者向けチュートリアル などを参照して下さい。 必要なツールのインストールについては http://www.linuxdoc.org/HOWTO/mini/DocBook-Install/ を参照して下さい。 SGML のタグの一覧は DOCBOOK definitive guide (O'reilly) のオンライン版を参照するのが便利です。