FrameMaker Blog

Top > FrameMaker Blog Index > 簡単なドキュメントをDocbookで記述してみる

簡単なドキュメントをDocbookで記述してみる

まず、 簡単なドキュメントをDocbookで作成します。

Docbookにはいくつかのバージョンがありますが、 今回は、Docbook XML V4.4を使用してドキュメントを記述します。
記述するドキュメントは、 日本語版 Wikipedia のSecondLife の項目を使用します。

XML文書を作成するするためにOSは問いませんが、 ここでは関連ツールのインストールが簡単なため、 Ubuntu 8.04 を使用しています。

TOC

1. ライティング環境を整える
2. Wikipedia SecondLife 項目をDocbook XML V4.4 形式で記述

ライティング環境を整える

Docbookを記述するには、unicodeの扱えるテキストエディタが必要です。 また、記述したXMLの妥当性検証をするために、 Docbook XML V4.4のDTDを用意しておきます。

OxygenのようなXMLエディタを入手すれば、効率的にDocbookを記述することができます。 NetBeansという無料のツールでも適切にセットアップすればそれなりに生産性を確保できます。

Docbook XML V4.4のDTDの用意

妥当性検証するためのDTDをインストールします。

$ sudo apt-get install docbook-xml

/usr/share/xml/docbook/schema/dtd/4.4 以下にDTDがインストールされます。

妥当性検証ツール xmllintの用意

作成したXML文書の妥当性を検証するためのツールをインストールします。

$ sudo apt-get install libxml2-utils

Wikipedia SecondLife 項目をDocbook XML V4.4 形式で記述

内容を記述する上での基本的な書き方および使用可能な要素を調べるには、 DocBook: The Definitive Guide を参照します。

http://gist.github.com/472066

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
                         "http://www.docbook.org/xml/4.4/docbookx.dtd">
<article>
  <title>Second Life</title>
  <authorblurb>
    <para>出典: フリー百科事典『ウィキペディア（Wikipedia）』</para>
  </authorblurb>
  <abstract>
    <para>Second Life（セカンドライフ）は、アメリカのサンフランシスコに本社を置く、
    リンデンラボ（Linden Lab） 社が運営するバーチャル世界およびメタバースのこと。略称はSL。</para>
    <para>現在はLinux、Macintosh、Windows（Vistaの一部は例外）に対応している。</para>
  </abstract>
  ... 以下省略

作成したXML文書は、xmllintを使って妥当性検証します。

$ xmllint --valid secondlife.xml  > /dev/null

妥当でない場合はエラーメッセージが出力されます。