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