[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 |
|
---|
[37191af] | 7 | <!ENTITY tidy-html5-download-http "https://github.com/htacg/tidy-html5/archive/&tidy-html5-version;.tar.gz">
|
---|
| 8 | <!ENTITY tidy-html5-download-ftp " ">
|
---|
| 9 | <!ENTITY tidy-html5-md5sum "ffbe6e8471eff90877b4d74bb714e22f">
|
---|
| 10 | <!ENTITY tidy-html5-size "517 KB">
|
---|
| 11 | <!ENTITY tidy-html5-buildsize "16 MB">
|
---|
| 12 | <!ENTITY tidy-html5-time "0.1 SBU">
|
---|
[9766fba] | 13 | ]>
|
---|
| 14 |
|
---|
[37191af] | 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 |
|
---|
[37191af] | 23 | <title>tidy-html5-&tidy-html5-version;</title>
|
---|
[85965ed] | 24 |
|
---|
[37191af] | 25 | <indexterm zone="tidy-html5">
|
---|
| 26 | <primary sortas="a-Tidy-HTML5">Tidy HTML5</primary>
|
---|
[c18d3b25] | 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
[d6e4445] | 30 | <title>Introduction to Tidy HTML5</title>
|
---|
[85965ed] | 31 |
|
---|
[d6e4445] | 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 |
|
---|
[3b3a3be] | 38 | &lfs79_checked;&gcc6_checked;
|
---|
[50929e8] | 39 |
|
---|
[c18d3b25] | 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
[37191af] | 43 | <para>Download (HTTP): <ulink url="&tidy-html5-download-http;"/></para>
|
---|
[c18d3b25] | 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
[37191af] | 46 | <para>Download (FTP): <ulink url="&tidy-html5-download-ftp;"/></para>
|
---|
[c18d3b25] | 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
[37191af] | 49 | <para>Download MD5 sum: &tidy-html5-md5sum;</para>
|
---|
[c18d3b25] | 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
[37191af] | 52 | <para>Download size: &tidy-html5-size;</para>
|
---|
[c18d3b25] | 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
[37191af] | 55 | <para>Estimated disk space required: &tidy-html5-buildsize;</para>
|
---|
[c18d3b25] | 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
[37191af] | 58 | <para>Estimated build time: &tidy-html5-time;</para>
|
---|
[c18d3b25] | 59 | </listitem>
|
---|
| 60 | </itemizedlist>
|
---|
| 61 |
|
---|
[d6e4445] | 62 | <note>
|
---|
| 63 | <para>
|
---|
[248bac5] | 64 | The <application>Tidy HTML5</application> source tarball shown above
|
---|
[37191af] | 65 | downloads with the correct name, tidy-html5-&tidy-html5-version;.tar.gz, if
|
---|
[d6e4445] | 66 | using a browser such as Firefox. If you prefer to use a command line
|
---|
[37191af] | 67 | program such as wget, you normally would obtain &tidy-html5-version;.tar.gz.
|
---|
[248bac5] | 68 | To obtain this package with the proper filename, run:
|
---|
| 69 |
|
---|
[37191af] | 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>
|
---|
[d6e4445] | 72 | </para>
|
---|
| 73 | </note>
|
---|
[b852852] | 74 |
|
---|
[d6e4445] | 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 |
|
---|
[c18d3b25] | 83 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[d6e4445] | 84 | <para role="optional"><xref linkend="doxygen"/></para>
|
---|
[85965ed] | 85 |
|
---|
[1039de3] | 86 | <para condition="html" role="usernotes">User Notes:
|
---|
| 87 | <ulink url="&blfs-wiki;/tidy"/></para>
|
---|
| 88 |
|
---|
[c18d3b25] | 89 | </sect2>
|
---|
[85965ed] | 90 |
|
---|
[c18d3b25] | 91 | <sect2 role="installation">
|
---|
[d6e4445] | 92 | <title>Installation of Tidy HTML5</title>
|
---|
| 93 |
|
---|
| 94 | <para>Install <application>Tidy HTML5</application> by running the following
|
---|
| 95 | commands:</para>
|
---|
[c18d3b25] | 96 |
|
---|
[d6e4445] | 97 | <screen><userinput>cd build/cmake &&
|
---|
| 98 |
|
---|
| 99 | cmake -DCMAKE_INSTALL_PREFIX=/usr \
|
---|
| 100 | -DCMAKE_BUILD_TYPE=Release \
|
---|
| 101 | -DBUILD_TAB2SPACE=ON \
|
---|
| 102 | ../.. &&
|
---|
[c18d3b25] | 103 |
|
---|
| 104 | make</userinput></screen>
|
---|
[afd6889] | 105 |
|
---|
[f3eefa7] | 106 | <para>This package does not come with a test suite.</para>
|
---|
[7c43113] | 107 |
|
---|
[d6e4445] | 108 | <para>Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 109 | </para>
|
---|
[85965ed] | 110 |
|
---|
[f3eefa7] | 111 | <screen role="root"><userinput>make install &&
|
---|
[d6e4445] | 112 | install -v -m755 tab2space /usr/bin</userinput></screen>
|
---|
[0124b3a] | 113 |
|
---|
[d6e4445] | 114 | <para>If you wish to install the API documentation you must have <xref
|
---|
| 115 | linkend="doxygen"/> installed, then change directories into the <filename
|
---|
| 116 | class='directory'>documentation</filename> directory of the source tree and
|
---|
| 117 | issue the command <command>doxygen doxygen.cfg</command>. Then as the
|
---|
| 118 | <systemitem class="username">root</systemitem> user copy the <filename
|
---|
| 119 | class='directory'>documentation/temp/tidylib_api</filename> directory to
|
---|
| 120 | <filename
|
---|
[37191af] | 121 | class='directory'>/usr/share/doc/tidy-&tidy-html5-version;.</filename></para>
|
---|
[f3eefa7] | 122 |
|
---|
[c18d3b25] | 123 | </sect2>
|
---|
[85965ed] | 124 |
|
---|
[22d9f68] | 125 | <sect2 role="commands">
|
---|
| 126 | <title>Command Explanations</title>
|
---|
| 127 |
|
---|
[d6e4445] | 128 | <para>
|
---|
| 129 | <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used to
|
---|
| 130 | build the release library without any debug `assert` in the code.
|
---|
| 131 | </para>
|
---|
| 132 |
|
---|
| 133 | <para>
|
---|
| 134 | <parameter>-DBUILD_TAB2SPACE=ON</parameter>: This switch is used to enable
|
---|
| 135 | building the <command>tab2space</command> utility.
|
---|
| 136 | </para>
|
---|
[22d9f68] | 137 |
|
---|
| 138 | </sect2>
|
---|
| 139 |
|
---|
[c18d3b25] | 140 | <sect2 role="configuration">
|
---|
[d6e4445] | 141 | <title>Configuring Tidy HTML5</title>
|
---|
[c18d3b25] | 142 |
|
---|
| 143 | <sect3>
|
---|
| 144 | <title>Config Files</title>
|
---|
[85965ed] | 145 |
|
---|
[8d77de6] | 146 | <para>The absolute path of the file specified in
|
---|
[c18d3b25] | 147 | <envar>$HTML_TIDY</envar>.</para>
|
---|
[85965ed] | 148 |
|
---|
[c18d3b25] | 149 | </sect3>
|
---|
| 150 |
|
---|
| 151 | <sect3>
|
---|
| 152 | <title>Configuration Information</title>
|
---|
[85965ed] | 153 |
|
---|
[8d77de6] | 154 | <para>The default configuration options can be set in the file defined in
|
---|
[f6ec478] | 155 | <envar>$HTML_TIDY</envar>. Additional configuration options can be passed
|
---|
| 156 | to <command>tidy</command> via command line parameters or the
|
---|
[c18d3b25] | 157 | <option>-config <file></option> parameter.</para>
|
---|
[85965ed] | 158 |
|
---|
[c18d3b25] | 159 | </sect3>
|
---|
[85965ed] | 160 |
|
---|
[c18d3b25] | 161 | </sect2>
|
---|
[85965ed] | 162 |
|
---|
[c18d3b25] | 163 | <sect2 role="content">
|
---|
| 164 | <title>Contents</title>
|
---|
| 165 |
|
---|
| 166 | <segmentedlist>
|
---|
| 167 | <segtitle>Installed Programs</segtitle>
|
---|
| 168 | <segtitle>Installed Library</segtitle>
|
---|
| 169 | <segtitle>Installed Directory</segtitle>
|
---|
| 170 | <seglistitem>
|
---|
| 171 | <seg>tab2space and tidy</seg>
|
---|
[d6e4445] | 172 | <seg>libtidy.so and libtidys.a</seg>
|
---|
[37191af] | 173 | <seg>/usr/share/doc/tidy-&tidy-html5-version;</seg>
|
---|
[c18d3b25] | 174 | </seglistitem>
|
---|
| 175 | </segmentedlist>
|
---|
[85965ed] | 176 |
|
---|
[c18d3b25] | 177 | <variablelist>
|
---|
| 178 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 179 | <?dbfo list-presentation="list"?>
|
---|
| 180 | <?dbhtml list-presentation="table"?>
|
---|
[85965ed] | 181 |
|
---|
[c18d3b25] | 182 | <varlistentry id="tab2space">
|
---|
| 183 | <term><command>tab2space</command></term>
|
---|
| 184 | <listitem>
|
---|
[8d77de6] | 185 | <para>is a utility to expand tabs and ensure consistent line
|
---|
[c18d3b25] | 186 | endings.</para>
|
---|
[37191af] | 187 | <indexterm zone="tidy-html5 tab2space">
|
---|
[c18d3b25] | 188 | <primary sortas="b-tab2space">tab2space</primary>
|
---|
| 189 | </indexterm>
|
---|
| 190 | </listitem>
|
---|
| 191 | </varlistentry>
|
---|
[85965ed] | 192 |
|
---|
[c18d3b25] | 193 | <varlistentry id="tidy">
|
---|
| 194 | <term><command>tidy</command></term>
|
---|
| 195 | <listitem>
|
---|
| 196 | <para>validates, corrects, and pretty-prints HTML files.</para>
|
---|
[37191af] | 197 | <indexterm zone="tidy-html5 tidy">
|
---|
[c18d3b25] | 198 | <primary sortas="b-tidy">tidy</primary>
|
---|
| 199 | </indexterm>
|
---|
| 200 | </listitem>
|
---|
| 201 | </varlistentry>
|
---|
[85965ed] | 202 |
|
---|
[c18d3b25] | 203 | <varlistentry id="libtidy">
|
---|
[d6e4445] | 204 | <term>
|
---|
| 205 | <filename class='libraryfile'>libtidy.so and libtidys.a</filename>
|
---|
| 206 | </term>
|
---|
[c18d3b25] | 207 | <listitem>
|
---|
[d6e4445] | 208 | <para>library provides the <application>Tidy HTML5</application> API
|
---|
[8d77de6] | 209 | functions to <command>tidy</command> and can also be called by other
|
---|
[c18d3b25] | 210 | programs.</para>
|
---|
[37191af] | 211 | <indexterm zone="tidy-html5 libtidy">
|
---|
[22d9f68] | 212 | <primary sortas="c-libtidy">libtidy.so</primary>
|
---|
[c18d3b25] | 213 | </indexterm>
|
---|
| 214 | </listitem>
|
---|
| 215 | </varlistentry>
|
---|
[85965ed] | 216 |
|
---|
[c18d3b25] | 217 | </variablelist>
|
---|
| 218 |
|
---|
| 219 | </sect2>
|
---|
[9766fba] | 220 |
|
---|
| 221 | </sect1>
|
---|