source: general/genutils/tidy.xml@ dce6561

<?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 tidy-download-http "https://github.com/htacg/tidy-html5/archive/&tidy-version;.tar.gz">
  <!ENTITY tidy-download-ftp  " ">
  <!ENTITY tidy-md5sum        "5fd96deef635ab8cea3dc74079f54d95">
  <!ENTITY tidy-size          "632 KB">
  <!ENTITY tidy-buildsize     "16 MB">
  <!ENTITY tidy-time          "0.1 SBU">
]>

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

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

  <title>tidy-html5-&tidy-version;</title>

  <indexterm zone="tidy-html">
    <primary sortas="a-Tidy-HTML">Tidy HTML5</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Tidy HTML5</title>

    <para>The <application>Tidy HTML5</application> package contains a
    command line tool and libraries used to read HTML, XHTML and XML files
    and write cleaned up markup. It detects and corrects many common coding
    errors and strives to produce visually equivalent markup that is both
    W3C compliant and compatible with most browsers.</para>

    &lfs78_checked;

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

    <note>
      <para>
        The <application>Tidy HTML5</application> source tarball shown above
        downloads with the correct name, tidy-html5-&tidy-version;.tar.gz, if
        using a browser such as Firefox. If you prefer to use a command line
        program such as wget, you normally would obtain &tidy-version;.tar.gz.
        To obtain this package with the proper filename, run:

<screen><userinput>wget -c https://github.com/htacg/tidy-html5/archive/&tidy-version;.tar.gz \
     -O tidy-html5-&tidy-version;.tar.gz</userinput></screen>
        </para>
      </note>

    <bridgehead renderas="sect3">Tidy HTML5 Dependencies</bridgehead>

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

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended"><xref linkend="libxslt"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="doxygen"/></para>

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of Tidy HTML5</title>

    <para>Install <application>Tidy HTML5</application> by running the following
    commands:</para>

<screen><userinput>cd build/cmake &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DBUILD_TAB2SPACE=ON        \
      ../..    &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 &amp;&amp;
install -v -m755 tab2space /usr/bin</userinput></screen>

    <para>If you wish to install the API documentation you must have <xref
    linkend="doxygen"/> installed, then change directories into the <filename
    class='directory'>documentation</filename> directory of the source tree and
    issue the command <command>doxygen doxygen.cfg</command>. Then as the
    <systemitem class="username">root</systemitem> user copy the <filename
    class='directory'>documentation/temp/tidylib_api</filename> directory to
    <filename
    class='directory'>/usr/share/doc/tidy-&tidy-version;.</filename></para>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para>
      <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used to
      build the release library without any debug `assert` in the code.
    </para>

    <para>
      <parameter>-DBUILD_TAB2SPACE=ON</parameter>: This switch is used to enable
      building the <command>tab2space</command> utility.
    </para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Tidy HTML5</title>

    <sect3>
      <title>Config Files</title>

      <para>The absolute path of the file specified in
      <envar>$HTML_TIDY</envar>.</para>

    </sect3>

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

      <para>The default configuration options can be set in the file defined in
      <envar>$HTML_TIDY</envar>. Additional configuration options can be passed
      to <command>tidy</command> via command line parameters or the
      <option>-config &lt;file&gt;</option> parameter.</para>

    </sect3>

  </sect2>

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

    <segmentedlist>
    <segtitle>Installed Programs</segtitle>
    <segtitle>Installed Library</segtitle>
    <segtitle>Installed Directory</segtitle>
    <seglistitem>
    <seg>tab2space and tidy</seg>
    <seg>libtidy.so and libtidys.a</seg>
    <seg>/usr/share/doc/tidy-&tidy-version;</seg>
    </seglistitem>
    </segmentedlist>

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

      <varlistentry id="tab2space">
        <term><command>tab2space</command></term>
        <listitem>
          <para>is a utility to expand tabs and ensure consistent line
          endings.</para>
          <indexterm zone="tidy-html tab2space">
            <primary sortas="b-tab2space">tab2space</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tidy">
        <term><command>tidy</command></term>
        <listitem>
          <para>validates, corrects, and pretty-prints HTML files.</para>
          <indexterm zone="tidy-html tidy">
            <primary sortas="b-tidy">tidy</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libtidy">
        <term>
          <filename class='libraryfile'>libtidy.so and libtidys.a</filename>
        </term>
        <listitem>
          <para>library provides the <application>Tidy HTML5</application> API
          functions to <command>tidy</command> and can also be called by other
          programs.</para>
          <indexterm zone="tidy-html libtidy">
            <primary sortas="c-libtidy">libtidy.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>