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-md5sum "8a1d13a83946260c4c46b962b300cd0f">
|
---|
10 | <!ENTITY tidy-size "243 KB">
|
---|
11 | <!ENTITY tidy-buildsize "9.6 MB">
|
---|
12 | <!ENTITY tidy-time "0.26 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="html-tidy" xreflabel="HTML Tidy-&tidy-version;">
|
---|
16 | <sect1info>
|
---|
17 | <othername>$LastChangedBy$</othername>
|
---|
18 | <date>$Date$</date>
|
---|
19 | </sect1info>
|
---|
20 | <?dbhtml filename="tidy.html"?>
|
---|
21 | <title>HTML Tidy-&tidy-version;</title>
|
---|
22 | <indexterm zone="html-tidy">
|
---|
23 | <primary sortas="a-HTML-Tidy">HTML Tidy</primary></indexterm>
|
---|
24 |
|
---|
25 | <sect2>
|
---|
26 | <title>Introduction to <application>HTML Tidy</application></title>
|
---|
27 |
|
---|
28 | <para>The <application><acronym>HTML</acronym> Tidy</application> package
|
---|
29 | contains a command line tool and libraries used to read
|
---|
30 | <acronym>HTML</acronym>, <acronym>XHTML</acronym> and <acronym>XML</acronym>
|
---|
31 | files 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 | <acronym>W3C</acronym> compliant and compatible with most browsers.</para>
|
---|
34 |
|
---|
35 | <sect3><title>Package information</title>
|
---|
36 | <itemizedlist spacing="compact">
|
---|
37 | <listitem><para>Download (HTTP):
|
---|
38 | <ulink url="&tidy-download-http;"/></para></listitem>
|
---|
39 | <listitem><para>Download (FTP):
|
---|
40 | <ulink url="&tidy-download-ftp;"/></para></listitem>
|
---|
41 | <listitem><para>Download MD5 sum: &tidy-md5sum;</para></listitem>
|
---|
42 | <listitem><para>Download size: &tidy-size;</para></listitem>
|
---|
43 | <listitem><para>Estimated disk space required:
|
---|
44 | &tidy-buildsize;</para></listitem>
|
---|
45 | <listitem><para>Estimated build time: &tidy-time;</para></listitem>
|
---|
46 | </itemizedlist>
|
---|
47 | </sect3>
|
---|
48 |
|
---|
49 | <sect3><title>Additional downloads</title>
|
---|
50 | <itemizedlist spacing="compact">
|
---|
51 | <listitem><para>Documentation: <ulink
|
---|
52 | url="http://tidy.sourceforge.net/docs/tidy_docs.tgz"/></para></listitem>
|
---|
53 | </itemizedlist>
|
---|
54 | </sect3>
|
---|
55 |
|
---|
56 | <sect3><title><application><acronym>HTML</acronym> Tidy</application>
|
---|
57 | dependencies</title>
|
---|
58 | <sect4><title>Optional</title>
|
---|
59 | <para><ulink url="http://dmalloc.com/">Dmalloc</ulink></para>
|
---|
60 | </sect4>
|
---|
61 | </sect3>
|
---|
62 |
|
---|
63 | </sect2>
|
---|
64 |
|
---|
65 | <sect2>
|
---|
66 | <title>Installation of <application><acronym>HTML</acronym>
|
---|
67 | Tidy</application></title>
|
---|
68 |
|
---|
69 | <para>The <application><acronym>HTML</acronym> Tidy</application> documentation
|
---|
70 | is contained in a separate tarball. Unpack both the source and docs tarballs
|
---|
71 | before starting the build.</para>
|
---|
72 |
|
---|
73 | <para>Install <application><acronym>HTML</acronym> Tidy</application> by
|
---|
74 | running the following commands:</para>
|
---|
75 |
|
---|
76 | <screen><userinput><command>sh build/gnuauto/setup.sh &&
|
---|
77 | ./configure --prefix=/usr &&
|
---|
78 | make &&
|
---|
79 | make install &&
|
---|
80 | install -m644 htmldoc/man_page.txt \
|
---|
81 | /usr/share/man/man1/tidy.1 &&
|
---|
82 | install -d -m755 /usr/share/doc/tidy &&
|
---|
83 | cp -R htmldoc /usr/share/doc/tidy &&
|
---|
84 | chown -R root:root /usr/share/doc/tidy</command></userinput></screen>
|
---|
85 |
|
---|
86 | </sect2>
|
---|
87 |
|
---|
88 | <sect2>
|
---|
89 | <title>Command explanations</title>
|
---|
90 |
|
---|
91 | <para><command>sh build/gnuauto/setup.sh</command>: This command prepares the
|
---|
92 | source tree for building using the <acronym>GNU</acronym> <quote>Auto</quote>
|
---|
93 | tools.</para>
|
---|
94 |
|
---|
95 | </sect2>
|
---|
96 |
|
---|
97 | <sect2>
|
---|
98 | <title>Configuring <application><acronym>HTML</acronym>
|
---|
99 | Tidy</application></title>
|
---|
100 |
|
---|
101 | <sect3><title>Config files</title>
|
---|
102 | <para>The absolute path of the file specified in
|
---|
103 | <envar>$HTML_TIDY</envar>.</para>
|
---|
104 | </sect3>
|
---|
105 |
|
---|
106 | <sect3><title>Configuration Information</title>
|
---|
107 |
|
---|
108 | <para>The default configuration options can be set in the file defined in
|
---|
109 | <envar>$HTML_TIDY</envar>. Additional configuration options can be passed to
|
---|
110 | <command>tidy</command> via command line parameters or the
|
---|
111 | <parameter>-config <file></parameter> parameter.</para>
|
---|
112 | </sect3>
|
---|
113 |
|
---|
114 | </sect2>
|
---|
115 |
|
---|
116 | <sect2>
|
---|
117 | <title>Contents</title>
|
---|
118 |
|
---|
119 | <segmentedlist>
|
---|
120 | <segtitle>Installed Programs</segtitle>
|
---|
121 | <segtitle>Installed Library</segtitle>
|
---|
122 | <segtitle>Installed Directory</segtitle>
|
---|
123 | <seglistitem>
|
---|
124 | <seg>tab2space and tidy</seg>
|
---|
125 | <seg>libtidy.[so,a]</seg>
|
---|
126 | <seg>/usr/share/doc/tidy</seg>
|
---|
127 | </seglistitem>
|
---|
128 | </segmentedlist>
|
---|
129 |
|
---|
130 | <variablelist>
|
---|
131 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
132 | <?dbfo list-presentation="list"?>
|
---|
133 |
|
---|
134 | <varlistentry id="tab2space">
|
---|
135 | <term><command>tab2space</command></term>
|
---|
136 | <listitem><para>is a utility to expand tabs and ensure consistent line
|
---|
137 | endings.</para>
|
---|
138 | <indexterm zone="html-tidy tab2space">
|
---|
139 | <primary sortas="b-tab2space">tab2space</primary></indexterm>
|
---|
140 | </listitem>
|
---|
141 | </varlistentry>
|
---|
142 |
|
---|
143 | <varlistentry id="tidy">
|
---|
144 | <term><command>tidy</command></term>
|
---|
145 | <listitem><para>validates, corrects, and pretty-prints <acronym>HTML</acronym>
|
---|
146 | files.</para>
|
---|
147 | <indexterm zone="html-tidy tidy">
|
---|
148 | <primary sortas="b-tidy">tidy</primary></indexterm>
|
---|
149 | </listitem>
|
---|
150 | </varlistentry>
|
---|
151 |
|
---|
152 | <varlistentry id="libtidy">
|
---|
153 | <term><filename class='libraryfile'>libtidy.[so,a]</filename></term>
|
---|
154 | <listitem><para>libraries provide the
|
---|
155 | <application><acronym>HTML</acronym> Tidy</application> <acronym>API</acronym>
|
---|
156 | functions to <command>tidy</command> and can also be called by other
|
---|
157 | programs.</para>
|
---|
158 | <indexterm zone="html-tidy libtidy">
|
---|
159 | <primary sortas="c-libtidy">libtidy.[so,a]</primary></indexterm>
|
---|
160 | </listitem>
|
---|
161 | </varlistentry>
|
---|
162 | </variablelist>
|
---|
163 |
|
---|
164 | </sect2>
|
---|
165 |
|
---|
166 | </sect1>
|
---|