<!-- $Header: /usr/prj/pg/cvsroot/doc/doc/src/sgml/docguide.sgml,v 1.11 2001/08/28 03:39:50 i-kaori Exp $ -->

<appendix label="DG2" id="docguide">
<!--  <title>Documentation</title> -->
 <title>ドキュメント</title>
<indexterm><primary>PostgreSQL</primary><secondary sortas="どきゅめんと">ドキュメント</secondary></indexterm>
 <para>
  <!-- <productname>PostgreSQL</productname> has four primary documentation
  formats: -->

  <productname>PostgreSQL</productname>は4つの主要なドキュメントフォーマットがあります。
</para>

  <itemizedlist>
   <listitem>
    <para>
     <!-- Plain text, for pre-installation information -->
     インストール前の情報として、プレーンテキスト
    </para>
   </listitem>
   <listitem>
    <para>
     <!-- <acronym>HTML</acronym>, for on-line browsing and reference -->
     Web上の参照用として、<acronym>HTML</acronym>
    </para>
   </listitem>
   <listitem>
    <para>
     <!-- Postscript, for printing -->
     印刷用として、PostScript
    </para>
   </listitem>
   <listitem>
    <para>
     <!-- man pages, for quick reference. -->
     すばやい検索用として、マニュアルページ
    </para>
   </listitem>
  </itemizedlist>

<para>
  <!-- Additionally, a number of plain-text README-type files can be found
  throughout the <productname>PostgreSQL</productname> source tree,
  documenting various implementation issues. -->

  加えて、<productname>PostgreSQL</productname>ソースツリー全体を通して、さまざまな実装の問題に関するプレーンテキストのREADMEファイルも存在しています。 

 </para>

 <para>
  <!-- The documentation is organized into several <quote>books</quote>
  with varyingly confusing names: -->

  ドキュメントは、さまざまの混乱する名前を持ついくつかの<quote>本</quote>に分かれています。  
</para>

  <itemizedlist>
   <listitem>
    <para>
     <!-- <citetitle>Tutorial</citetitle>:  introduction for new users -->
     <citetitle>&tutorial-guide;</citetitle>――初心者用の入門編
    </para>
   </listitem>
   <listitem>
    <para>
     <!-- <citetitle>User's Guide</citetitle>: documents the query language environment -->
     <citetitle>&user-guide;</citetitle>――問い合わせ言語の環境に関するドキュメント
    </para>
   </listitem>
   <listitem>
    <para>
     <!-- <citetitle>Administrator's Guide</citetitle>: installation and server maintenance -->
     <citetitle>&admin-guide;</citetitle>――インストールとサーバー保持
    </para>
   </listitem>
   <listitem>
    <para>
     <!-- <citetitle>Programmer's Guide</citetitle>: programming client
     applications and server extensions -->

     <citetitle>&programmer-guide;</citetitle>――クライアントアプリケーションとサーバー拡張のプログラミング

    </para>
   </listitem>
   <listitem>
    <para>
     <citetitle>&reference-guide;</citetitle>――SQLコマンドやPostgreSQLコマンドのリファレンス

    </para>
   </listitem>
   <listitem>
    <para>
     <!-- <citetitle>Developer's Guide</citetitle>: assorted information
     for developers of PostgreSQL proper -->

     <citetitle>&developer-guide;</citetitle>――PostgreSQL開発者のためのさまざまな情報    

    </para>
   </listitem>
  </itemizedlist>

<para>
  <!-- All five books are available as HTML and Postscript.  The
  <citetitle>User's Guide</citetitle> contains reference entries which
  are also shipped as man pages. -->

  これらの6つの本すべては、HTMLとPostScriptで見ることができます。<citetitle>&user-guide;</citetitle>はマニュアルページとして参照されるものも含んでいます。 

 </para>

 <para>
  <!-- <acronym>HTML</acronym> documentation and man pages are part of a
  standard distribution and are installed by default.  Postscript
  format documentation is available separately for download. -->

  <acronym>HTML</acronym>ドキュメントとマニュアルページは標準配布の一部であり、デフォルトでインストールされます。PostScriptフォーマットのドキュメントは別にダウンロードすることができます。 

 </para>

 <sect1>
  <title>DocBook</title><indexterm><primary>DocBook</primary></indexterm>
  <para>
   <!-- The documentation sources are written in
   <firstterm>DocBook</firstterm>, which is a markup language
   superficially similar to <acronym>HTML</acronym>.  Both of these
   languages are applications of the <firstterm>Standard Generalized
   Markup Language</firstterm>, <acronym>SGML</acronym>, which is
   essentially a language for describing other languages.  In what
   follows, the terms DocBook and SGML are both used, but technically
   they are not interchangeable. -->

   ドキュメントのソースは<firstterm>DocBook</firstterm>で書かれています。<firstterm>DocBook</firstterm>は、表面的には<acronym>HTML</acronym>に似たマークアップ言語です。どちらの言語も、本来他の言語を記述するための言語である<firstterm>Standard Generalized Markup Language</firstterm>（<acronym>SGML</acronym>）のアプリケーションです。ここからは、DocBooksとSGMLの両方が使われていますが、技術的にこれらは互換性はありません。

  </para>

  <para>
  <!-- <productname>DocBook</productname> allows an author to specify the
   structure and content of a technical document without worrying
   about presentation details.  A document style defines how that
   content is rendered into one of several final forms.  DocBook is
   maintained by the <ulink
   url="http://www.oasis-open.org">OASIS</ulink> group.  The <ulink
   url="http://www.oasis-open.org/docbook">official DocBook
   site</ulink> has good introductory and reference documentation and
   a complete O'Reilly book for your online reading pleasure.  The
   <ulink url="http://www.freebsd.org/docproj/docproj.html">FreeBSD
   Documentation Project</ulink> also uses DocBook and has some good
   information, including a number of style guidelines that might be
   worth considering. -->

   <firstterm>DocBook</firstterm>を書く人は、表示の細部について気にせずに技術的なドキュメントの構造や内容を指定することができます。ドキュメントのスタイルは、その中身がどのようにいくつかの最終形になるかを定義します。DocBookは<ulink url="http://www.oasis-open.org/">OASIS</ulink>グループ<![%book-publish;[（http://www.oasis-open.org/）]]>によって保持されています。<ulink url="http://www.oasis-open.org/docbook">公式DocBookサイト</ulink><![%book-publish;[（http://www.oasis-open.org/docbook/）]]>では、役に立つ入門、実践のドキュメントとO'Reilly社の本の完全版をWeb上で読むことができます。<ulink url="http://www.freebsd.org/docproj/docproj.html">FreeBSDドキュメントプロジェクト</ulink><![%book-publish;[（http://www.freebsd.org/docproj/docproj.html）]]>もやはりDocBookを使っていて、役に立ちそうなスタイルへの誘導が含まれています<footnote><para>訳注：これらのサイトは英語のサイトです</para></footnote>。

  </para>
 </sect1>


 <sect1 id="doc-toolsets">

  <!-- <title>Toolsets</title> -->
  <title>ツールセット</title>
<indexterm><primary>DocBook</primary><secondary sortas="つーるせっと">ツールセット</secondary></indexterm>
  <para>
   <!-- The following tools are used to process the documentation.  Some
   may be optional, as noted. -->

   ドキュメントを作るために下記のツールが使われています。中にはオプショナルのものもあり、そのように表記されています。 
</para>

   <variablelist>
    <varlistentry>
     <term><ulink url="http://www.oasis-open.org/docbook/sgml/">DocBook DTD</ulink><![%book-publish;[（http://www.oasis-open.org/docbook/sgml/）]]></term>
     <listitem>
      <para>
       <!--This is the definition of DocBook itself.  We currently use
       version 3.1; you cannot use later or earlier versions.  Note
       that there is also an <acronym>XML</acronym> version of DocBook
       - do not use that. -->

       これはDocBookそのものの定義です。現在ここでは3.1が使われていますので、その前もしくは後のバージョンは使わないでください。DocBookの<acronym>XML</acronym>バージョンもありますが、それも使わないでください。

      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <!-- <term><ulink url="http://www.oasis-open.org/cover/ISOEnts.zip">ISO 8879 character entities</ulink></term> -->
     <term><ulink url="http://www.oasis-open.org/cover/ISOEnts.zip">ISO 8879文字の実体</ulink><![%book-publish;[（http://www.oasis-open.org/cover/ISOEnts.zip）]]></term>
     <listitem>
      <para>
       <!-- These are required by DocBook but are distributed separately
       because they are maintained by ISO. -->
       これらはDocBookに必要とされますが、ISOで管理されているため、別に配布されています。
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><ulink url="http://openjade.sourceforge.net/">Jade</ulink><![%book-publish;[（http://openjade.sourceforge.net/）]]></term>
     <listitem>
      <para>
       <!-- This is the base package of <acronym>SGML</acronym> processing.
       It contains an <acronym>SGML</acronym> parser, a
       <acronym>DSSSL</acronym> processor (that is, a program to
       convert <acronym>SGML</acronym> to other formats using
       <acronym>DSSSL</acronym> stylesheets), as well as a number of
       related tools.  <productname>Jade</productname> is now being
       maintained by the OpenJade group, no longer by James Clark. -->

       これは<acronym>SGML</acronym>処理ツールの基本パッケージです。これは<acronym>SGML</acronym>構文解析、<acronym>DSSSL</acronym>プロセッサ（これは<acronym>DSSSL</acronym>スタイルシートを使って<acronym>SGML</acronym>を他のフォーマットに変換するプログラムです）、そしてその他の関連するツールを持っています。<productname>Jade</productname>は現在では、James ClarkではなくOpenJadeグループによって維持されています。

      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
<!--     <term><ulink url="http://nwalsh.com/docbook/dsssl/index.html">Norm Walsh's Modular DocBook Stylesheets</ulink></term> -->
     <term><ulink url="http://nwalsh.com/docbook/dsssl/index.html">Norm Walshのモジュール式DocBookスタイルシート</ulink><![%book-publish;[（http://nwalsh.com/docbook/dsssl/）]]></term>
     <listitem>
      <para>
       <!-- These contain the processing instructions for converting the
       DocBook sources to other formats, such as
       <acronym>HTML</acronym>. -->

       これらは、DocBookのソースをたとえば<acronym>HTML</acronym>のような他のフォーマットに変換するための指示について書かれています。

      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
<!--     <term><ulink url="http://docbook2x.sourceforge.net">DocBook2X tools</ulink></term> -->
     <term><ulink url="http://docbook2x.sourceforge.net/">DocBook2Xツール</ulink><![%book-publish;[（http://docbook2x.sourceforge.net/）]]></term>
     <listitem>
      <para>
       <!-- This optional package is used to create man pages.  It has a
       number of prerequisite packages of its own.  Check the web
       site. -->

       このオプションパッケージはマニュアルページを作るために使われます。あらかじめ必要ないくつかのパッケージがあるので、Webサイトで確認してください。

      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term>JadeTeX</term>
     <listitem>
      <para>
       <!-- If you want to, you can also install
       <productname>JadeTeX</productname> to use
       <productname>TeX</productname> as a formatting backend for
       <productname>Jade</productname>.  This will generate printed
       output that is inferior to what you get from the
       <acronym>RTF</acronym> backend.  Tables are a particular
       problem area.  Also, there is no opportunity to manually polish
       the results.  Still, it works all right, especially for simpler
       documents that don't use tables, and as both
       <productname>JadeTeX</productname> and the style sheets are
       under continuous improvement, it will certainly get better over
       time. -->

       <productname>Jade</productname>をフォーマットするバックエンドとして<productname>TeX</productname>を使うために、<productname>JadeTeX</productname>をインストールすることも可能です。これは<acronym>RTF</acronym>バックエンドから得られるものよりは劣る、プリントされたアウトプットを作りだします。テーブルは特に問題のある部分です。さらに、手動で結果を仕上げるための機会もありません。しかしこれは、特にテーブルを使わない簡単なドキュメントではちゃんと動きます。<productname>JadeTeX</productname>とスタイルシートは改良を続けており、時とともによりよくなることでしょう。

      </para>
     </listitem>
    </varlistentry>
   </variablelist>

  <para>
   <!-- We have documented experience with several installation methods for
   the various tools that are needed to process the documentation.
   These will be described below.  There may be some other packaged
   distributions for these tools. Please report package status to the
   docs mailing list and we will include that information here. -->

   ここではドキュメントを作るために必要なさまざまなツールのためのインストールの経験をまとめました。これらのツールを使うための、他のパッケージも配布されているかもしれません。もしあれば、ドキュメントのメーリングリストに連絡してください。ここに情報を加えたいと思います。 

  </para>

  <sect2>
   <!-- <title><productname>Linux</productname> <acronym>RPM</acronym> Installation</title> -->
   <title><productname>Linux</productname> <acronym>RPM</acronym>インストール</title>

   <para>
    <!-- Many vendors provide a complete RPM set for DocBook processing in
    their distribution, which is usually based on the <ulink
    url="http://sources.redhat.com/docbook-tools/">docbook-tools</ulink>
    effort at Red Hat Software.  Look for an <quote>SGML</quote>
    option while installing, or the following packages:
    <filename>sgml-common</filename>, <filename>docbook</filename>,
    <filename>stylesheets</filename>, <filename>openjade</filename>
    (or <filename>jade</filename>).  Possibly
    <filename>sgml-tools</filename> will be needed as well.  If your
    distributor does not provide these then you should be able to make
    use of the packages from some large, reasonably compatible vendor. -->

    多くのベンダーはDocBook作成用の完全なRPMセットを配布しています。それは大体Red Hat社の<ulink url="http://sources.redhat.com/docbook-tools/">docbook-tools</ulink><![%book-publish;[（http://sources.redhat.com/docbook-tools/）]]>に基づいています。インストールする際に、<quote>SGML</quote>もしくは<filename>sgml-common</filename>、<filename>docbook</filename>、<filename>stylesheets</filename>、<filename>openjade</filename>（または<filename>jade</filename>）などのパッケージを探してください。<filename>sgml-tools</filename>も必要とされる可能性があります。もし使用した配布元がこれらを用意していない場合は、他の大きなベンダーを利用できるはずです。

   </para>
  </sect2>

  <sect2>
<!--   <title>FreeBSD Installation</title> -->
   <title>FreeBSDへのインストール</title>

   <para>
    <!-- The FreeBSD Documentation Project is itself a heavy user of
    DocBook, so it comes as no surprise that there is a full set of
    <quote>ports</quote> of the documentation tools available on
    FreeBSD.  The following ports need to be installed to build the
    documentation on FreeBSD. -->

    FreeBSDのドキュメントプロジェクトそのものはDocBookを多用しているため、FreeBSDで使えるドキュメントツールの完全な<quote>ports</quote>があるのも不思議ではありません。FreeBSD上にドキュメントを作るためには、以下のportsをインストールする必要があります。
</para>

    <itemizedlist>
     <listitem>
      <para><filename>textproc/sp</filename></para>
     </listitem>
     <listitem>
      <para><filename>textproc/openjade</filename></para>
     </listitem>
     <listitem>
      <para><filename>textproc/docbook-310</filename></para>
     </listitem>
     <listitem>
      <para><filename>textproc/iso8879</filename></para>
     </listitem>
     <listitem>
      <para><filename>textproc/dsssl-docbook-modular</filename></para>
     </listitem>
    </itemizedlist>


<para>
    <!-- A number of things from <filename>/usr/ports/print</filename>
    (<filename>tex</filename>, <filename>jadetex</filename>) might
    also be of interest. -->

    <filename>/usr/ports/print</filename>（<filename>tex</filename>、<filename>jadetex</filename>）の中にも役に立つものがあるかもしれません。

   </para>

   <para>
    <!-- It's possible that the ports do not update the main catalog file
    in <filename>/usr/local/share/sgml/catalog</filename>.  Be sure to
    have the following line in there: -->
 
    portsは<filename>/usr/local/share/sgml/catalog</filename>のメインカタログファイルを更新しない可能性があります。下記の行を入れることを忘れないでください。
</para>

<programlisting>
CATALOG "/usr/local/share/sgml/docbook/3.1/catalog"
</programlisting>

<para>
    <!-- If you do not want to edit the file you can also set the
    environment variable <envar>SGML_CATALOG_FILES</envar> to a
    colon-separated list of catalog files (such as the one above). -->

    もしもファイルを編集したくない場合は、コロンで区切られたカタログファイルのリスト（上記のようなもの）に環境変数<envar>SGML_CATALOG_FILES</envar>を設定することもできます。

   </para>

   <para>
    <!-- More information about the FreeBSD documentation tools can be
    found in the <ulink
    url="http://www.freebsd.org/tutorials/docproj-primer/tools.html">FreeBSD
    Documentation Project's instructions</ulink>. -->

    FreeBSDのドキュメントツールに関するさらに詳しい情報は、<ulink url="http://www.freebsd.org/tutorials/docproj-primer/tools.html">FreeBSDドキュメントプロジェクト使用法</ulink><![%book-publish;[（http://www.freebsd.org/tutorials/docproj-primer/tools.html）]]>で見ることができます。

   </para>
  </sect2>

  <sect2>
<!--   <title>Debian Packages</title> -->
   <title>Debianパッケージ</title>

   <para>
    <!-- There is a full set of packages of the documentation tools
    available for <productname>Debian GNU/Linux</productname>.
    To install, simply use: -->

    <productname>Debian GNU/Linux</productname>に使うことのできるドキュメントツールにはフルセットのパッケージがあります。インストールするためには下記を使ってください。
</para>
 
<programlisting>
apt-get install jade
apt-get install docbook
apt-get install docbook-stylesheets
</programlisting>
  </sect2>

  <sect2>
<!--   <title>Manual Installation from Source</title> -->
   <title>ソースからのマニュアルインストール</title>

   <para>
    <!-- The manual installation process of the DocBook tools is somewhat
    complex, so if you have pre-built packages available, use them.
    We describe here only a standard setup, with reasonabley standard
    installation paths, and no <quote>fancy</quote> features.  For
    details, you should study the documentation of the respective
    package, and read <acronym>SGML</acronym> introductory material. -->

    DocBookツールのマニュアルインストールプロセスはなにかと複雑ですから、もしすでにできているパッケージがあるならばそれを使ったほうがよいでしょう。ここでは標準的なセットアップとほぼ標準的なインストールパスについてのみ説明します。詳しいことはそれぞれのパッケージのドキュメントを見て、<acronym>SGML</acronym>紹介の部分を読んでください。

   </para>

   <sect3>
<!--    <title>Installing Jade</title> -->
    <title>Jadeのインストール</title>
<indexterm><primary>Jade</primary></indexterm><indexterm><primary>DocBook</primary><secondary>Jade</secondary></indexterm>
    <para>
     <!-- The installation of OpenJade offers a GNU-style
     <literal>./configure; make; make install</literal> build process.
     Details can be found in the OpenJade source distribution. In a
     nutshell: -->

     OpenJadeのインストールは、GNU式の<literal>./configure; make; make install</literal>構築プロセスを提供します。詳細はOpenJadeのソース配布の中で見つけることができます。簡単に済ますならば以下のようにします。
</para>

<synopsis>
./configure --enable-default-catalog=/usr/local/share/sgml/catalog
make
make install
</synopsis>

<para>
     <!-- Be sure to remember where you put the <quote>default
     catalog</quote>; you will need it below.  You can also leave it
     off, but then you will have to set the environment variable
     <envar>SGML_CATALOG_FILES</envar> to point to the file whenever
     you use <application>jade</application> later on. -->

     <quote>デフォルトカタログ</quote>をどこに置いたかを覚えておくようにしてください。後で必要になります。放っておいても構いませんが、その場合はあとで<application>jade</application>を使うはいつでも環境変数<envar>SGML_CATALOG_FILES</envar>がそのファイルを指すように設定する必要があります。


    </para>

    <para>
     <!-- Additionally, you should install the files
     <filename>dsssl.dtd</filename>, <filename>fot.dtd</filename>,
     <filename>style-sheet.dtd</filename>, and
     <filename>catalog</filename> from the <filename>dsssl</filename>
     directory somewhere, perhaps into
     <filename>/usr/local/share/sgml/dsssl</filename>.  (Or just copy
     the entire directory.) -->

     さらに、<filename>dsssl</filename>のどこかのディレクトリからファイル<filename>dsssl.dtd</filename>、<filename>fot.dtd</filename>、<filename>style-sheet.dtd</filename>、<filename>catalog</filename>を<filename>/usr/local/share/sgml/dsssl</filename>にインストールしてください（もしくはディレクトリ全体をコピーしてください）。

    </para>
   </sect3>

   <sect3>
<!--    <title>Installing the <productname>DocBook</productname> <acronym>DTD</acronym> Kit</title> -->
    <title><productname>DocBook</productname> <acronym>DTD</acronym>キットのインストール</title><indexterm><primary>DocBook</primary><secondary>DocBook DTD</secondary></indexterm>

    <procedure>
     <step>
      <para>
       <!-- Obtain the <ulink
       url="http://www.oasis-open.org/docbook/sgml/3.1/docbk31.zip">DocBook
       V3.1</ulink> distribution.-->

       <ulink
       url="http://www.oasis-open.org/docbook/sgml/3.1/docbk31.zip">DocBook
       V3.1</ulink><![%book-publish;[（http://www.oasis-open.org/docbook/sgml/3.1/docbk31.zip）]]>を入手してください。

      </para>
     </step>

     <step>
      <para>
       <!-- Unpack the archive. -->
       アーカイブを解凍してください。
</para>

<screen>
<prompt>$ </prompt><userinput>unzip -a docbk31.zip</userinput>
</screen>
     </step>

     <step>
      <para>
       <!-- Place the files into the directory
       <filename>/usr/local/share/sgml/docbook31</filename>. (The
       exact location is irrelevant, but this one is fairly standard.) -->

       それらのファイルを<filename>/usr/local/share/sgml/docbook31</filename>ディレクトリに置いてください（正確にこの場所でなくても構いませんが、これは比較的標準的な場所です）。

      </para>
     </step>

     <step>
      <para>
       <!-- Create a file
       <filename>/usr/local/share/sgml/catalog</filename> (or whatever
       you told jade during installation) and put a line like this
       into it: -->

       ファイル<filename>/usr/local/share/sgml/catalog</filename>（もしくはインストール時にjadeに設定したもの）を作成し、下記のような行を加えてください。
</para>

<programlisting>
CATALOG "docbook31/docbook.cat"
</programlisting>

      <para>
       <!-- Optionally, you can edit the file
       <filename>docbook.cat</filename> and comment out or remove the
       line containing <literal>DTDDECL</literal>.  If you do not then
       you will get warnings from <application>jade</application>, but
       there is no further harm. -->

       オプションとして、ファイル<filename>docbook.cat</filename>を編集して、<literal>DTDDECL</literal>を含む行をコメントアウトか削除することもできます。もしそれをしなければ<application>jade</application>が警告を出しますが、それ以外に害はありません。

      </para>
     </step>

     <step>
      <para>
       <!-- Download the <ulink
       url="http://www.oasis-open.org/cover/ISOEnts.zip">ISO 8879
       character entities</ulink> archive, unpack it, and put the
       files in the same directory you put the DocBook files in. -->

       <ulink
       url="http://www.oasis-open.org/cover/ISOEnts.zip">ISO 8879 character entities</ulink>アーカイブ<![%book-publish;[（http://www.oasis-open.org/cover/ISOEnts.zip）]]>をダウンロードして解凍し、ファイルをDocBookファイルを置いたのと同じディレクトリに置いてください。

      </para>
     </step>
    </procedure>
   </sect3>

   <sect3>
    <!-- <title>Installing Norman Walsh's <acronym>DSSSL</acronym> Style Sheets</title> -->
    <title>Norman Walshの<acronym>DSSSL</acronym>スタイルシート</title><indexterm><primary>DocBook</primary><secondary>DSSSL</secondary></indexterm>

    <para>
     <!-- To install the style sheets, simply unzip the distribution kit in
     a suitable place, for example
     <filename>/usr/local/share/sgml/stylesheets</filename>.  (The
     archive will automatically create a <filename>docbook</filename>
     subdirectory.) -->

     スタイルシートをインストールするためには、配布されたキットを解凍し、たとえば<filename>/usr/local/share/sgml/stylesheets</filename>のような適宜の場所に置いてください（アーカイブが自動的に<filename>docbook</filename>のサブディレクトリを作成します）。

    </para>
   </sect3>

   <sect3>
<!--    <title>Installing <productname>JadeTeX</productname></title> -->
    <title><productname>JadeTeX</productname>のインストール</title><indexterm><primary>DocBook</primary><secondary>JadeTeX</secondary></indexterm>

    <para>
     <!-- To install and use <productname>JadeTeX</productname>, you will
     need a working installation of <productname>TeX</productname> and
     <productname>LaTeX2e</productname>, including the supported
     <productname>tools</productname> and
     <productname>graphics</productname> packages,
     <productname>Babel</productname>,
     <productname><acronym>AMS</acronym> fonts</productname> and
     <productname>AMS-LaTeX</productname>, the
     <productname><acronym>PSNFSS</acronym></productname> extension
     and companion kit of <quote>the 35 fonts</quote>, the
     <productname>dvips</productname> program for generating
     <productname>PostScript</productname>, the macro packages
     <productname>fancyhdr</productname>,
     <productname>hyperref</productname>,
     <productname>minitoc</productname>,
     <productname>url</productname> and
     <productname>ot2enc</productname>, and of course
     <productname>JadeTeX</productname> itself.  All of these can be
     found on your friendly neighborhood <ulink
     url="http://www.ctan.org"><acronym>CTAN</acronym></ulink> site. -->

     <productname>JadeTeX</productname>をインストールして使うためには、<productname>TeX</productname>と<productname>LaTeX2e</productname>がインストールされている必要があります。これに含まれるのは、サポートされている<productname>ツール</productname>と<productname>グラフィックス</productname>のパッケージ、<productname>Babel</productname>、<productname><acronym>AMS</acronym>フォント</productname>と<productname>AMS-LaTeX</productname>、<productname><acronym>PSNFSS</acronym></productname>の拡張 と<quote>the 35 fonts</quote>の付属キット<productname>PostScript</productname>を作成する<productname>dvips</productname>プログラム、<productname>fancyhdr</productname>、<productname>hyperref</productname>、<productname>minitoc</productname>、<productname>url</productname>、<productname>ot2enc</productname>、そしてもちろん<productname>JadeTeX</productname>自体です。これらはすべて
<ulink url="http://www.ctan.org"><acronym>CTAN</acronym></ulink>サイト<![%book-publish;[（http://www.ctan.org/）]]>で見つけることができます。
    </para>

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

     <productname>JadeTeX</productname>には、ダウンロードした際にはインストールガイドがついていませんが、必要な物を示す<filename>makefile</filename>が入っています。これにはディレクトリ<filename>cooked</filename>も含まれており、ここでは必要とされるマクロパッケージもいくつかありますがこれがすべてではなく完全でもありません（少なくとも私の知る限りでは）。

    </para>

    <para>
     <!-- Before building the <filename>jadetex.fmt</filename> format file,
     you'll probably want to edit the <filename>jadetex.ltx</filename>
     file, to change the configuration of
     <productname>Babel</productname> to suit your locality.  The line
     to change looks something like -->

     <filename>jadetex.fmt</filename>フォーマットのファイルを作る前に、<filename>jadetex.ltx</filename>ファイルを編集し<productname>Babel</productname>を自分の環境に合わせる必要があります。そのための行は以下のようになるはずです。
</para>

<programlisting>
&bsol;RequirePackage[german,french,english]{babel}[1997/01/23]
</programlisting>

<para>
     <!-- and you should obviously list only the languages you actually need,
     and have configured <productname>Babel</productname> for. -->

     明白ですが、自分が必要な言語だけをリストし<productname>Babel</productname>をconfigureしてください。

    </para>

    <para>
     <!-- It is quite likely that when you use
     <productname>JadeTeX</productname> with
     <productname>PostgreSQL</productname> documentation sources, that
     <productname>TeX</productname> 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
     <productname>JadeTeX</productname> generates cross referencing
     information.  <productname>TeX</productname> can, of course, be
     compiled with larger data structure sizes.  The details of this
     will vary according to your installation. -->

     <productname>PostgreSQL</productname>のドキュメントソースと一緒に<productname>JadeTeX</productname>を使う場合、二度目の起動で<productname>TeX</productname>が止まり容量を越えたと言われることがあります。これは<productname>JadeTeX</productname>が相互参照する情報を作る方法のせいです。<productname>TeX</productname>はもちろんもっと大きいデータ構造サイズの大きいものともコンパイルすることができます。その際の詳細はインストールによってことなります。

    </para>

   </sect3>

  </sect2>
 </sect1>


 <sect1 id="doc-build">
  <!-- <title>Building The Documentation</title> -->
  <title>ドキュメント作成</title>

  <para>
   <!-- Before you can build the documentation you need to run the
   <filename>configure</filename> script as you would when building
   the programs themselves.  Check the output near the end of the run,
   it should look something like this: -->

   ドキュメントを作成する前に、プログラム自身を作るときと同じように<filename>configure</filename>スクリプトを実行する必要があります。 実行が終わり近くなったときの出力は以下のようになるはずです。   
</para>
 
<screen>
<computeroutput>checking for onsgmls... onsgmls
checking for openjade... openjade
checking for DocBook V3.1... yes
checking for DocBook stylesheets... /usr/lib/sgml/stylesheets/nwalsh-modular
checking for sgmlspl... sgmlspl</computeroutput>
</screen>

<para>
   <!-- If neither <filename>onsgmls</filename> nor
   <filename>nsgmls</filename> were found then you will not see the
   remaining 4 lines.  <filename>nsgmls</filename> is part of the Jade
   package.  If <quote>DocBook V3.1</quote> was not found then you did
   not install the DocBook DTD kit in a place where jade can find it,
   or you have not set up the catalog files correctly.  See the
   installation hints above.  The DocBook stylesheets are looked for
   in a number of relatively standard places, but if you have them
   some other place then you should set the environment variable
   <envar>DOCBOOKSTYLE</envar> to the location and rerun
   <filename>configure</filename> afterwards. -->

   もし<filename>onsgmls</filename>も<filename>nsgmls</filename>も見つからない場合、残りの4行は表示されません。<filename>nsgmls</filename>はJadeパッケージの一部です。もし<quote>DocBook V3.1</quote>が見つからない場合は、DocBook DTDキットがjadeの見つけられる場所にインストールされていないか、カタログファイルが正しく設定されていません。上記のインストールヒントを見てください。DocBookスタイルシートは比較的標準的な場所で探されます。しかし、もし別の場所に置いた場合は環境変数<envar>DOCBOOKSTYLE</envar>に場所を設定してから<filename>configure</filename>を再実行してください。
   
  </para>

  <para>
   <!-- Once you have everything set up, change to the directory
   <filename>doc/src/sgml</filename> and run one of the following
   commands: (Remember to use GNU make.) -->

   すべての設定が終わったら、ディレクトリ<filename>doc/src/sgml</filename>に移動して下記のコマンドの1つを実行してください（GNU makeを使うのを忘れないでください）。
</para>

   <itemizedlist>
    <listitem>
     <para>
      <!-- To build the <acronym>HTML</acronym> version of the
      <citetitle>Administrator's Guide</citetitle>: -->

      <citetitle>&admin-guide;</citetitle>の<acronym>HTML</acronym>バージョンの作り方は以下のとおりです。
</para>

<screen>
<prompt>doc/src/sgml$ </prompt><userinput>gmake admin.html</userinput>
</screen>
    </listitem>

    <listitem>
     <para>
      <!-- For the RTF version of the same: -->
      同じもののRTFバージョンは以下のようにして作ります。
</para>

<screen>
<prompt>doc/src/sgml$ </prompt><userinput>gmake admin.rtf</userinput>
</screen>
    </listitem>

    <listitem>
     <para>
      <!-- To get a <acronym>DVI</acronym> version via
      <productname>JadeTeX</productname>: -->

      <productname>JadeTeX</productname>で<acronym>DVI</acronym>形式を作るには以下のようにします
</para>

<screen>
<prompt>doc/src/sgml$ </prompt><userinput>gmake admin.dvi</userinput>
</screen>
    </listitem>

    <listitem>
     <para>
      <!-- And Postscript from the <acronym>DVI</acronym>: -->
      そして<acronym>DVI</acronym>形式からPostscript形式を作ります。
</para>

<screen>
<prompt>doc/src/sgml$ </prompt><userinput>gmake admin.ps</userinput>
</screen>

     <note>
      <para>
       <!-- The official Postscript format documentation is generated
       differently.  See <xref linkend="doc-hardcopy"> below. -->

       公式なPostScriptフォーマットのドキュメントは違った方法で作られます。下の<xref linkend="doc-hardcopy">を見てください。

      </para>
     </note>
    </listitem>
   </itemizedlist>

<para>
   <!-- The other books can be built with analogous commands by replacing
   <literal>admin</literal> with one of <literal>developer</literal>,
   <literal>programmer</literal>, <literal>tutorial</literal>, or
   <literal>user</literal>.  Using <literal>postgres</literal> builds
   an integrated version of all 5 books, which is practical since the
   browser interface makes it easy to move around all of the
   documentation by just clicking. -->

   他の本も同じようなコマンドで作ることができます。<literal>admin</literal>を<literal>developer</literal>（開発者）、<literal>programmer</literal>（プログラマ）、<literal>tutorial</literal>（チュートリアル）、<literal>reference</literal>（リファレンス）、<literal>user</literal>（ユーザー）に変えてください。<literal>postgres</literal>を指定すると6冊すべての本が総合されたものが作られます。ブラウザインターフェイスだとドキュメント全体の移動をクリックするだけですむので、これは実用的です。

  </para>

  <sect2>
   <title>HTML</title>

   <para>
    <!-- When building <acronym>HTML</acronym> documentation in
    <filename>doc/src/sgml</filename>, some of the resulting files
    will possibly (or quite certainly) have conflicting names between
    books.  Therefore the files are not in that directory in the
    regular distribution.  Instead, the files belonging to each book
    are stored in a tar archive that is unpacked at installation time.
    To create a set of <acronym>HTML</acronym> documentation packages
    use the commands -->

    <filename>doc/src/sgml</filename>に<acronym>HTML</acronym>ドキュメントを作るときは、その結果できるファイルが本と一致しないことが多々あります。ですから、それらのファイルは標準の配布ではそのディレクトリには入っていません。代わりに、それぞれの本のファイルはインストール時には解凍されないtarパッケージに格納されています。<acronym>HTML</acronym>ドキュメントパッケージのセットを作るには以下のコマンドを使ってください。
</para>

<programlisting>
cd doc/src
gmake tutorial.tar.gz
gmake user.tar.gz
gmake admin.tar.gz
gmake programmer.tar.gz
gmake postgres.tar.gz
gmake install
</programlisting>

<para>
    <!-- In the distribution, these archives live in the
    <filename>doc</filename> directory and are installed by default
    with <command>gmake install</command>. -->

    配布された物の中には、<filename>doc</filename>ディレクトリにこれらのアーカイブがありデフォルトでは<command>gmake install</command>でインストールされます。

  </para>
 </sect2>

 <sect2 id="doc-manpages">
  <!--<title>Manpages</title> -->
  <title>マニュアルページ</title>
  <para>
   <!-- We use the <application>docbook2man</application> utility to
   convert <productname>DocBook</productname>
   <sgmltag>REFENTRY</sgmltag> pages to *roff output suitable for man
   pages.  The man pages are also distributed as a tar archive,
   similar to the <acronym>HTML</acronym> version.  To create the man page package, use the commands -->

   <productname>DocBook</productname><sgmltag>REFENTRY</sgmltag>ページをマニュアルページに合った*roff出力に変換するためには、<application>docbook2man</application>を利用します。マニュアルページは<acronym>HTML</acronym>バージョンと似ているtarアーカイブとしても配布されています。マニュアルページのパッケージを作る場合は下記のコマンドを使ってください。 
</para>

<programlisting>
cd doc/src
gmake man
</programlisting>

<para>
   <!-- which will result in a tar file being generated in the
   <filename>doc/src</filename> directory. -->

   これによって<filename>doc/src</filename>ディレクトリにtarファイルが作られます。
    

  </para>

  <para>
   <!-- The man build leaves a lot of confusing output, and special care
   must be taken to produce quality results.  There is still room for
   improvement in this area. -->

   作られたマニュアルはたくさんの紛らわしい出力を残すため、質の高い結果を残すためには特別な処置をとらなければいけません。この部分にはまだ改善の余地があります。

  </para>
 </sect2>

 <sect2 id="doc-hardcopy">
  <!-- <title>Hardcopy Generation</title> -->
  <title>ハードコピー作成</title>

  <para>
   <!-- The hardcopy Postscript documentation is generated by converting the
   <acronym>SGML</acronym> source code to <acronym>RTF</acronym>, then
   importing into <productname>ApplixWare-4.4.1</productname>. 
   After a little cleanup (see the following
   section) the output is "printed" to a postscript file. -->

   PostScriptのハードコピードキュメントは、<acronym>SGML</acronym>ソースコードを<acronym>RTF</acronym>に変換し、<productname>ApplixWare-4.4.1</productname>にインポートして作られます。簡単な掃除のあと（次のセクションを参照）結果がPostScriptファイルに出力されます。
  </para>

<!--
  <para>
   Some figures were redrawn to avoid having bitmap
   <acronym>GIF</acronym> files in the hardcopy documentation. One
   figure, of the system catalogs, was sufficiently complex that there
   was  not time to redraw it. It was converted to fit using the
   following commands:

<programlisting>
% convert -monochrome -v -geometry 500x500'>' catalogs.ps catalogs.gif
% convert -v -crop 400x500 catalogs.gif catalogs-cropped.gif
</programlisting>

  </para>
-->

   <para>
    <!-- Several areas are addressed while generating Postscript
    hardcopy, including RTF repair, ToC generation, and page break
    adjustments. -->

    PostScriptハードコピーを作成する間、RTFリペア、ToC作成、ページ区切れ目調整などを含む部分が処理されます。

   </para>

   <procedure>
    <!-- <title>Applixware <acronym>RTF</acronym> Cleanup</title> -->
    <title>Applixware <acronym>RTF</acronym>の掃除</title>

    <para>
     <!-- <application>jade</application>, an integral part of the
     hardcopy procedure, omits specifying a default style for body
     text. In the past, this undiagnosed problem led to a long process
     of Table of Contents (ToC) generation. However, with great help
     from the ApplixWare folks the symptom was diagnosed and a
     workaround is available. -->

     ハードコピープロシージャの総合的な部分であるjadeはボディテキストのデフォルトスタイルの指定を省略します。過去には、この未処理の問題が長い目次（ToC）作成へと導きました。しかし、ApplixWareの方々のすばらしい協力により症状は改善され使うことができるようになりました。

    </para>

    <step performance="required">
     <para>
      <!-- Generate the <acronym>RTF</acronym> input by typing (for example): -->
      下記のようなコマンドで<acronym>RTF</acronym>入力を作成してください（これは一例です）。
</para>

<programlisting>
% cd doc/src/sgml
% make tutorial.rtf
</programlisting>
    </step>


    <step performance="required">
     <para>
      <!-- Repair the RTF file to correctly specify all
      styles, in particular the default style. The field can be added
      using <application>vi</application> or the following small
      <application>sed</application> procedure: -->

      RTFファイルが正しくすべてのスタイル、特にデフォルトスタイルを指定するように修正してください。フィールドは<application>vi</application>もしくは後述する小さな<application>sed</application>プロシージャを使って追加することができます。
</para>

<programlisting>
#!/bin/sh
# fixrtf.sh
# Utility to repair slight damage in RTF files generated by jade
# Thomas Lockhart &lt;lockhart@alumni.caltech.edu&gt;
#
for i in $* ; do
  mv $i $i.orig
  cat $i.orig | sed 's#&bsol;&bsol;stylesheet#&bsol;&bsol;stylesheet{&bsol;&bsol;s0 Normal;}#' > $i
done

exit
</programlisting>

<para>
      <!-- where the script is adding <literal>{&bsol;s0 Normal;}</literal> as
      the zero-th style in the document. According to ApplixWare, the
      RTF standard would prohibit adding an implicit zero-th style,
      though M$Word happens to handle this case. -->

      スクリプトがドキュメントの中で<literal>{&bsol;s0 Normal;}</literal>をzero-thスタイルとして追加している部分で使ってください。ApplixWareによるとRTF標準は暗黙のzero-thスタイルを追加することを禁じるそうですが、今回の場合はマイクロソフトが扱っています。

     </para>
    </step>

    <step performance="required">
     <para>
      <!-- Open a new document in <productname>Applix Words</productname> and
      then import the <acronym>RTF</acronym> file. -->

      <productname>Applix Words</productname>で新しいドキュメントを開き、<acronym>RTF</acronym>ファイルをインポートしてください。

     </para>
    </step>

    <step performance="required">
     <para>
      <!-- Generate a new ToC using ApplixWare. -->
      ApplixWareを使って新しいToCを作ってください。
     </para>

     <substeps>
      <step>
       <para>
	<!-- Select the existing ToC lines, from the beginning of the first
	character on the first line to the last character of the last
	line. -->

        すでにあるToCを、1行目の1文字目から最終行の最終文字まで選択してください。

       </para>
      </step>

      <step>
       <para>
	<!-- Build a new ToC using
	<literal>Tools.BookBuilding.CreateToC</literal>. Select the
	first three levels of headers for inclusion in the ToC. 
	This will
	replace the existing lines imported in the RTF with a native
	ApplixWare ToC. -->

        <literal>Tools.BookBuilding.CreateToC</literal>を使って新しいToCを作ってください。最初の3レベルをToCに含むために選択してください。これがすでにRTFからインポートされた行をApplixWareのToCと入れ換わります。


       </para>
      </step>

      <step>
       <para>
	<!-- Adjust the ToC formatting by using
	<literal>Format.Style</literal>, selecting each of the three
	ToC styles, and adjusting the indents for <literal>First</literal> and
	<literal>Left</literal>. Use the following values: -->

        <literal>Format.Style</literal>を使ってToCのフォーマットを調整してください。まず3つのToCスタイルをそれぞれ選択し、インデントを<literal>First</literal>と<literal>Left</literal>に調整します。下記の値を使ってください。
</para>

	<table>
	<!-- <title>Indent Formatting for Table of Contents</title> -->
	<title>テーブルの目次のためのインデントフォーマット</title>
	 <tgroup cols="3">
	  <thead>
	   <row>
	    <!-- <entry>Style 
	    </entry> -->

            <entry>スタイル 
	    </entry>

	    <!-- <entry>First Indent (inches)
	    </entry> -->

            <entry>第1インデント（インチ）
	    </entry>

	    <!-- <entry>Left Indent (inches)
	    </entry> -->

            <entry>左インデント（インチ）
	    </entry>

	   </row>
	  </thead>

	  <tbody>
	   <row>
	    <entry><literal>TOC-Heading 1</literal>
	    </entry>
	    <entry><literal>0.6</literal>
	    </entry>
	    <entry><literal>0.6</literal>
	    </entry>
	   </row>

	   <row>
	    <entry><literal>TOC-Heading 2</literal>
	    </entry>
	    <entry><literal>1.0</literal>
	    </entry>
	    <entry><literal>1.0</literal>
	    </entry>
	   </row>

	   <row>
	    <entry><literal>TOC-Heading 3</literal>
	    </entry>
	    <entry><literal>1.4</literal>
	    </entry>
	    <entry><literal>1.4</literal>
	    </entry>
	   </row>
	  </tbody>
	 </tgroup>
	</table>
      </step>
     </substeps>
    </step>

    <step performance="required">
     <para>
      <!-- Work through the document to: -->
      下記のようにドキュメントに従って作業してください。
</para>

      <itemizedlist>
       <listitem>
	<!-- <para>
	 Adjust page breaks.
	</para> -->

        <para>
	ページの切れ目を調整する。
	</para>

       </listitem>

       <listitem>
	<!-- <para>
	 Adjust table column widths.
	</para> -->

	<para>
	テーブルのカラムの幅を調整する。
	</para>

       </listitem>

       <listitem>
	<para>
	 <!-- Insert figures into the document. Center each figure on the page using
	 the centering margins button on the ApplixWare toolbar. -->

         ドキュメントに図を挿入してください。ApplixWareツールバーのセンタリングマージンボタンを使ってそれぞれの図をセンタリングしてください。
</para>

	 <note>
	  <para>
	   <!-- Not all documents have figures.
	   You can grep the <acronym>SGML</acronym> source files for
	   the string "<literal>graphic</literal>" to identify those parts of the
	   documentation that may have figures. A few figures are replicated in
	   various parts of the documentation. -->

           すべてのドキュメントに図があるわけではありません。<acronym>SGML</acronym>のソースファイルを「<literal>graphic</literal>」という文字列でgrepして、ドキュメントのどの部分に図があるかを確認してください。いくつかの図はドキュメントの違った部分でくり返し使われています。 

	  </para>
	 </note>
       </listitem>
      </itemizedlist>
    </step>

    <step performance="required">
     <para>
      <!-- Replace the right-justified page numbers in the Examples and
      Figures portions of the ToC with
      correct values. This only takes a few minutes per document. -->

      ToCのExamplesとFiguresの部分の右付されたページ数を正しい値に直してください。1つのドキュメントにつき数分ほどしかかかりません。

     </para>
    </step>

    <step performance="required">
     <para>
      <!-- If a bibliography is present, remove the <firstterm>short
       form</firstterm> reference title from each entry. The
      <productname>DocBook</productname> stylesheets from Norm Walsh
      seem to print these out, even though this is a subset of the
      information immediately following. -->

      もし参考文献リストがある場合、<firstterm>短いフォーム</firstterm>の参照タイトルは削除してください。<productname>DocBook</productname>Norm Walshのスタイルシートはこれらをプリントアウトしますが、これは次に述べる情報のサブセットです。

     </para>
    </step>

    <step performance="required">
     <para>
      <!-- Save the document as native Applix Words format to allow easier last
      minute editing later. -->

      最終編集なども簡単にできるように、Applix Wordsフォーマットでドキュメントを保存してください。

     </para>
    </step>

    <step performance="required">
     <para>
      <!-- "Print" the document
      to a file in Postscript format. -->

      PostScriptフォーマットのファイルにドキュメントを書き出してください。

     </para>
    </step>

    <step performance="required">
     <para>
      <!-- Compress the Postscript file using <application>gzip</application>.
      Place the compressed file into the <filename>doc</filename> directory. -->

      <application>gzip</application>を使ってPostScriptファイルを圧縮してください。圧縮されたファイルは<filename>doc</filename>ディレクトリに置いてください。

     </para>
    </step>
   </procedure>
  </sect2>

  <sect2>
   <!-- <title>Plain Text Files</title> -->
   <title>プレーンテキストファイル</title>

   <para>
    <!-- Several files are distributed as plain text, for reading during
    the installation process. The <filename>INSTALL</filename> file
    corresponds to the chapter in the <citetitle>Administrator's
    Guide</citetitle>, with some minor changes to account for the
    different context.  To recreate the file, change to the directory
    <filename>doc/src/sgml</filename> and enter <userinput>gmake
    INSTALL</userinput>.  This will create a file
    <filename>INSTALL.html</filename> that can be saved as text with
    <productname>Netscape Navigator</productname> and put into the
    place of the existing file.  <productname>Netscape</productname>
    seems to offer the best quality for <acronym>HTML</acronym> to
    text conversions (over <application>lynx</application> and
    <application>w3m</application>). -->

    いくつかのファイルはプレーンテキストとしてインストールプロセス時に読むために配布されています。<filename>INSTALL</filename>ファイルが<citetitle>&admin-guide;</citetitle>の中の章と対応しています（違った内容を説明するためにいくつか小さな変更が加えられています）。このファイルを作るためにはディレクトリ<filename>doc/src/sgml</filename>に移動し、<userinput>gmake INSTALL</userinput>と入力してください。これで<filename>INSTALL.html</filename>というファイルが作られ、<productname>Netscape Navigator</productname>でテキストとして保存しすでにあるファイルの中に出力することが可能になります。<productname>Netscape Navigator</productname>は<acronym>HTML</acronym>とテキストの変換では一番質の高いものを提供しているようです（<application>lynx</application>や<application>w3m</application>と比べて）。

   </para>

   <para>
    <!-- The file <filename>HISTORY</filename> can be created similarly,
    using the command <userinput>gmake HISTORY</userinput>.  The table
    of contents should be removed manually from the resulting text
    file. -->

    ファイル<filename>HISTORY</filename>も、コマンド<userinput>gmake HISTORY</userinput>を使って同じように作ることができます。その結果できたファイルから、目次は手動で削除してください。

   </para>

   <para>
    <!-- Since it does not change very often, the generation of the file
    <filename>src/test/regress/README</filename> is not fully
    automated.  After building the <acronym>HTML</acronym> version of
    the <citetitle>Administrator's Guide</citetitle>, convert the
    resulting files <filename>regress.html</filename> and
    <filename>regress-platform.html</filename> to text, using
    <productname>Netscape</productname>.  Then paste the text files
    together and edit them to taste (e.g., remove the navigation
    bars, remove the references to other chapters). -->

    それほど頻繁に変更されないため、ファイル<filename>src/test/regress/README</filename>の作成は完全には自動化されていません。<acronym>HTML</acronym>バージョンの<citetitle>&admin-guide;</citetitle>を作ったら、その結果できたファイル<filename>regress.html</filename>と<filename>regress-platform.html</filename>を<productname>Netscape Navigator</productname>を使ってテキストに変換してください。そしてそのテキストファイルを一緒に貼り付け好きなように編集してください（たとえばナビゲーションバーの削除、参照を別のチャプターに移動させるなど）。

   </para>

<!--
  * This is how you can create text files via RTF and ApplixWare,
  * for historical reference.

   <procedure>
    <title>Plain Text Generation</title>

    <para>
     Both <filename>INSTALL</filename> and
     <filename>HISTORY</filename> are generated from existing
     <acronym>SGML</acronym> sources. They are extracted from the same 
     intermediate <acronym>RTF</acronym> file.
    </para>

    <step performance="required">
     <para>
      Generate <acronym>RTF</acronym> by typing:
<programlisting>
% cd doc/src/sgml
% make installation.rtf
</programlisting>
     </para>
    </step>
      
    <step performance="required">
     <para>
      Import <filename>installation.rtf</filename> into
      <productname>Applix Words</productname>.
     </para>
    </step>

    <step performance="required">
     <para>
      Set the page width and margins.
     </para>

     <substeps>
      <step performance="required">
       <para>
	Adjust the page width in File.PageSetup to 10 inches.
       </para>
      </step>

      <step performance="required">
       <para>
	Select all text.
	Adjust the right margin using the ruler to 9.5 inches. This
	will give a maximum column width of 79 characters, within the
	80 columns upper limit goal.
       </para>
      </step>
     </substeps>
    </step>

    <step performance="required">
     <para>
      Lop off the parts of the document that are not needed.
     </para>

     <para>
      For <filename>INSTALL</filename>, remove all release notes from
      the end of the text, except for those from the current release.
      For <filename>HISTORY</filename>, remove all text up to the
      release notes, preserving and modifying the title and ToC.
     </para>
    </step>

    <step performance="required">
     <para>
      Export the result as "ASCII Layout".
     </para>
    </step>

    <step performance="required">
     <para>
      Using emacs or vi, clean up the tabular information in
      <filename>INSTALL</filename>. Remove the "mailto"
      <acronym>URLs</acronym> for the porting contributors to shrink
      the column heights.
     </para>
    </step>
   </procedure>
-->

  </sect2>
 </sect1>


 <sect1 id="doc-sources">
  <title><!--Documentation Authoring-->ドキュメントの作成</title>

   <para>
    <!-- <acronym>SGML</acronym> and <productname>DocBook</productname> do
    not suffer from an oversupply of open-source authoring tools. The
    most common toolset is the
    <productname>Emacs</productname>/<productname>XEmacs</productname>
    editor with appropriate editing mode.  On some systems
    (e.g., RedHat Linux) these tools are provided in a typical full
    installation. -->

     <acronym>SGML</acronym>と<productname>DocBook</productname>はオープンソース公認用のツールの波に苦しむ事はありません。最も一般的なツールセットはふさわしいエディットモードのついた<productname>Emacs</productname>/<productname>XEmacs</productname>エディタです。いくつかのシステムでは（たとえばRed Hat Linux）これらのツールはフルインストールで提供されています。
   </para>

   <sect2>
    <title>Emacs/PSGML</title><indexterm><primary>DocBook</primary><secondary>Emacs/PSGML</secondary></indexterm>

    <para>
     <!-- <productname>PSGML</productname> is the most common and most
     powerful mode for editing <acronym>SGML</acronym> documents.
     When properly configured, it will allow you to use
     <application>Emacs</application> to insert tags and check markup
     consistancy.  You could use it for <acronym>HTML</acronym> as
     well.  Check the <ulink
     url="http://www.lysator.liu.se/projects/about_psgml.html">PSGML
     web site</ulink> for downloads, installation instructions, and
     detailed documentation. -->

     <acronym>SGML</acronym>を編集するうえで<productname>PSGML</productname>は最も一般的で強力なモードです。正しくconfigureされると、<application>Emacs</application>でタグを挿入できるようになりマークアップ整合性をチェックしてくれます。これは<acronym>HTML</acronym>にも使うことができます。ダウンロード、インストール手順、詳しいドキュメントなどについては<ulink url="http://www.lysator.liu.se/projects/about_psgml.html">PSGML web site</ulink><![%book-publish;[（http://www.lysator.liu.se/projects/about_psgml.html）]]>を見てください。

    </para>

    <para>
     <!-- There is one important thing to note with
     <productname>PSGML</productname>: its author assumed that your
     main <acronym>SGML</acronym> <acronym>DTD</acronym> directory
     would be <filename>/usr/local/lib/sgml</filename>.  If, as in the
     examples in this chapter, you use
     <filename>/usr/local/share/sgml</filename>, you have to
     compensate for this, either by setting
     <envar>SGML_CATALOG_FILES</envar> environment variable, or you
     can customize your <productname>PSGML</productname> installation
     (its manual tells you how). -->

     <productname>PSGML</productname>に関して1つ重要なことがあります。書いた人はメイン<acronym>SGML</acronym><acronym>DTD</acronym>ディレクトリが必ず<filename>/usr/local/lib/sgml</filename>であると仮定していました。もしこの章で使われている例のように<filename>/usr/local/share/sgml</filename>を使った場合、環境変数<envar>SGML_CATALOG_FILES</envar>を設定するか、<productname>PSGML</productname>インストールをカスタマイズ（マニュアルに方法が書いてあります）しなくてはいけません。
    </para>

    <para>
     <!-- Put the following in your <filename>~/.emacs</filename>
     environment file (adjusting the path names to be appropriate for
     your system): -->

     下記を自分の<filename>~/.emacs</filename>環境ファイルに書き込んでください（パスは自分のシステムに合わせて調整してください）。
</para>

<programlisting>
; ********** 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 )
</programlisting>

<para>
     <!-- and in the same file add an entry for <acronym>SGML</acronym>
     into the (existing) definition for
     <varname>auto-mode-alist</varname>: -->

     そして同じファイルの<varname>auto-mode-alist</varname>の定義（すでにある）に、以下のようにして<acronym>SGML</acronym>の項目を加えます。
</para>

<programlisting>
(setq
  auto-mode-alist
  '(("&bsol;&bsol;.sgml$" . sgml-mode)
   ))
</programlisting>

    <para>
     <!-- Currently, each <acronym>SGML</acronym> source file has the
     following block at the end of the file: -->

     現在では、それぞれの<acronym>SGML</acronym>ソースファイルの終わりに下記のブロックが書かれています。
</para>

<programlisting>
&lt;!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"./reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:("/usr/lib/sgml/catalog")
sgml-local-ecat-files:nil
End:
--&gt;
</programlisting>

<para>
     <!-- This will set up a number of editing mode parameters even if you
     do not set up your <filename>~/.emacs</filename> file, but it is
     a bit unfortunate, since if you followed the installation
     instructions above, then the catalog path will not match your
     location.  Hence you might need to turn off local variables: -->

     これは<filename>~/.emacs</filename>ファイルを設定しなくてもいくつかの編集モードパラメータを設定するものです。しかしちょっと残念なことに、もし上記のインストール手順に従った場合カタログパスがあなたの設定と合わなくなってしまいます。そこでローカル変数をoffにする必要があります。
</para>

<programlisting>
(setq inhibit-local-variables t)
</programlisting>

    <para>
     <!-- The <productname>PostgreSQL</productname> distribution includes a
     parsed DTD definitions file <filename>reference.ced</filename>.
     You may find that when using PSGML, a comfortable way of working
     with these separate files of book parts is to insert a proper
     <literal>DOCTYPE</literal> declaration while you're editing them.
     If you are working on this source, for instance, it is an
     appendix chapter, so you would specify the document as an
     <quote>appendix</quote> instance of a DocBook document by making
     the first line look like this: -->

     <productname>PostgreSQL</productname>配布物の中には構文解析されたDTD定義ファイル<filename>reference.ced</filename>も含まれています。PSGMLを使う際に、それぞれの本の別々のファイルを作業しやすく使うためには、編集中に的確な<literal>DOCTYPE</literal>宣言をすることでしょう。たとえばこのようなソースを扱っている場合、これは付録の章ですから、1行目を下記のように書くことによってドキュメントをDocBookドキュメントの<quote>付録</quote>インスタンスとして指定します。 
</para>

<programlisting>
&lt;!doctype appendix PUBLIC "-//OASIS//DTD DocBook V3.1//EN"&gt;
</programlisting>

<para>
     <!-- This means that anything and everything that reads
     <acronym>SGML</acronym> will get it right, and I can verify the
     document with <command>nsgmls -s docguide.sgml</command>.  (But
     you need to take out that line before building the entire
     documentation set.) -->

     これは<acronym>SGML</acronym>を読むすべての物が正しく処理を行うようにするという意味で、<command>nsgmls -s docguide.sgml</command>コマンドでドキュメントを実証することができます（ただしすべてのドキュメントセットを作り始める前にはこの行は消さなくてはいけません）。

    </para>
   </sect2>

   <sect2>
<!--   <title>Other Emacs modes</title> -->
    <title>他のEmacsモード</title>

    <para>
     <!-- <productname>GNU Emacs</productname> ships with a different SGML
     mode, which is not quite as powerful as
     <productname>PSGML</productname>, but it's less confusing and
     lighter weight.  Also, it offers syntax highlighting (font lock),
     which can be very helpful. -->

     <productname>GNU Emacs</productname>は違ったSGMLモードで配布されます。これは<productname>PSGML</productname>ほど力強くありませんが、それほど紛らわしくなく動作も軽いです。さらに、構文ハイライト（フォントロック）も提供されており、とても役立ちます。

    </para>

    <para>
     <!-- Norm Walsh offers a major <ulink
     url="http://nwalsh.com/emacs/docbookide/index.html">mode
     specifically for DocBook</ulink> which also has font-lock and a
     number of features to reduce typing. -->

     Norm Walshはメジャーな<ulink url="http://nwalsh.com/emacs/docbookide/index.html">DocBook専用のモード</ulink><![%book-publish;[（http://nwalsh.com/emacs/docbookide/）]]>を提供しており、これもフォントロックやキー入力を減らすさまざまな機能を持っています。

    </para>
   </sect2>

 </sect1>

</appendix>

<!-- Keep this comment at the end of the file
Local variables:
mode:sgml
sgml-omittag:nil
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"./reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:("/usr/lib/sgml/catalog")
sgml-local-ecat-files:nil
End:
-->
