source: pst/xml/docbook-xsl.xml@ d352a28

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY docbook-xsl-download-http "http://prdownloads.sourceforge.net/docbook/docbook-xsl-&docbook-xsl-version;.tar.bz2">
  <!ENTITY docbook-xsl-download-ftp  " ">
  <!ENTITY docbook-xsl-md5sum        "6ebd29a67f2dcc3f2220f475ee6f6552">
  <!ENTITY docbook-xsl-size          "1.0 MB">
  <!ENTITY docbook-xsl-buildsize     "35.9 MB (includes installing optional documentation)">
  <!ENTITY docbook-xsl-time          "less than 0.1 SBU">

  <!ENTITY docbook-xsl-doc-download  "http://prdownloads.sourceforge.net/docbook/docbook-xsl-doc-&docbook-xsl-version;.tar.bz2">
]>

<sect1 id="docbook-xsl"
xreflabel="DocBook XSL Stylesheets-&docbook-xsl-version;">
  <?dbhtml filename="docbook-xsl.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">docbook-xsl-&docbook-xsl-version;.tar</keyword>
      <keyword role="ftptdir">docbook-xsl</keyword>
    </keywordset>
  </sect1info>

  <title>DocBook XSL Stylesheets-&docbook-xsl-version;</title>

  <indexterm zone="docbook-xsl">
    <primary sortas="a-DocBook-XSL-Stylesheets">DocBook XSL
    Stylesheets</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to DocBook XSL Stylesheets</title>

    <para>The <application>DocBook XSL Stylesheets</application>
    package contains XSL stylesheets. These are useful for
    performing transformations on XML DocBook files.</para>

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Optional documentation: <ulink
        url="&docbook-xsl-doc-download;"/></para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">DocBook XSL Stylesheets Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="libxml2"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of DocBook XSL Stylesheets</title>

    <para>If you downloaded the optional documentation tarball, unpack it
    when you unpack the source tarball. The documentation tarball unpacks into
    subdirectories of the source tree.</para>

    <para>Install <application>DocBook XSL Stylesheets</application>
    by running the following commands as the
    <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>install -v -m755 -d /usr/share/xml/docbook/xsl-stylesheets-&docbook-xsl-version; &amp;&amp;
cp -v -R VERSION common eclipse extensions fo html \
         htmlhelp images javahelp lib manpages params \
         profiling slides template website xhtml \
    /usr/share/xml/docbook/xsl-stylesheets-&docbook-xsl-version;</userinput></screen>

    <para>If you downloaded the optional documentation tarball, install the
    documentation by issuing the following commands as the
    <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/docbook-xsl-&docbook-xsl-version; &amp;&amp;
cp -v -R doc/* /usr/share/doc/docbook-xsl-&docbook-xsl-version;</userinput></screen>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring DocBook XSL Stylesheets</title>

    <sect3 id="docbook-xsl-config">
      <title>Config Files</title>

      <para><filename>/etc/xml/catalog</filename></para>

      <indexterm zone="docbook-xsl docbook-xsl-config">
        <primary sortas="e-etc-xml-catalog">/etc/xml/catalog</primary>
      </indexterm>

    </sect3>

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

      <para>Create (or append) and populate the XML catalog file using the
      following commands as the <systemitem class="username">root</systemitem>
      user:</para>

<screen role="root"><userinput>if [ ! -d /etc/xml ]; then install -v -m755 -d /etc/xml; fi &amp;&amp;
if [ ! -f /etc/xml/catalog ]; then
    xmlcatalog --noout --create /etc/xml/catalog
fi &amp;&amp;

xmlcatalog --noout --add "rewriteSystem" \
           "http://docbook.sourceforge.net/release/xsl/&docbook-xsl-version;" \
           "/usr/share/xml/docbook/xsl-stylesheets-&docbook-xsl-version;" \
    /etc/xml/catalog &amp;&amp;

xmlcatalog --noout --add "rewriteURI" \
           "http://docbook.sourceforge.net/release/xsl/&docbook-xsl-version;" \
           "/usr/share/xml/docbook/xsl-stylesheets-&docbook-xsl-version;" \
    /etc/xml/catalog &amp;&amp;

xmlcatalog --noout --add "rewriteSystem" \
           "http://docbook.sourceforge.net/release/xsl/current" \
           "/usr/share/xml/docbook/xsl-stylesheets-&docbook-xsl-version;" \
    /etc/xml/catalog &amp;&amp;

xmlcatalog --noout --add "rewriteURI" \
           "http://docbook.sourceforge.net/release/xsl/current" \
           "/usr/share/xml/docbook/xsl-stylesheets-&docbook-xsl-version;" \
    /etc/xml/catalog</userinput></screen>

      <para>Occasionally, you may find the need to install other versions of
      the XSL stylesheets as some projects reference a specific version. One
      example is BLFS-6.0, which needs the 1.67.2 version. In these instances
      you should install any other required version in its own versioned
      directory and create catalog entries as follows (substitute the desired
      version number for <replaceable>[version]</replaceable>):</para>

<screen role="root"><userinput>xmlcatalog --noout --add "rewriteSystem" \
           "http://docbook.sourceforge.net/release/xsl/<replaceable>[version]</replaceable>" \
           "/usr/share/xml/docbook/xsl-stylesheets-<replaceable>[version]</replaceable>" \
    /etc/xml/catalog &amp;&amp;

xmlcatalog --noout --add "rewriteURI" \
           "http://docbook.sourceforge.net/release/xsl/<replaceable>[version]</replaceable>" \
           "/usr/share/xml/docbook/xsl-stylesheets-<replaceable>[version]</replaceable>" \
    /etc/xml/catalog</userinput></screen>

      <para>If you will be using the stylesheets from this installation to
      render the LFS and HLFS SVN books, then you need to create a symbolic
      link to the stylesheets directory so that the image files will be
      found. Create the link by issuing the following command as the
      <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>ln -v -sfn xsl-stylesheets-1.69.1 \
    /usr/share/xml/docbook/xsl-stylesheets-current</userinput></screen>

<!-- The following removed as recommended by Manuel

if [ ! -f /etc/xml/catalog ]; then
    xmlcatalog -\-noout -\-create /etc/xml/catalog
fi &amp;&amp;

xmlcatalog -\-noout -\-add "delegateSystem" \
    "http://docbook.sourceforge.net/release/xsl/" \
    "file:///etc/xml/docbook" \
    /etc/xml/catalog &amp;&amp;
xmlcatalog -\-noout -\-add "delegateURI" \
    "http://docbook.sourceforge.net/release/xsl/" \
    "file:///etc/xml/docbook" \
    /etc/xml/catalog</userinput></screen>

      <para>The system profile needs to be updated to utilize the new installed
      catalog. This can be done with the following command:<para>

<screen role="root"><userinput>cat &gt; /etc/profile.d/xsl.sh &lt;&lt; "EOF"
<literal># Set up Environment Variable for XSL Processing
export XML_CATALOG_FILES="/usr/share/xml/docbook/\
xsl-stylesheets-&docbook-xsl-version;/catalog.xml /etc/xml/catalog"</literal>
EOF</userinput></screen>

      <para>The above installation script creates the files and updates the
      catalog with the current version of the XML stylesheets. Some project
      stylesheets reference specific versions of XSL stylesheets, like BLFS-6.0,
      which needs the 1.67.2 version. The following commands can serve as an
      example for using a single XSL version to support any hard coded
      versions, as needed. Use the following as an example to use the current
      version of the stylesheets for the 1.67.2 version. Edit or add to the
      commands to suit your particular needs. Issue the commands as the
      <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>xmlcatalog -\-noout -\-add "rewriteSystem" \
    "http://docbook.sourceforge.net/release/xsl/1.67.2" \
    "/usr/share/xml/docbook/xsl-stylesheets-&docbook-xsl-version;" \
    /etc/xml/catalog &amp;&amp;
xmlcatalog -\-noout -\-add "rewriteURI" \
    "http://docbook.sourceforge.net/release/xsl/1.67.2" \
    "/usr/share/xml/docbook/xsl-stylesheets-&docbook-xsl-version;" \
    /etc/xml/catalog</userinput></screen>

-->

    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Files</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>None</seg>
        <seg>None</seg>
        <seg>XSL style sheets for HTML and FO</seg>
        <seg>/usr/share/xml/docbook/xsl-stylesheets-&docbook-xsl-version; and
        /usr/share/doc/docbook-xsl-&docbook-xsl-version;</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>