[9766fba] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
---|
| 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 " ">
|
---|
| 9 | <!ENTITY tidy-size "244 KB">
|
---|
[53a3831] | 10 | <!ENTITY tidy-buildsize "9.3 MB">
|
---|
| 11 | <!ENTITY tidy-time "0.26 SBU">
|
---|
[9766fba] | 12 | ]>
|
---|
| 13 |
|
---|
| 14 | <sect1 id="tidy" xreflabel="HTML Tidy-&tidy-version;">
|
---|
| 15 | <sect1info>
|
---|
| 16 | <othername>$LastChangedBy$</othername>
|
---|
| 17 | <date>$Date$</date>
|
---|
| 18 | </sect1info>
|
---|
| 19 | <?dbhtml filename="tidy.html"?>
|
---|
| 20 | <title>HTML Tidy-&tidy-version;</title>
|
---|
| 21 |
|
---|
| 22 | <sect2>
|
---|
| 23 | <title>Introduction to <application>HTML Tidy</application></title>
|
---|
| 24 |
|
---|
| 25 | <para>The <application><acronym>HTML</acronym> Tidy</application> package
|
---|
| 26 | contains a command line tool and libraries used to read
|
---|
| 27 | <acronym>HTML</acronym>, <acronym>XHTML</acronym> and <acronym>XML</acronym>
|
---|
| 28 | files and write cleaned up markup. It detects and corrects many common coding
|
---|
| 29 | errors and strives to produce visually equivalent markup that is both
|
---|
| 30 | <acronym>W3C</acronym> compliant and compatible with most browsers.</para>
|
---|
| 31 |
|
---|
| 32 | <sect3><title>Package information</title>
|
---|
| 33 | <itemizedlist spacing="compact">
|
---|
| 34 | <listitem><para>Download (HTTP):
|
---|
| 35 | <ulink url="&tidy-download-http;"/></para></listitem>
|
---|
| 36 | <listitem><para>Download (FTP):
|
---|
| 37 | <ulink url="&tidy-download-ftp;"/></para></listitem>
|
---|
| 38 | <listitem><para>Download size: &tidy-size;</para></listitem>
|
---|
| 39 | <listitem><para>Estimated Disk space required:
|
---|
| 40 | &tidy-buildsize;</para></listitem>
|
---|
| 41 | <listitem><para>Estimated build time: &tidy-time;</para></listitem>
|
---|
| 42 | </itemizedlist>
|
---|
| 43 | </sect3>
|
---|
| 44 |
|
---|
| 45 | <sect3><title>Additional downloads</title>
|
---|
| 46 | <itemizedlist spacing="compact">
|
---|
| 47 | <listitem><para>Documentation: <ulink
|
---|
| 48 | url="http://tidy.sourceforge.net/docs/tidy_docs.tgz"/></para></listitem>
|
---|
| 49 | </itemizedlist>
|
---|
| 50 | </sect3>
|
---|
| 51 |
|
---|
[6e01862c] | 52 | <sect3><title><application><acronym>HTML</acronym> Tidy</application>
|
---|
| 53 | dependencies</title>
|
---|
| 54 | <sect4><title>Optional</title>
|
---|
| 55 | <para><ulink url="http://dmalloc.com/">Dmalloc</ulink></para>
|
---|
| 56 | </sect4>
|
---|
| 57 | </sect3>
|
---|
| 58 |
|
---|
[9766fba] | 59 | </sect2>
|
---|
| 60 |
|
---|
| 61 | <sect2>
|
---|
| 62 | <title>Installation of <application><acronym>HTML</acronym>
|
---|
| 63 | Tidy</application></title>
|
---|
| 64 |
|
---|
| 65 | <para>The <application><acronym>HTML</acronym> Tidy</application> documentation
|
---|
| 66 | is contained in a separate tarball. Unpack both the source and docs tarballs
|
---|
| 67 | before starting the build.</para>
|
---|
| 68 |
|
---|
| 69 | <para>Install <application><acronym>HTML</acronym> Tidy</application> by
|
---|
| 70 | running the following commands:</para>
|
---|
| 71 |
|
---|
| 72 | <screen><userinput><command>sh build/gnuauto/setup.sh &&
|
---|
| 73 | ./configure --prefix=/usr &&
|
---|
| 74 | make &&
|
---|
| 75 | make install &&
|
---|
| 76 | install -m644 -oroot -groot htmldoc/man_page.txt \
|
---|
| 77 | /usr/share/man/man1/tidy.1 &&
|
---|
| 78 | install -d -m755 -oroot -groot /usr/share/doc/tidy &&
|
---|
| 79 | cp -R htmldoc /usr/share/doc/tidy &&
|
---|
| 80 | chown -R root:root /usr/share/doc/tidy</command></userinput></screen>
|
---|
| 81 |
|
---|
| 82 | </sect2>
|
---|
| 83 |
|
---|
| 84 | <sect2>
|
---|
| 85 | <title>Command explanations</title>
|
---|
| 86 |
|
---|
| 87 | <para><command>sh build/gnuauto/setup.sh</command>: This command prepares the
|
---|
| 88 | source tree for building using the <acronym>GNU</acronym> <quote>Auto</quote>
|
---|
| 89 | tools.</para>
|
---|
| 90 |
|
---|
| 91 | </sect2>
|
---|
| 92 |
|
---|
| 93 | <sect2>
|
---|
| 94 | <title>Configuring <application><acronym>HTML</acronym>
|
---|
| 95 | Tidy</application></title>
|
---|
| 96 |
|
---|
| 97 | <sect3><title>Config files</title>
|
---|
| 98 | <para>The absolute path of the file specified in
|
---|
| 99 | <envar>$HTML_TIDY</envar>.</para>
|
---|
| 100 | </sect3>
|
---|
| 101 |
|
---|
| 102 | <sect3><title>Configuration Information</title>
|
---|
| 103 |
|
---|
| 104 | <para>The default configuration options can be set in the file defined in
|
---|
| 105 | <envar>$HTML_TIDY</envar>. Additional configuration options can be passed to
|
---|
| 106 | <command>tidy</command> via command line parameters or the
|
---|
| 107 | <parameter>-config <file></parameter> parameter.</para>
|
---|
| 108 | </sect3>
|
---|
| 109 |
|
---|
| 110 | </sect2>
|
---|
| 111 |
|
---|
| 112 | <sect2>
|
---|
| 113 | <title>Contents</title>
|
---|
| 114 |
|
---|
| 115 | <para>The <application><acronym>HTML</acronym> Tidy</application> package
|
---|
| 116 | contains <command>tidy</command>, <command>tab2space</command> and the
|
---|
| 117 | <filename class='libraryfile'>libtidy</filename> libraries.</para>
|
---|
| 118 |
|
---|
| 119 | </sect2>
|
---|
| 120 |
|
---|
| 121 | <sect2><title>Description</title>
|
---|
| 122 |
|
---|
| 123 | <sect3><title>tidy</title>
|
---|
| 124 | <para><command>tidy</command> validates, corrects, and pretty-prints
|
---|
| 125 | <acronym>HTML</acronym> files.</para>
|
---|
| 126 | </sect3>
|
---|
| 127 |
|
---|
| 128 | <sect3><title>tab2space</title>
|
---|
| 129 | <para><command>tab2space</command> is a utility to expand tabs and ensure
|
---|
| 130 | consistent line endings.</para>
|
---|
| 131 | </sect3>
|
---|
| 132 |
|
---|
| 133 | <sect3><title>libtidy libraries</title>
|
---|
| 134 | <para><filename class='libraryfile'>libtidy</filename> libraries provide the
|
---|
| 135 | <application><acronym>HTML</acronym> Tidy</application> <acronym>API</acronym>
|
---|
| 136 | functions to <command>tidy</command> and can also be called by other
|
---|
| 137 | programs.</para>
|
---|
| 138 | </sect3>
|
---|
| 139 |
|
---|
| 140 | </sect2>
|
---|
| 141 |
|
---|
| 142 | </sect1>
|
---|
| 143 |
|
---|