[9766fba] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[ff769b8c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
[9766fba] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY tidy-download-http "http://tidy.sourceforge.net/src/tidy_src_&tidy-version;.tgz">
|
---|
| 8 | <!ENTITY tidy-download-ftp " ">
|
---|
[e4019caa] | 9 | <!ENTITY tidy-md5sum "0344f22c437576eae9f4509b6ca2c98c">
|
---|
[0124b3a] | 10 | <!ENTITY tidy-size "254 KB">
|
---|
[e4019caa] | 11 | <!ENTITY tidy-buildsize "10 MB">
|
---|
[0124b3a] | 12 | <!ENTITY tidy-time "0.2 SBU">
|
---|
| 13 |
|
---|
| 14 | <!ENTITY tidy-docs-version "050502">
|
---|
| 15 | <!ENTITY tidy-docs-download "http://tidy.sourceforge.net/docs/tidy_docs_&tidy-docs-version;.tgz">
|
---|
| 16 | <!ENTITY tidy-docs-md5sum "54488c25347b9fee5c544a13ab5324ee">
|
---|
| 17 | <!ENTITY tidy-docs-size "150 KB">
|
---|
[9766fba] | 18 | ]>
|
---|
| 19 |
|
---|
[0fb1ed2] | 20 | <sect1 id="html-tidy" xreflabel="HTML Tidy-&tidy-version;">
|
---|
[c18d3b25] | 21 | <?dbhtml filename="tidy.html"?>
|
---|
[85965ed] | 22 |
|
---|
[c18d3b25] | 23 | <sect1info>
|
---|
| 24 | <othername>$LastChangedBy$</othername>
|
---|
| 25 | <date>$Date$</date>
|
---|
| 26 | </sect1info>
|
---|
[85965ed] | 27 |
|
---|
[c18d3b25] | 28 | <title>HTML Tidy-&tidy-version;</title>
|
---|
[85965ed] | 29 |
|
---|
[c18d3b25] | 30 | <indexterm zone="html-tidy">
|
---|
| 31 | <primary sortas="a-HTML-Tidy">HTML Tidy</primary>
|
---|
| 32 | </indexterm>
|
---|
| 33 |
|
---|
| 34 | <sect2 role="package">
|
---|
| 35 | <title>Introduction to HTML Tidy</title>
|
---|
[85965ed] | 36 |
|
---|
[8d77de6] | 37 | <para>The <application>HTML Tidy</application> package contains a
|
---|
| 38 | command line tool and libraries used to read HTML, XHTML and XML
|
---|
| 39 | files and write cleaned up markup. It detects and corrects many common coding
|
---|
| 40 | errors and strives to produce visually equivalent markup that is both
|
---|
[c18d3b25] | 41 | W3C compliant and compatible with most browsers.</para>
|
---|
[85965ed] | 42 |
|
---|
[c18d3b25] | 43 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 44 | <itemizedlist spacing="compact">
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>Download (HTTP): <ulink url="&tidy-download-http;"/></para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>Download (FTP): <ulink url="&tidy-download-ftp;"/></para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>Download MD5 sum: &tidy-md5sum;</para>
|
---|
| 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
| 55 | <para>Download size: &tidy-size;</para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>Estimated disk space required: &tidy-buildsize;</para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>Estimated build time: &tidy-time;</para>
|
---|
| 62 | </listitem>
|
---|
| 63 | </itemizedlist>
|
---|
| 64 |
|
---|
| 65 | <note>
|
---|
[8d77de6] | 66 | <para><application>HTML Tidy</application> is
|
---|
| 67 | updated very frequently by its maintainers, and the source package listed
|
---|
| 68 | above may not be available at the listed URL due to the
|
---|
| 69 | release of a newer version. The most current source package can be always be
|
---|
| 70 | downloaded from <ulink url="http://tidy.sourceforge.net/src/"/>. If this
|
---|
| 71 | version is newer than the version listed above, the following instructions
|
---|
| 72 | should work, but have not yet been tested by BLFS. If you'd rather download
|
---|
| 73 | the version listed above, you can find it at
|
---|
[c18d3b25] | 74 | <ulink url="http://tidy.sourceforge.net/src/old/"/>.</para>
|
---|
| 75 | </note>
|
---|
[85965ed] | 76 |
|
---|
[c18d3b25] | 77 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
[85965ed] | 78 |
|
---|
[c18d3b25] | 79 | <bridgehead renderas="sect4">Documentation</bridgehead>
|
---|
| 80 | <itemizedlist spacing="compact">
|
---|
| 81 | <listitem>
|
---|
| 82 | <para>Documentation: <ulink url="&tidy-docs-download;"/></para>
|
---|
| 83 | </listitem>
|
---|
| 84 | <listitem>
|
---|
| 85 | <para>Download MD5 sum: &tidy-docs-md5sum;</para>
|
---|
| 86 | </listitem>
|
---|
| 87 | <listitem>
|
---|
| 88 | <para>Download size: &tidy-docs-size;</para>
|
---|
| 89 | </listitem>
|
---|
| 90 | </itemizedlist>
|
---|
[85965ed] | 91 |
|
---|
[c18d3b25] | 92 | <bridgehead renderas="sect4">Patches</bridgehead>
|
---|
| 93 | <itemizedlist spacing="compact">
|
---|
| 94 | <listitem>
|
---|
[8d77de6] | 95 | <para>Required patch: <ulink
|
---|
[c18d3b25] | 96 | url="&patch-root;/tidy-&tidy-version;-prevent_PRE_newlines-1.patch"/></para>
|
---|
| 97 | </listitem>
|
---|
| 98 | </itemizedlist>
|
---|
[85965ed] | 99 |
|
---|
[c18d3b25] | 100 | <bridgehead renderas="sect3">HTML Tidy Dependencies</bridgehead>
|
---|
[85965ed] | 101 |
|
---|
[8d77de6] | 102 | <bridgehead renderas="sect4">Recommended (To Build the Man Page and Quick
|
---|
[0124b3a] | 103 | Reference Docs)</bridgehead>
|
---|
| 104 | <para><xref linkend="libxslt"/></para>
|
---|
| 105 |
|
---|
[c18d3b25] | 106 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 107 | <para><ulink url="http://dmalloc.com/">Dmalloc</ulink></para>
|
---|
[85965ed] | 108 |
|
---|
[c18d3b25] | 109 | </sect2>
|
---|
[85965ed] | 110 |
|
---|
[c18d3b25] | 111 | <sect2 role="installation">
|
---|
| 112 | <title>Installation of HTML Tidy</title>
|
---|
| 113 |
|
---|
[8d77de6] | 114 | <para>The <application>HTML Tidy</application> documentation
|
---|
[c18d3b25] | 115 | is contained in a separate tarball. Unpack both the source and docs tarballs
|
---|
| 116 | before starting the build.</para>
|
---|
[85965ed] | 117 |
|
---|
[8d77de6] | 118 | <para>Install <application>HTML Tidy</application> by
|
---|
[c18d3b25] | 119 | running the following commands:</para>
|
---|
| 120 |
|
---|
| 121 | <screen><userinput>patch -Np1 -i ../tidy-&tidy-version;-prevent_PRE_newlines-1.patch &&
|
---|
[9a66d5f] | 122 | sh build/gnuauto/setup.sh &&
|
---|
[9766fba] | 123 | ./configure --prefix=/usr &&
|
---|
[c18d3b25] | 124 | make</userinput></screen>
|
---|
[afd6889] | 125 |
|
---|
[7c43113] | 126 | <para>This package does not come with a test suite.</para>
|
---|
| 127 |
|
---|
[c18d3b25] | 128 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[85965ed] | 129 |
|
---|
[0124b3a] | 130 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 131 |
|
---|
| 132 | <para>If you have the dependencies shown above to build the man page and
|
---|
[8d77de6] | 133 | HTML documentation, issue the following commands as an unprivileged
|
---|
[0124b3a] | 134 | user:</para>
|
---|
| 135 |
|
---|
| 136 | <screen><userinput>cd htmldoc &&
|
---|
[2eebc7b9] | 137 | tidy -xml-help > tidy-help.xml &&
|
---|
| 138 | tidy -xml-config > tidy-config.xml &&
|
---|
| 139 | xsltproc -o tidy.1 tidy1.xsl tidy-help.xml &&
|
---|
| 140 | xsltproc -o quickref.html quickref-html.xsl tidy-config.xml &&
|
---|
[0124b3a] | 141 | cd ..</userinput></screen>
|
---|
| 142 |
|
---|
[8d77de6] | 143 | <para>If you built the man page and the Quick Reference HTML file, install
|
---|
| 144 | the man page by issuing the following command as the
|
---|
[0124b3a] | 145 | <systemitem class="username">root</systemitem> user:</para>
|
---|
| 146 |
|
---|
| 147 | <screen role="root"><userinput>install -v -m644 htmldoc/tidy.1 /usr/share/man/man1</userinput></screen>
|
---|
| 148 |
|
---|
[8d77de6] | 149 | <para>Now finish the installation by installing the pre-built
|
---|
[fc7afd0c] | 150 | documentation as the <systemitem class="username">root</systemitem>
|
---|
[0124b3a] | 151 | user:</para>
|
---|
| 152 |
|
---|
| 153 | <screen role="root"><userinput>install -v -m755 -d /usr/share/doc/tidy &&
|
---|
| 154 | cp -v -R htmldoc/* /usr/share/doc/tidy</userinput></screen>
|
---|
[85965ed] | 155 |
|
---|
[c18d3b25] | 156 | </sect2>
|
---|
[85965ed] | 157 |
|
---|
[c18d3b25] | 158 | <sect2 role="commands">
|
---|
| 159 | <title>Command Explanations</title>
|
---|
| 160 |
|
---|
[8d77de6] | 161 | <para><command>sh build/gnuauto/setup.sh</command>: This command prepares
|
---|
[c18d3b25] | 162 | the source tree for building using the GNU <quote>Auto</quote> tools.</para>
|
---|
[85965ed] | 163 |
|
---|
[c18d3b25] | 164 | </sect2>
|
---|
[85965ed] | 165 |
|
---|
[c18d3b25] | 166 | <sect2 role="configuration">
|
---|
| 167 | <title>Configuring HTML Tidy</title>
|
---|
| 168 |
|
---|
| 169 | <sect3>
|
---|
| 170 | <title>Config Files</title>
|
---|
[85965ed] | 171 |
|
---|
[8d77de6] | 172 | <para>The absolute path of the file specified in
|
---|
[c18d3b25] | 173 | <envar>$HTML_TIDY</envar>.</para>
|
---|
[85965ed] | 174 |
|
---|
[c18d3b25] | 175 | </sect3>
|
---|
| 176 |
|
---|
| 177 | <sect3>
|
---|
| 178 | <title>Configuration Information</title>
|
---|
[85965ed] | 179 |
|
---|
[8d77de6] | 180 | <para>The default configuration options can be set in the file defined in
|
---|
| 181 | <envar>$HTML_TIDY</envar>. Additional configuration options can be passed to
|
---|
| 182 | <command>tidy</command> via command line parameters or the
|
---|
[c18d3b25] | 183 | <option>-config <file></option> parameter.</para>
|
---|
[85965ed] | 184 |
|
---|
[c18d3b25] | 185 | </sect3>
|
---|
[85965ed] | 186 |
|
---|
[c18d3b25] | 187 | </sect2>
|
---|
[85965ed] | 188 |
|
---|
[c18d3b25] | 189 | <sect2 role="content">
|
---|
| 190 | <title>Contents</title>
|
---|
| 191 |
|
---|
| 192 | <segmentedlist>
|
---|
| 193 | <segtitle>Installed Programs</segtitle>
|
---|
| 194 | <segtitle>Installed Library</segtitle>
|
---|
| 195 | <segtitle>Installed Directory</segtitle>
|
---|
| 196 | <seglistitem>
|
---|
| 197 | <seg>tab2space and tidy</seg>
|
---|
| 198 | <seg>libtidy.[so,a]</seg>
|
---|
| 199 | <seg>/usr/share/doc/tidy</seg>
|
---|
| 200 | </seglistitem>
|
---|
| 201 | </segmentedlist>
|
---|
[85965ed] | 202 |
|
---|
[c18d3b25] | 203 | <variablelist>
|
---|
| 204 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 205 | <?dbfo list-presentation="list"?>
|
---|
| 206 | <?dbhtml list-presentation="table"?>
|
---|
[85965ed] | 207 |
|
---|
[c18d3b25] | 208 | <varlistentry id="tab2space">
|
---|
| 209 | <term><command>tab2space</command></term>
|
---|
| 210 | <listitem>
|
---|
[8d77de6] | 211 | <para>is a utility to expand tabs and ensure consistent line
|
---|
[c18d3b25] | 212 | endings.</para>
|
---|
| 213 | <indexterm zone="html-tidy tab2space">
|
---|
| 214 | <primary sortas="b-tab2space">tab2space</primary>
|
---|
| 215 | </indexterm>
|
---|
| 216 | </listitem>
|
---|
| 217 | </varlistentry>
|
---|
[85965ed] | 218 |
|
---|
[c18d3b25] | 219 | <varlistentry id="tidy">
|
---|
| 220 | <term><command>tidy</command></term>
|
---|
| 221 | <listitem>
|
---|
| 222 | <para>validates, corrects, and pretty-prints HTML files.</para>
|
---|
| 223 | <indexterm zone="html-tidy tidy">
|
---|
| 224 | <primary sortas="b-tidy">tidy</primary>
|
---|
| 225 | </indexterm>
|
---|
| 226 | </listitem>
|
---|
| 227 | </varlistentry>
|
---|
[85965ed] | 228 |
|
---|
[c18d3b25] | 229 | <varlistentry id="libtidy">
|
---|
| 230 | <term><filename class='libraryfile'>libtidy.[so,a]</filename></term>
|
---|
| 231 | <listitem>
|
---|
[8d77de6] | 232 | <para>libraries provide the <application>HTML Tidy</application> API
|
---|
| 233 | functions to <command>tidy</command> and can also be called by other
|
---|
[c18d3b25] | 234 | programs.</para>
|
---|
| 235 | <indexterm zone="html-tidy libtidy">
|
---|
| 236 | <primary sortas="c-libtidy">libtidy.[so,a]</primary>
|
---|
| 237 | </indexterm>
|
---|
| 238 | </listitem>
|
---|
| 239 | </varlistentry>
|
---|
[85965ed] | 240 |
|
---|
[c18d3b25] | 241 | </variablelist>
|
---|
| 242 |
|
---|
| 243 | </sect2>
|
---|
[9766fba] | 244 |
|
---|
| 245 | </sect1>
|
---|