ツールセット

We have documented experience with two installation methods for the various tools that are needed to process the documentation. One is installation from RPMs on Linux, the other is a general installation from original distributions of the individual tools. Both will be described below.

文書作成処理にて必要とされた様々なツールをインストールする時に使った 2 つの方法についての経験談を示します。1 つは Linux での RPM を使った インストールで、他方は一般的な、個々のツールのオリジナル配布物からの インストールです。両方について以下に示します。

We understand that there are some other packaged distributions for these tools. FreeBSD seems to have them available. Please report package status to the docs mailing list and we will include that information here. これらのツール用のパッケージ化された配布物が他にもあることを知ってい ます。FreeBSD にも利用可能なものがあるよう です。パッケージの状態を docs メーリングリストに報告して下さい。頂い た情報をここに含めるつもりです。

Linux での RPM を使ったインストール

Install RPMs for Jade and related packages.

Jade と関連するパッケージ用の RPMsをインストールして下さい。

ツールのマニュアルインストール

This is a brief run-through of the process of obtaining and installing the software you'll need to edit DocBook source with Emacs and process it with Norman Walsh's DSSSL style sheets to create HTML and RTF.

DocBook ソースを Emacs を使って編集する際、及び、Norman Walsh 氏の DSSSL スタイルシートを使って HTMLRTF の生成処理を行なう際に必要とする、ソフトウエ アの入手とインストールの過程についての簡単な実行手順を示します。

These instructions do not cover new jade/DocBook support in the sgml-tools package. The authors have not tried this package since it adopted DocBook, but it is almost certainly a good candidate for use.

ここでの手順は、 sgml-tools パッケージにある、新しい jade/DocBook サ ポートを範囲にはしていません。私たちは、このパッケージが DocBook を 対応してから、このパッケージを試したことがありません。しかし、その使 用はほとんど確かに良い候補です。

事前に必要なもの

What you need:

必要とするものは、以下のものです。

  • GCC 2.7.2 が動作するようにインストールされていること

  • Emacs 19.19 以降が動作するようにインストールされていること

  • 伸長用の UNIX 用の unzip プログラム

What you must fetch:

入手しなければいけないものは以下のものです。

Important URLs:

重要なURLとして以下のものがあります。 -->

Jade のインストール

Jade のインストール

  1. Read the installation instructions at the above listed URL.

    上述の URL 一覧にあるインストール手順を読んで下さい。

  2. Unzip the distribution kit in a suitable place. The command to do this will be something like

    適当なところで配布物を unzip して下さい。これを行なうコマンドは次 のようなものになります。

    unzip -aU jade1_1.zip

  3. Jade is not built using GNU Autoconf, so you'll need to edit a Makefile yourself. Since James Clark has been good enough to prepare his kit for it, it is a good idea to make a build directory (named for your machine architecture, perhaps) under the main directory of the Jade distribution, copy the file Makefile from the main directory into it, edit it there, and then run make there.

    JadeGNU Autoconf を使って構築されていません ので、Makefile を自分で編集しなければいけませ ん。James Clark 氏はかなり十分にキットを準備していますので、構築用 のディレクトリを(多分マシンのアーキテクチャの名前で)、 Jade 配布物のメインディレクトリの下に作 成し、Makefile ファイルをメインディレクトリか らそこにコピーし、そこで編集及び makeを実行する ことは良い考えです。

    However, the Makefile does need to be edited. There is a file called Makefile.jade in the main directory, which is intended to be used with make -f Makefile.jade when building Jade (as opposed to just SP, the SGML parser kit that Jade is built upon). We suggest that you don't do that, though, since there is more that you need to change than what is in Makefile.jade, so you'd have to edit one of them anyway.

    しかし、Makefile は編集される必要がありません。メ インディレクトリには Jade 構築時に make -f Makefile.jade として使われることを目的とし た Makefile.jade というファイルがあります。( Jade を構築する際に使用する、 SGML のパーサ・キット SP とは対象的です。)ですが、それをしないことを勧めます。 Makefile.jade 内のものよりも多くのものを変更しな ければいけないからです。まぁともかくどちらかを編集しなければいけません。

    Go through the Makefile, reading James' instructions and editing as needed. There are various variables that need to be set. Here is a collected summary of the most important ones, with typical values:

    James 氏の手順を読みながら、必要な編集を Makefile 全体に行なって下さい。設定が必要な多く の変数があります。以下に、最も重要な変数とその典型的な値をまとめたも のを示します。

    prefix = /usr/local
    XDEFINES = -DSGML_CATALOG_FILES_DEFAULT=\"/usr/local/share/sgml/catalog\"
    XLIBS = -lm
    RANLIB = ranlib
    srcdir = ..
    XLIBDIRS = grove spgrove style
    XPROGDIRS = jade
    Note the specification of where to find the default catalog of SGML support files -- you may want to change that to something more suitable for your own installation. If your system doesn't need the above settings for the math library and the ranlib command, leave them as they are in the Makefile. SGML サポートファイルのカタログのデフォルト値をど こにするのかという指定には注意して下さい。もっとインストール環境に適 した別のところに変更した方がいいかもしれません。上の数学ライブラリと ranlib コマンドの設定を必要としないシステムの場合 は、Makefile 内の記述のままにしておいて下さい。

  4. Type make to build Jade and the various SP tools.

    Jade と各種 SP ツールを構築するために make と入力して下さい。

  5. Once the software is built, make install will do the obvious.

    ソフトウエアの構築が終ってから、make install を入力 してインストールを行なって下さい。

DocBook DTD キットのインストール

DocBook DTD キットのインストール

  1. You'll want to place the files that make up the DocBook DTD kit in the directory you built Jade to expect them in, which, if you followed our suggestion above, is /usr/local/share/sgml/. In addition to the actual DocBook files, you'll need to have a catalog file in place, for the mapping of document type specifications and external entity references to actual files in that directory. You'll also want the ISO character set mappings, and probably one or more versions of HTML.

    DocBook DTD キットを Jade がそこにあるべきとしているディレクト リ、上で示した通りに構築している場合は /usr/local/share/sgml/ にファイルを設置した方が いいでしょう。実際の DocBook ファイル以外 にも、文書型の指定と外部実体参照をそのディレクトリ内にある実際のファ イルに割り当てるための catalog ファイルも適切な 状態にしておかなければいけません。ISO 文字セット のマッピングと多分複数のバージョンの HTML の設定 もした方がいいでしょう。

    One way to install the various DTD and support files and set up the catalog file, is to collect them all into the above mentioned directory, use a single file named CATALOG to describe them all, and then create the file catalog as a catalog pointer to the former, by giving it the single line of content:

    各種 DTD とサポートファイルのインストール、及び、 catalog ファイルの設定を行なう 1 つの方法は、そ れらを全て上述のディレクトリにまとめ、それら全てを記述した CATALOG という名前の 1 ファイルを使用し、このフ ァイルを示すカタログとなる、次の 1 行を内容とした catalog ファイルを作成するという方法です。

    CATALOG /usr/local/share/sgml/CATALOG

  2. The CATALOG file should then contain three types of lines. The first is the (optional) SGML declaration, thus:

    CATALOG ファイルには 3 種類の行があります。最初の ものは、以下のような(オプションの)SGML 宣言です。

    SGMLDECL docbook.dcl
    Next, the various references to DTD and entity files must be resolved. For the DocBook files, these lines look like this: 次に、DTD の各種参照と実体ファイルが解決されなけれ ばいけません。DocBook ファイルの場合は、次 のような行になります。
    PUBLIC "-//Davenport//DTD DocBook V3.0//EN" docbook.dtd
    PUBLIC "-//USA-DOD//DTD Table Model 951010//EN" cals-tbl.dtd
    PUBLIC "-//Davenport//ELEMENTS DocBook Information Pool V3.0//EN" dbpool.mod
    PUBLIC "-//Davenport//ELEMENTS DocBook Document Hierarchy V3.0//EN" dbhier.mod
    PUBLIC "-//Davenport//ENTITIES DocBook Additional General Entities V3.0//EN" dbgenent.mod

  3. Of course, a file containing these comes with the DocBook kit. Note that the last item on each of these lines is a file name, given here without a path. You can put the files in subdirectories of your main SGML directory if you like, of course, and modify the reference in the CATALOG file. DocBook also references the ISO character set entities, so you need to fetch and install these (they are available from several sources, and are easily found by way of the URLs listed above), along with catalog entries for all of them, such as:

    もちろん、これらの行を含むファイルは DocBook キットにも入っています。この行の最後のアイテムが、パス指定の無いファイル 名であることに注目して下さい。好みに応じて、ファイルを SGML メインディレクトリの下のサブディレクトリに設置す ることができます。もちろん、CATALOG ファイル中の参 照を編集することもできます。また DocBookISO 文字セットの実体も参照しますので、これらも入手し て、これら全てについての、次のようなカタログエントリを加えてインストー ルしなければいけません。(複数のところから入手できます。上述の URL 一覧 から簡単に見つけられます。)

    PUBLIC "ISO 8879-1986//ENTITIES Added Latin 1//EN" ISO/ISOlat1
    Note how the file name here contains a directory name, showing that we've placed the ISO entity files in a subdirectory named ISO. Again, proper catalog entries should accompany the entity kit you fetch. ここでのファイル名にディレクトリ名が含まれ、ISO の 実体ファイルを ISO というサブディレクトリに設置し ていることを示していることに注意して下さい。さらに、適切なカタログエン トリは入手した実体キットに附属しています。

Norman Walsh 氏の DSSSL スタイルシートのインストール

Norman Walsh 氏の DSSSL スタイルシートのインストール

  1. Read the installation instructions at the above listed URL.

    上述の URL 一覧にあるインストール手順を読んで下さい。

  2. To install Norman's style sheets, simply unzip the distribution kit in a suitable place. A good place to dot this would be /usr/local/share, which places the kit in a directory tree under /usr/local/share/docbook. The command will be something like

    Norman 氏のスタイルシートをインストールするためには、単に適当な場所で 配布キットを unzip します。これを行なうのに適切な場所は /usr/local/share で、その場合、このキットは /usr/local/share/docbook 以下のディレクトリツリー に設置されます。次のようなコマンドを入力します。

    unzip -aU db119.zip

  3. One way to test the installation is to build the HTML and RTF forms of the PostgreSQL User's Guide.

    インストールに関する試験の 1 つの方法は、 PostgreSQL ユーザーズガイドHTMLRTF 形式を作成する ことです。

    1. To build the HTML files, go to the SGML source directory, doc/src/sgml, and say

      HTML ファイルを構築するためには、 SGMLソースディレクトリ、 doc/src/sgml に移動し、以下を入力します。

      jade -t sgml -d /usr/local/share/docbook/html/docbook.dsl -D ../graphics postgres.sgml

      book1.htm is the top level node of the output..

      book1.htm がこの出力の最上位ノードとなります。

    2. To generate the RTF output, ready for importing into your favorite word processing system and printing, type:

      RTF 出力を生成して、お好みのワープロへのインポート 及び印刷の準備をするためには、次のコマンドを入力します。

      jade -t rtf -d /usr/local/share/docbook/print/docbook.dsl -D ../graphics postgres.sgml

PSGML のインストール

PSGML のインストール

  1. Read the installation instructions at the above listed URL.

    上述の URL 一覧にあるインストール手順を読んで下さい。

  2. Unpack the distribution file, run configure, make and make install to put the byte-compiled files and info library in place.

    配布ファイルを伸長し、configure、make、make install を実行して、バ イトコンパイルされたファイルと info ライブラリを適切に設置して下さ い。

  3. Then add the following lines to your /usr/local/share/emacs/site-lisp/site-start.el file to make Emacs properly load PSGML when needed:

    EmacsPSGML を必要に応じて適切に読み込むことができるように、 /usr/local/share/emacs/site-lisp/site-start.el ファイルに以下の行を追加して下さい。

    (setq load-path
          (cons "/usr/local/share/emacs/site-lisp/psgml" load-path))
    (autoload 'sgml-mode "psgml" "Major mode to edit SGML files." t)

  4. If you want to use PSGML when editing HTML too, also add this:

    HTML を編集する時にも PSGML を使用したい場合は、次も追加して 下さい。

    (setq auto-mode-alist
          (cons '("\\.s?html?\\'" . sgml-mode) auto-mode-alist))

  5. There is one important thing to note with PSGML: its author assumed that your main SGML DTD directory would be /usr/local/lib/sgml. If, as in the examples in this chapter, you use /usr/local/share/sgml, you have to compensate for this.

    PSGML の使用にあたって注意すべき重要な点 が 1 つあります。その作者が、SGML DTD のメインディレクトリを /usr/local/lib/sgml にあるものと仮定していると いう点です。この章の例のように、 /usr/local/share/sgml を使っている場合はこれを 補わなければなりません。

    1. You can set the SGML_CATALOG_FILES environment variable.

      SGML_CATALOG_FILES 環境変数を設定できます。

    2. You can customize your PSGML installation (its manual tells you how).

      PSGML のインストールをカスタマイズできます。 (その方法はマニュアルにかいてあります。)

    3. You can even edit the source file psgml.el before compiling and installing PSGML, changing the hard-coded paths to match your own default.

      PSGML のコンパイル、インストールの前 に psgml.el ソースファイルを編集して、直接 記述されているパスを環境に合わせることさえも可能です。

JadeTeX のインストール

If you want to, you can also install JadeTeX to use TeX as a formatting backend for Jade. Note that this is still quite unpolished software, and will generate printed output that is inferior to what you get from the RTF backend. Still, it works all right, especially for simpler documents that don't use tables, and as both JadeTeX and the style sheets are under continuous improvement, it will certainly get better over time.

希望するならば、TeXJade の整形用のバックエンドとして使用する、 JadeTeX をインストールすることもできます。 これはまだあまり洗練されていないソフトウエアで、 RTF バックエンドよりも劣った印刷用出力を生成するこ とに気を付けて下さい。特に表を持たない単純な文書に関してきちんと動作 し、また、JadeTeX もそのスタイルシートも改 良が続いています。今後確実に良くなっていくでしょう。

To install and use JadeTeX, you will need a working installation of TeX and LaTeX2e, including the supported tools and graphics packages, Babel, AMS fonts and AMS-LaTeX, the PSNFSS extension and companion kit of "the 35 fonts", the dvips program for generating PostScript, the macro packages fancyhdr, hyperref, minitoc, url and ot2enc, and of course JadeTeX itself. All of these can be found on your friendly neighborhood CTAN site.

JadeTeX のインストールと利用のためには、 補助用の ツール画像 パッケージである、 BabelAMS フォントAMS-LaTeX、及び、 PSNFSS 拡張・必携キット である "the 35 fonts"、PostScript を生成す るためのプログラム dvips、及び、 fancyhdrhyperrefminitocurlot2enc マクロパッケージ、もちろん、 JadeTeX 自身も含め、 TeXLaTeX2e が動作するようにインストールされていなければなりません。これらは全て身 近の CTAN サイトにあります。

JadeTeX does not at the time of writing come with much of an installation guide, but there is a makefile which shows what is needed. It also includes a directory cooked, wherein you'll find some of the macro packages it needs, but not all, and not complete -- at least last we looked.

この原稿を作成している段階では、JadeTeX に は大したインストールガイドがありません。しかし、何が必要とされている のかを示す makefile があります。また cooked というディレクトリもあり、そこには必要な マクロパッケージがいくつかあります。すくなくとも私が見た時は全てが完 全に揃っていませんでした。

Before building the jadetex.fmt format file, you'll probably want to edit the jadetex.ltx file, to change the configuration of Babel to suit your locality. The line to change looks something like

\RequirePackage[german,french,english]{babel}[1997/01/23]
and you should obviously list only the languages you actually need, and have configured Babel for.

jadetex.fmt フォーマットファイルを構築する前に、 多分 jadetex.ltx ファイルを編集して、 Babel の設定を環境に合わせて変更した方が いいでしょう。

\RequirePackage[german,french,english]{babel}[1997/01/23]
のような行を変更して、実際に必要とする、 Babel の設定が済んだ言語だけを明示的に指 定しなければなりません。

With JadeTeX working, you should be able to generate and format TeX output for the PostgreSQL manuals by giving the commands (as above, in the doc/src/sgml directory)

JadeTeX を導入すると、次のコマンドを (上と同様に doc/src/sgml ディレクトリで)入 力することで、PostgreSQL のマニュアル を TeX 形式の出力として生成できます。

jade -t tex -d /usr/local/share/docbook/print/docbook.dsl -D ../graphics postgres.sgml
jadetex postgres.tex
jadetex postgres.tex
dvips postgres.dvi
Of course, when you do this, TeX will stop during the second run, and tell you that its capacity has been exceeded. This is, as far as we can tell, because of the way JadeTeX generates cross referencing information. TeX can, of course, be compiled with larger data structure sizes. The details of this will vary according to your installation. もちろん、このとき、TeX は 2 番目を処理し ている間に停止して、許容量を越えていることを知らせるかもしれません。 判っている限りでは、JadeTeX におけるクロス レファレンス情報の生成方法が原因です。もちろん、 TeX はもっと大きなデータ構造をコンパイルで きます。この詳細はインストール環境によって変わります。