[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[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 |
|
---|
[59e19f73] | 7 | <!ENTITY tidy-html5-download-http "https://github.com/htacg/tidy-html5/archive/&tidy-html5-version;/tidy-html5-&tidy-html5-version;.tar.gz">
|
---|
[2b65035a] | 8 | <!ENTITY tidy-html5-download-ftp " ">
|
---|
[f249e1f] | 9 | <!ENTITY tidy-html5-md5sum "0f6c55ef651e258adbe5750f555af50f">
|
---|
| 10 | <!ENTITY tidy-html5-size "992 KB">
|
---|
[11759d2] | 11 | <!ENTITY tidy-html5-buildsize "11 MB">
|
---|
[dcff87e8] | 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 |
|
---|
| 18 |
|
---|
[2b65035a] | 19 | <title>tidy-html5-&tidy-html5-version;</title>
|
---|
[85965ed] | 20 |
|
---|
[2b65035a] | 21 | <indexterm zone="tidy-html5">
|
---|
| 22 | <primary sortas="a-Tidy-HTML5">Tidy HTML5</primary>
|
---|
[c18d3b25] | 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
[523c6e95] | 26 | <title>Introduction to Tidy HTML5</title>
|
---|
[85965ed] | 27 |
|
---|
[b7a85cd9] | 28 | <para>
|
---|
| 29 | The <application>Tidy HTML5</application> package contains a
|
---|
| 30 | command line tool and libraries used to read HTML, XHTML and XML files
|
---|
| 31 | and write cleaned up markup. It detects and corrects many common coding
|
---|
| 32 | errors and strives to produce visually equivalent markup that is both
|
---|
| 33 | W3C compliant and compatible with most browsers.
|
---|
| 34 | </para>
|
---|
[85965ed] | 35 |
|
---|
[e375445] | 36 | &lfs122_checked;
|
---|
[50929e8] | 37 |
|
---|
[c18d3b25] | 38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 39 | <itemizedlist spacing="compact">
|
---|
| 40 | <listitem>
|
---|
[b7a85cd9] | 41 | <para>
|
---|
| 42 | Download (HTTP): <ulink url="&tidy-html5-download-http;"/>
|
---|
| 43 | </para>
|
---|
[c18d3b25] | 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
[b7a85cd9] | 46 | <para>
|
---|
| 47 | Download (FTP): <ulink url="&tidy-html5-download-ftp;"/>
|
---|
| 48 | </para>
|
---|
[c18d3b25] | 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
[b7a85cd9] | 51 | <para>
|
---|
| 52 | Download MD5 sum: &tidy-html5-md5sum;
|
---|
| 53 | </para>
|
---|
[c18d3b25] | 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
[b7a85cd9] | 56 | <para>
|
---|
| 57 | Download size: &tidy-html5-size;
|
---|
| 58 | </para>
|
---|
[c18d3b25] | 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
[b7a85cd9] | 61 | <para>
|
---|
| 62 | Estimated disk space required: &tidy-html5-buildsize;
|
---|
| 63 | </para>
|
---|
[c18d3b25] | 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
[b7a85cd9] | 66 | <para>
|
---|
| 67 | Estimated build time: &tidy-html5-time;
|
---|
| 68 | </para>
|
---|
[c18d3b25] | 69 | </listitem>
|
---|
| 70 | </itemizedlist>
|
---|
[b7a85cd9] | 71 |
|
---|
[523c6e95] | 72 | <bridgehead renderas="sect3">Tidy HTML5 Dependencies</bridgehead>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[b7a85cd9] | 75 | <para role="required">
|
---|
| 76 | <xref linkend="cmake"/>
|
---|
| 77 | </para>
|
---|
[523c6e95] | 78 |
|
---|
| 79 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[b7a85cd9] | 80 | <para role="recommended">
|
---|
| 81 | <xref linkend="libxslt"/>
|
---|
| 82 | </para>
|
---|
[85965ed] | 83 |
|
---|
[c18d3b25] | 84 | </sect2>
|
---|
[85965ed] | 85 |
|
---|
[c18d3b25] | 86 | <sect2 role="installation">
|
---|
[523c6e95] | 87 | <title>Installation of Tidy HTML5</title>
|
---|
| 88 |
|
---|
[b7a85cd9] | 89 | <para>
|
---|
| 90 | Install <application>Tidy HTML5</application> by running the following
|
---|
| 91 | commands:
|
---|
| 92 | </para>
|
---|
[c18d3b25] | 93 |
|
---|
[523c6e95] | 94 | <screen><userinput>cd build/cmake &&
|
---|
| 95 |
|
---|
[cbfa153] | 96 | cmake -D CMAKE_INSTALL_PREFIX=/usr \
|
---|
| 97 | -D CMAKE_BUILD_TYPE=Release \
|
---|
| 98 | -D BUILD_TAB2SPACE=ON \
|
---|
[523c6e95] | 99 | ../.. &&
|
---|
[c18d3b25] | 100 |
|
---|
| 101 | make</userinput></screen>
|
---|
[afd6889] | 102 |
|
---|
[b7a85cd9] | 103 | <para>
|
---|
| 104 | This package does not come with a test suite.
|
---|
| 105 | </para>
|
---|
[7c43113] | 106 |
|
---|
[b7a85cd9] | 107 | <para>
|
---|
| 108 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
[523c6e95] | 109 | </para>
|
---|
[85965ed] | 110 |
|
---|
[f3eefa7] | 111 | <screen role="root"><userinput>make install &&
|
---|
[b4ce81fd] | 112 | rm -fv /usr/lib/libtidy.a &&
|
---|
[523c6e95] | 113 | install -v -m755 tab2space /usr/bin</userinput></screen>
|
---|
[0124b3a] | 114 |
|
---|
[c18d3b25] | 115 | </sect2>
|
---|
[85965ed] | 116 |
|
---|
[22d9f68] | 117 | <sect2 role="commands">
|
---|
| 118 | <title>Command Explanations</title>
|
---|
| 119 |
|
---|
[523c6e95] | 120 | <para>
|
---|
[cbfa153] | 121 | <parameter>-D CMAKE_BUILD_TYPE=Release</parameter>: This switch is used to
|
---|
[523c6e95] | 122 | build the release library without any debug `assert` in the code.
|
---|
| 123 | </para>
|
---|
| 124 |
|
---|
| 125 | <para>
|
---|
[cbfa153] | 126 | <parameter>-D BUILD_TAB2SPACE=ON</parameter>: This switch is used to enable
|
---|
[523c6e95] | 127 | building the <command>tab2space</command> utility.
|
---|
| 128 | </para>
|
---|
[22d9f68] | 129 |
|
---|
| 130 | </sect2>
|
---|
| 131 |
|
---|
[c18d3b25] | 132 | <sect2 role="configuration">
|
---|
[523c6e95] | 133 | <title>Configuring Tidy HTML5</title>
|
---|
[c18d3b25] | 134 |
|
---|
| 135 | <sect3>
|
---|
| 136 | <title>Config Files</title>
|
---|
[85965ed] | 137 |
|
---|
[b7a85cd9] | 138 | <para>
|
---|
| 139 | The absolute path of the file specified in <envar>HTML_TIDY</envar>.
|
---|
| 140 | </para>
|
---|
[85965ed] | 141 |
|
---|
[c18d3b25] | 142 | </sect3>
|
---|
| 143 |
|
---|
| 144 | <sect3>
|
---|
| 145 | <title>Configuration Information</title>
|
---|
[85965ed] | 146 |
|
---|
[b7a85cd9] | 147 | <para>
|
---|
| 148 | The default configuration options can be set in the file defined in
|
---|
| 149 | <envar>HTML_TIDY</envar>. Additional configuration options can be
|
---|
| 150 | passed to <command>tidy</command> via command line parameters or the
|
---|
| 151 | <option>-config <file></option> parameter.
|
---|
| 152 | </para>
|
---|
[85965ed] | 153 |
|
---|
[c18d3b25] | 154 | </sect3>
|
---|
[85965ed] | 155 |
|
---|
[c18d3b25] | 156 | </sect2>
|
---|
[85965ed] | 157 |
|
---|
[c18d3b25] | 158 | <sect2 role="content">
|
---|
| 159 | <title>Contents</title>
|
---|
| 160 |
|
---|
| 161 | <segmentedlist>
|
---|
| 162 | <segtitle>Installed Programs</segtitle>
|
---|
| 163 | <segtitle>Installed Library</segtitle>
|
---|
| 164 | <segtitle>Installed Directory</segtitle>
|
---|
| 165 | <seglistitem>
|
---|
| 166 | <seg>tab2space and tidy</seg>
|
---|
[b4ce81fd] | 167 | <seg>libtidy.so</seg>
|
---|
[2b65035a] | 168 | <seg>/usr/share/doc/tidy-&tidy-html5-version;</seg>
|
---|
[c18d3b25] | 169 | </seglistitem>
|
---|
| 170 | </segmentedlist>
|
---|
[85965ed] | 171 |
|
---|
[c18d3b25] | 172 | <variablelist>
|
---|
| 173 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 174 | <?dbfo list-presentation="list"?>
|
---|
| 175 | <?dbhtml list-presentation="table"?>
|
---|
[85965ed] | 176 |
|
---|
[c18d3b25] | 177 | <varlistentry id="tab2space">
|
---|
| 178 | <term><command>tab2space</command></term>
|
---|
| 179 | <listitem>
|
---|
[b7a85cd9] | 180 | <para>
|
---|
[4c24eb0a] | 181 | is a utility to expand tabs and ensure consistent line endings
|
---|
[b7a85cd9] | 182 | </para>
|
---|
[2b65035a] | 183 | <indexterm zone="tidy-html5 tab2space">
|
---|
[c18d3b25] | 184 | <primary sortas="b-tab2space">tab2space</primary>
|
---|
| 185 | </indexterm>
|
---|
| 186 | </listitem>
|
---|
| 187 | </varlistentry>
|
---|
[85965ed] | 188 |
|
---|
[c18d3b25] | 189 | <varlistentry id="tidy">
|
---|
| 190 | <term><command>tidy</command></term>
|
---|
| 191 | <listitem>
|
---|
[b7a85cd9] | 192 | <para>
|
---|
[4c24eb0a] | 193 | validates, corrects, and pretty-prints HTML files
|
---|
[b7a85cd9] | 194 | </para>
|
---|
[2b65035a] | 195 | <indexterm zone="tidy-html5 tidy">
|
---|
[c18d3b25] | 196 | <primary sortas="b-tidy">tidy</primary>
|
---|
| 197 | </indexterm>
|
---|
| 198 | </listitem>
|
---|
| 199 | </varlistentry>
|
---|
[85965ed] | 200 |
|
---|
[c18d3b25] | 201 | <varlistentry id="libtidy">
|
---|
[523c6e95] | 202 | <term>
|
---|
[b4ce81fd] | 203 | <filename class="libraryfile">libtidy.so</filename>
|
---|
[523c6e95] | 204 | </term>
|
---|
[c18d3b25] | 205 | <listitem>
|
---|
[b7a85cd9] | 206 | <para>
|
---|
| 207 | library provides the <application>Tidy HTML5</application> API
|
---|
| 208 | functions to <command>tidy</command> and can also be called by other
|
---|
[4c24eb0a] | 209 | programs
|
---|
[b7a85cd9] | 210 | </para>
|
---|
[2b65035a] | 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>
|
---|