source: general/genutils/tidy-html5.xml

<?xml version="1.0" encoding="UTF-8"?>
<!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-html5-download-http "https://github.com/htacg/tidy-html5/archive/&tidy-html5-version;/tidy-html5-&tidy-html5-version;.tar.gz">
  <!ENTITY tidy-html5-download-ftp  " ">
  <!ENTITY tidy-html5-md5sum        "0f6c55ef651e258adbe5750f555af50f">
  <!ENTITY tidy-html5-size          "992 KB">
  <!ENTITY tidy-html5-buildsize     "11 MB">
  <!ENTITY tidy-html5-time          "0.2 SBU">
]>

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


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

  <indexterm zone="tidy-html5">
    <primary sortas="a-Tidy-HTML5">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>

    &lfs121_checked;

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

    <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>

  </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;
rm -fv /usr/lib/libtidy.a &amp;&amp;
install -v -m755 tab2space /usr/bin</userinput></screen>

  </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</seg>
    <seg>/usr/share/doc/tidy-&tidy-html5-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-html5 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-html5 tidy">
            <primary sortas="b-tidy">tidy</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libtidy">
        <term>
          <filename class="libraryfile">libtidy.so</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-html5 libtidy">
            <primary sortas="c-libtidy">libtidy.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>