glfs/gnome/core/yelp-tools.xml

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

  <!ENTITY yelp-tools-download-http 
           "&gnome-download-http;/yelp-tools/3.4/yelp-tools-&yelp-tools-version;.tar.xz">
  <!ENTITY yelp-tools-download-ftp  
           "&gnome-download-ftp;/yelp-tools/3.4/yelp-tools-&yelp-tools-version;.tar.xz">
  <!ENTITY yelp-tools-md5sum        "8435aac25edbc530f878e93440c3d262">
  <!ENTITY yelp-tools-size          "192 KB">
  <!ENTITY yelp-tools-buildsize     "1.5 MB">
  <!ENTITY yelp-tools-time          "less than 0.1 SBU">
]>

<sect1 id="yelp-tools" xreflabel="yelp-tools-&yelp-tools-version;">
  <?dbhtml filename="yelp-tools.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>yelp-tools-&yelp-tools-version;</title>

  <indexterm zone="yelp-tools">
    <primary sortas="a-yelp-tools">yelp-tools</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to yelp-tools</title>

    <para>
      <application>yelp-tools</application> is a collection of 
      scripts and build utilities to help create, manage, and publish 
      documentation for Yelp and the web. Most of the heavy lifting 
      is done by packages like yelp-xsl and itstool. This package just
      wraps things up in a developer-friendly way.
    </para>

    &lfs70_checked;

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

    <bridgehead renderas="sect3">yelp-tools Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="yelp-xsl"/>
    </para>

    <para condition="html" role="usernotes">
      User Notes: <ulink url="&blfs-wiki;/yelp-tools"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of yelp-tools</title>

    <para>
      Install <application>yelp-tools</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>
  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          yelp-build, yelp-check and yelp-new
        </seg>
        <seg>
          /usr/share/yelp-tools
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="yelp-build">
        <term><command>yelp-build</command></term>
        <listitem>
          <para>
            is used to build output formats from 
            Mallard or DocBook files.
          </para>
          <indexterm zone="yelp-tools yelp-build">
            <primary sortas="b-yelp-build">yelp-build</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="yelp-check">
        <term><command>yelp-check</command></term>
        <listitem>
          <para>
            is used to keep track of the work while you write.
          </para>
          <indexterm zone="yelp-tools yelp-check">
            <primary sortas="b-yelp-check">yelp-check</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="yelp-new">
        <term><command>yelp-new</command></term>
        <listitem>
          <para>
            is used tocreate a new Mallard page file 
            from a template.
          </para>
          <indexterm zone="yelp-tools yelp-new">
            <primary sortas="b-yelp-new">yelp-new</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>