source: pst/sgml/docbook-dsssl.xml@ 058dd48

<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY docbook-dsssl-download-http "http://prdownloads.sourceforge.net/docbook/docbook-dsssl-&docbook-dsssl-version;.tar.bz2">
  <!ENTITY docbook-dsssl-download-ftp  " ">
  <!ENTITY docbook-dsssl-md5sum        "bc192d23266b9a664ca0aba4a7794c7c">
  <!ENTITY docbook-dsssl-size          "277 KB">
  <!ENTITY docbook-dsssl-buildsize     "14 MB">
  <!ENTITY docbook-dsssl-time          "0.01 SBU">

  <!ENTITY docbook-dsssl-doc-download-http "http://prdownloads.sourceforge.net/docbook/docbook-dsssl-doc-&docbook-dsssl-version;.tar.bz2">
  <!ENTITY docbook-dsssl-doc-md5sum        "9a7b809a21ab7d2749bb328334c380f2">
  <!ENTITY docbook-dsssl-doc-size          "142 KB">
]>

<sect1 id="docbook-dsssl" 
xreflabel="DocBook DSSSL Stylesheets-&docbook-dsssl-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="docbook-dsssl.html"?>
<title>DocBook DSSSL Stylesheets-&docbook-dsssl-version;</title>
<indexterm zone="docbook-dsssl">
<primary sortas="a-DocBook-DSSSL-Stylesheets">DocBook DSSSL 
Stylesheets</primary></indexterm>

<sect2>
<title>Introduction to <application>DocBook <acronym>DSSSL</acronym> 
Stylesheets</application></title>

<para>The <application>DocBook <acronym>DSSSL</acronym> 
Stylesheets</application> package contains <acronym>DSSSL</acronym> 
stylesheets. These are used by <application>OpenJade</application> or other 
tools to transform <acronym>SGML</acronym> and <acronym>XML</acronym> DocBook 
files.</para>

<sect3><title>Package information</title>
<itemizedlist spacing='compact'>
<listitem><para>Download (HTTP): 
<ulink url="&docbook-dsssl-download-http;"/></para></listitem>
<listitem><para>Download (FTP): 
<ulink url="&docbook-dsssl-download-ftp;"/></para></listitem>
<listitem><para>Download MD5 sum: &docbook-dsssl-md5sum;</para></listitem>
<listitem><para>Download size: &docbook-dsssl-size;</para></listitem>
<listitem><para>Estimated disk space required: 
&docbook-dsssl-buildsize;</para></listitem>
<listitem><para>Estimated build time: 
&docbook-dsssl-time;</para></listitem></itemizedlist>
</sect3>

<sect3><title>Additional downloads</title>
<itemizedlist spacing='compact'>
<listitem><para>Documentation and test data: 
<ulink url="&docbook-dsssl-doc-download-http;"/></para></listitem>
<listitem><para>Download MD5 sum: &docbook-dsssl-doc-md5sum;</para></listitem>
<listitem><para>Download size: &docbook-dsssl-doc-size;</para></listitem>
</itemizedlist>
</sect3>

<sect3><title><application>DocBook <acronym>DSSSL</acronym> 
Stylesheets</application> dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="sgml-common"/></para>
</sect4>

<sect4><title>Required (to test the DocBook <acronym>SGML</acronym> 
toolchain)</title>
<para><xref linkend="sgml-dtd"/>, 
<xref linkend="opensp"/> and 
<xref linkend="openjade"/></para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>DocBook <acronym>DSSSL</acronym> 
Stylesheets</application></title>

<para>Ensure you unpack both the source and documentation tarballs before 
beginning the build.</para>

<para>Install <application>DocBook <acronym>DSSSL</acronym> 
Stylesheets</application> by running the following commands as the root 
user:</para>

<!-- 
<screen><userinput><command>mkdir -p /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/dtds/decls &amp;&amp;
mkdir -p /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/lib &amp;&amp;
mkdir -p /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/common &amp;&amp;
mkdir -p /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/html &amp;&amp;
mkdir -p /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/print &amp;&amp;
mkdir -p /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/test &amp;&amp;
mkdir -p /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/images &amp;&amp;
install bin/collateindex.pl /usr/bin &amp;&amp;
cp catalog VERSION /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version; &amp;&amp;
cp dtds/decls/*.dcl \
    /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/dtds/decls &amp;&amp;
cp lib/dblib.dsl /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/lib &amp;&amp;
cp common/*.dsl /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/common &amp;&amp;
cp common/*.ent /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/common &amp;&amp;
cp html/*.dsl /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/html &amp;&amp;
cp print/*.dsl /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/print &amp;&amp;
cp images/*.gif /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/images &amp;&amp;
 -->

<screen><userinput role='root'><command>install -v -m755 bin/collateindex.pl /usr/bin &amp;&amp;
install -v -m644 bin/collateindex.pl.1 /usr/share/man/man1 &amp;&amp;
install -v -d -m755 /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version; &amp;&amp;
cp -v -R * /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version; &amp;&amp;
install-catalog --add /etc/sgml/dsssl-docbook-stylesheets.cat \
    /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/catalog &amp;&amp;
install-catalog --add /etc/sgml/dsssl-docbook-stylesheets.cat \
    /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/common/catalog &amp;&amp;
install-catalog --add /etc/sgml/sgml-docbook.cat \
    /etc/sgml/dsssl-docbook-stylesheets.cat</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para>The above commands create a <command>make install</command> script
for this package.</para>

</sect2>

<sect2>
<title>Testing the DocBook <acronym>SGML</acronym> toolchain (optional)</title>

<para>The following commands will perform the necessary tests to confirm that 
your installed DocBook <acronym>SGML</acronym> toolchain will produce desired 
results. You must have the <xref linkend="sgml-dtd"/>, <xref linkend="opensp"/> 
and <xref linkend="openjade"/> packages installed and perform the tests as the 
root user.</para>

<para>All tests will be performed from the <filename 
class='directory'>/usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/doc/testdata</filename> 
directory:</para>

<screen><userinput role='root'><command>cd /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/doc/testdata</command></userinput></screen>

<para>The first test should produce no output to stdout (your screen) and 
create a file named <filename>jtest.rtf</filename> in the current 
directory:</para>

<screen><userinput role='root'><command>openjade -t rtf -d jtest.dsl jtest.sgm</command></userinput></screen>

<para>The next test should return only the following line to stdout: 
<computeroutput>onsgmls:I: "OpenSP" version "1.5.1"</computeroutput></para>

<screen><userinput role='root'><command>onsgmls -sv test.sgm</command></userinput></screen>

<para>The next test should produce no output to stdout and create a file named 
<filename>test.rtf</filename> in the current directory:</para>

<screen><userinput role='root'><command>openjade -t rtf \
    -d /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/print/docbook.dsl \
    test.sgm</command></userinput></screen>

<para>The last test should produce no output to stdout and create a file named 
<filename>c1.htm</filename> in the current directory:</para>

<screen><userinput role='root'><command>openjade -t sgml \
    -d /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/html/docbook.dsl \
    test.sgm</command></userinput></screen>

</sect2>

<!--
<sect2>
<title>Configuring <application>DocBook <acronym>DSSSL</acronym> 
Stylesheets</application></title>

<sect3><title>Configuration Information</title>

<para>The following configuration is necessary in order to utilize
<application>OpenJade</application> to convert the <acronym>BLFS</acronym> 
Book from <acronym>XML</acronym> to <acronym>HTML</acronym>:</para>

<screen><userinput><command>ln -sf <replaceable>[your home directory]</replaceable>/BLFS/BOOK/blfs.dsl \
    /usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;/html/</command></userinput></screen>
</sect3>

</sect2>
-->

<sect2>
<title>Contents</title>

<segmentedlist>
<segtitle>Installed Program</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Files</segtitle>
<segtitle>Installed Directory</segtitle>

<seglistitem>
<seg>collateindex.pl</seg>
<seg>None</seg>
<seg><acronym>DSSSL</acronym> stylesheets</seg>
<seg>/usr/share/sgml/docbook/dsssl-stylesheets-&docbook-dsssl-version;</seg>
</seglistitem>
</segmentedlist>

<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>

<varlistentry id="collateindex.pl">
<term><command>collateindex.pl</command></term>
<listitem><para>is a <application>Perl</application> script that creates a 
DocBook index from raw index data.</para>
<indexterm zone="docbook-dsssl collateindex.pl">
<primary sortas="b-collateindex.pl">collateindex.pl</primary>
</indexterm></listitem>
</varlistentry>
</variablelist>

</sect2>

</sect1>