[9766fba] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[6732c094] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
[9766fba] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[38233b9e] | 7 | <!ENTITY tidy-html5-download-http "https://github.com/htacg/tidy-html5/releases/download/&tidy-html5-version;/tidy-html5-&tidy-html5-version;.tar.gz">
|
---|
[2b65035a] | 8 | <!ENTITY tidy-html5-download-ftp " ">
|
---|
[dcff87e8] | 9 | <!ENTITY tidy-html5-md5sum "7e121e1da7e21dc47610b87aae4b4f65">
|
---|
| 10 | <!ENTITY tidy-html5-size "512 KB">
|
---|
| 11 | <!ENTITY tidy-html5-buildsize "8.4 MB">
|
---|
| 12 | <!ENTITY tidy-html5-time "0.2 SBU">
|
---|
[9766fba] | 13 | ]>
|
---|
| 14 |
|
---|
[2b65035a] | 15 | <sect1 id="tidy-html5" xreflabel="tidy-html5-&tidy-html5-version;">
|
---|
| 16 | <?dbhtml filename="tidy-html5.html"?>
|
---|
[85965ed] | 17 |
|
---|
[c18d3b25] | 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
[85965ed] | 22 |
|
---|
[2b65035a] | 23 | <title>tidy-html5-&tidy-html5-version;</title>
|
---|
[85965ed] | 24 |
|
---|
[2b65035a] | 25 | <indexterm zone="tidy-html5">
|
---|
| 26 | <primary sortas="a-Tidy-HTML5">Tidy HTML5</primary>
|
---|
[c18d3b25] | 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
[523c6e95] | 30 | <title>Introduction to Tidy HTML5</title>
|
---|
[85965ed] | 31 |
|
---|
[523c6e95] | 32 | <para>The <application>Tidy HTML5</application> package contains a
|
---|
[f6ec478] | 33 | command line tool and libraries used to read HTML, XHTML and XML files
|
---|
| 34 | and write cleaned up markup. It detects and corrects many common coding
|
---|
[8d77de6] | 35 | errors and strives to produce visually equivalent markup that is both
|
---|
[c18d3b25] | 36 | W3C compliant and compatible with most browsers.</para>
|
---|
[85965ed] | 37 |
|
---|
[6d2249e] | 38 | &lfs82_checked;
|
---|
[50929e8] | 39 |
|
---|
[c18d3b25] | 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
[2b65035a] | 43 | <para>Download (HTTP): <ulink url="&tidy-html5-download-http;"/></para>
|
---|
[c18d3b25] | 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
[2b65035a] | 46 | <para>Download (FTP): <ulink url="&tidy-html5-download-ftp;"/></para>
|
---|
[c18d3b25] | 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
[2b65035a] | 49 | <para>Download MD5 sum: &tidy-html5-md5sum;</para>
|
---|
[c18d3b25] | 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
[2b65035a] | 52 | <para>Download size: &tidy-html5-size;</para>
|
---|
[c18d3b25] | 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
[2b65035a] | 55 | <para>Estimated disk space required: &tidy-html5-buildsize;</para>
|
---|
[c18d3b25] | 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
[2b65035a] | 58 | <para>Estimated build time: &tidy-html5-time;</para>
|
---|
[c18d3b25] | 59 | </listitem>
|
---|
| 60 | </itemizedlist>
|
---|
[38233b9e] | 61 | <!--
|
---|
[523c6e95] | 62 | <note>
|
---|
| 63 | <para>
|
---|
[940db6cc] | 64 | The <application>Tidy HTML5</application> source tarball shown above
|
---|
[2b65035a] | 65 | downloads with the correct name, tidy-html5-&tidy-html5-version;.tar.gz, if
|
---|
[523c6e95] | 66 | using a browser such as Firefox. If you prefer to use a command line
|
---|
[2b65035a] | 67 | program such as wget, you normally would obtain &tidy-html5-version;.tar.gz.
|
---|
[779d3b5] | 68 | To obtain this package with the proper filename, run:
|
---|
| 69 |
|
---|
[2b65035a] | 70 | <screen><userinput>wget -c https://github.com/htacg/tidy-html5/archive/&tidy-html5-version;.tar.gz \
|
---|
| 71 | -O tidy-html5-&tidy-html5-version;.tar.gz</userinput></screen>
|
---|
[523c6e95] | 72 | </para>
|
---|
| 73 | </note>
|
---|
[38233b9e] | 74 | -->
|
---|
[523c6e95] | 75 | <bridgehead renderas="sect3">Tidy HTML5 Dependencies</bridgehead>
|
---|
| 76 |
|
---|
| 77 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 78 | <para role="required"><xref linkend="cmake"/></para>
|
---|
| 79 |
|
---|
| 80 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 81 | <para role="recommended"><xref linkend="libxslt"/></para>
|
---|
[85965ed] | 82 |
|
---|
[1039de3] | 83 | <para condition="html" role="usernotes">User Notes:
|
---|
| 84 | <ulink url="&blfs-wiki;/tidy"/></para>
|
---|
| 85 |
|
---|
[c18d3b25] | 86 | </sect2>
|
---|
[85965ed] | 87 |
|
---|
[c18d3b25] | 88 | <sect2 role="installation">
|
---|
[523c6e95] | 89 | <title>Installation of Tidy HTML5</title>
|
---|
| 90 |
|
---|
| 91 | <para>Install <application>Tidy HTML5</application> by running the following
|
---|
| 92 | commands:</para>
|
---|
[c18d3b25] | 93 |
|
---|
[523c6e95] | 94 | <screen><userinput>cd build/cmake &&
|
---|
| 95 |
|
---|
| 96 | cmake -DCMAKE_INSTALL_PREFIX=/usr \
|
---|
| 97 | -DCMAKE_BUILD_TYPE=Release \
|
---|
| 98 | -DBUILD_TAB2SPACE=ON \
|
---|
| 99 | ../.. &&
|
---|
[c18d3b25] | 100 |
|
---|
| 101 | make</userinput></screen>
|
---|
[afd6889] | 102 |
|
---|
[f3eefa7] | 103 | <para>This package does not come with a test suite.</para>
|
---|
[7c43113] | 104 |
|
---|
[523c6e95] | 105 | <para>Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 106 | </para>
|
---|
[85965ed] | 107 |
|
---|
[f3eefa7] | 108 | <screen role="root"><userinput>make install &&
|
---|
[523c6e95] | 109 | install -v -m755 tab2space /usr/bin</userinput></screen>
|
---|
[0124b3a] | 110 |
|
---|
[c18d3b25] | 111 | </sect2>
|
---|
[85965ed] | 112 |
|
---|
[22d9f68] | 113 | <sect2 role="commands">
|
---|
| 114 | <title>Command Explanations</title>
|
---|
| 115 |
|
---|
[523c6e95] | 116 | <para>
|
---|
| 117 | <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used to
|
---|
| 118 | build the release library without any debug `assert` in the code.
|
---|
| 119 | </para>
|
---|
| 120 |
|
---|
| 121 | <para>
|
---|
| 122 | <parameter>-DBUILD_TAB2SPACE=ON</parameter>: This switch is used to enable
|
---|
| 123 | building the <command>tab2space</command> utility.
|
---|
| 124 | </para>
|
---|
[22d9f68] | 125 |
|
---|
| 126 | </sect2>
|
---|
| 127 |
|
---|
[c18d3b25] | 128 | <sect2 role="configuration">
|
---|
[523c6e95] | 129 | <title>Configuring Tidy HTML5</title>
|
---|
[c18d3b25] | 130 |
|
---|
| 131 | <sect3>
|
---|
| 132 | <title>Config Files</title>
|
---|
[85965ed] | 133 |
|
---|
[8d77de6] | 134 | <para>The absolute path of the file specified in
|
---|
[c18d3b25] | 135 | <envar>$HTML_TIDY</envar>.</para>
|
---|
[85965ed] | 136 |
|
---|
[c18d3b25] | 137 | </sect3>
|
---|
| 138 |
|
---|
| 139 | <sect3>
|
---|
| 140 | <title>Configuration Information</title>
|
---|
[85965ed] | 141 |
|
---|
[8d77de6] | 142 | <para>The default configuration options can be set in the file defined in
|
---|
[f6ec478] | 143 | <envar>$HTML_TIDY</envar>. Additional configuration options can be passed
|
---|
| 144 | to <command>tidy</command> via command line parameters or the
|
---|
[c18d3b25] | 145 | <option>-config <file></option> parameter.</para>
|
---|
[85965ed] | 146 |
|
---|
[c18d3b25] | 147 | </sect3>
|
---|
[85965ed] | 148 |
|
---|
[c18d3b25] | 149 | </sect2>
|
---|
[85965ed] | 150 |
|
---|
[c18d3b25] | 151 | <sect2 role="content">
|
---|
| 152 | <title>Contents</title>
|
---|
| 153 |
|
---|
| 154 | <segmentedlist>
|
---|
| 155 | <segtitle>Installed Programs</segtitle>
|
---|
| 156 | <segtitle>Installed Library</segtitle>
|
---|
| 157 | <segtitle>Installed Directory</segtitle>
|
---|
| 158 | <seglistitem>
|
---|
| 159 | <seg>tab2space and tidy</seg>
|
---|
[523c6e95] | 160 | <seg>libtidy.so and libtidys.a</seg>
|
---|
[2b65035a] | 161 | <seg>/usr/share/doc/tidy-&tidy-html5-version;</seg>
|
---|
[c18d3b25] | 162 | </seglistitem>
|
---|
| 163 | </segmentedlist>
|
---|
[85965ed] | 164 |
|
---|
[c18d3b25] | 165 | <variablelist>
|
---|
| 166 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 167 | <?dbfo list-presentation="list"?>
|
---|
| 168 | <?dbhtml list-presentation="table"?>
|
---|
[85965ed] | 169 |
|
---|
[c18d3b25] | 170 | <varlistentry id="tab2space">
|
---|
| 171 | <term><command>tab2space</command></term>
|
---|
| 172 | <listitem>
|
---|
[8d77de6] | 173 | <para>is a utility to expand tabs and ensure consistent line
|
---|
[c18d3b25] | 174 | endings.</para>
|
---|
[2b65035a] | 175 | <indexterm zone="tidy-html5 tab2space">
|
---|
[c18d3b25] | 176 | <primary sortas="b-tab2space">tab2space</primary>
|
---|
| 177 | </indexterm>
|
---|
| 178 | </listitem>
|
---|
| 179 | </varlistentry>
|
---|
[85965ed] | 180 |
|
---|
[c18d3b25] | 181 | <varlistentry id="tidy">
|
---|
| 182 | <term><command>tidy</command></term>
|
---|
| 183 | <listitem>
|
---|
| 184 | <para>validates, corrects, and pretty-prints HTML files.</para>
|
---|
[2b65035a] | 185 | <indexterm zone="tidy-html5 tidy">
|
---|
[c18d3b25] | 186 | <primary sortas="b-tidy">tidy</primary>
|
---|
| 187 | </indexterm>
|
---|
| 188 | </listitem>
|
---|
| 189 | </varlistentry>
|
---|
[85965ed] | 190 |
|
---|
[c18d3b25] | 191 | <varlistentry id="libtidy">
|
---|
[523c6e95] | 192 | <term>
|
---|
| 193 | <filename class='libraryfile'>libtidy.so and libtidys.a</filename>
|
---|
| 194 | </term>
|
---|
[c18d3b25] | 195 | <listitem>
|
---|
[523c6e95] | 196 | <para>library provides the <application>Tidy HTML5</application> API
|
---|
[8d77de6] | 197 | functions to <command>tidy</command> and can also be called by other
|
---|
[c18d3b25] | 198 | programs.</para>
|
---|
[2b65035a] | 199 | <indexterm zone="tidy-html5 libtidy">
|
---|
[22d9f68] | 200 | <primary sortas="c-libtidy">libtidy.so</primary>
|
---|
[c18d3b25] | 201 | </indexterm>
|
---|
| 202 | </listitem>
|
---|
| 203 | </varlistentry>
|
---|
[85965ed] | 204 |
|
---|
[c18d3b25] | 205 | </variablelist>
|
---|
| 206 |
|
---|
| 207 | </sect2>
|
---|
[9766fba] | 208 |
|
---|
| 209 | </sect1>
|
---|