1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY tidy-download-http "https://github.com/htacg/tidy-html5/archive/&tidy-version;.tar.gz">
|
---|
8 | <!ENTITY tidy-download-ftp " ">
|
---|
9 | <!ENTITY tidy-md5sum "5fd96deef635ab8cea3dc74079f54d95">
|
---|
10 | <!ENTITY tidy-size "632 KB">
|
---|
11 | <!ENTITY tidy-buildsize "16 MB">
|
---|
12 | <!ENTITY tidy-time "0.1 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="tidy-html" xreflabel="tidy-html5-&tidy-version;">
|
---|
16 | <?dbhtml filename="tidy.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | </sect1info>
|
---|
22 |
|
---|
23 | <title>tidy-html5-&tidy-version;</title>
|
---|
24 |
|
---|
25 | <indexterm zone="tidy-html">
|
---|
26 | <primary sortas="a-Tidy-HTML">Tidy HTML5</primary>
|
---|
27 | </indexterm>
|
---|
28 |
|
---|
29 | <sect2 role="package">
|
---|
30 | <title>Introduction to Tidy HTML5</title>
|
---|
31 |
|
---|
32 | <para>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.</para>
|
---|
37 |
|
---|
38 | &lfs78_checked;
|
---|
39 |
|
---|
40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
41 | <itemizedlist spacing="compact">
|
---|
42 | <listitem>
|
---|
43 | <para>Download (HTTP): <ulink url="&tidy-download-http;"/></para>
|
---|
44 | </listitem>
|
---|
45 | <listitem>
|
---|
46 | <para>Download (FTP): <ulink url="&tidy-download-ftp;"/></para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>Download MD5 sum: &tidy-md5sum;</para>
|
---|
50 | </listitem>
|
---|
51 | <listitem>
|
---|
52 | <para>Download size: &tidy-size;</para>
|
---|
53 | </listitem>
|
---|
54 | <listitem>
|
---|
55 | <para>Estimated disk space required: &tidy-buildsize;</para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>Estimated build time: &tidy-time;</para>
|
---|
59 | </listitem>
|
---|
60 | </itemizedlist>
|
---|
61 |
|
---|
62 | <note>
|
---|
63 | <para>
|
---|
64 | <application>Tidy HTML5</application> source tarball shown above
|
---|
65 | downloads with the correct name tidy-html5-&tidy-version;.tar.gz, if
|
---|
66 | using a browser such as Firefox. If you prefer to use a command line
|
---|
67 | program, such as wget, you obtain &tidy-version;.tar.gz. To
|
---|
68 | change the filename, run: <command>mv -vi
|
---|
69 | &tidy-version;.tar.gz tidy-html5-&tidy-version;.tar.gz</command>.
|
---|
70 | </para>
|
---|
71 | </note>
|
---|
72 |
|
---|
73 | <bridgehead renderas="sect3">Tidy HTML5 Dependencies</bridgehead>
|
---|
74 |
|
---|
75 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
76 | <para role="required"><xref linkend="cmake"/></para>
|
---|
77 |
|
---|
78 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
79 | <para role="recommended"><xref linkend="libxslt"/></para>
|
---|
80 |
|
---|
81 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
82 | <para role="optional"><xref linkend="doxygen"/></para>
|
---|
83 |
|
---|
84 | <para condition="html" role="usernotes">User Notes:
|
---|
85 | <ulink url="&blfs-wiki;/tidy"/></para>
|
---|
86 |
|
---|
87 | </sect2>
|
---|
88 |
|
---|
89 | <sect2 role="installation">
|
---|
90 | <title>Installation of Tidy HTML5</title>
|
---|
91 |
|
---|
92 | <para>Install <application>Tidy HTML5</application> by running the following
|
---|
93 | commands:</para>
|
---|
94 |
|
---|
95 | <screen><userinput>cd build/cmake &&
|
---|
96 |
|
---|
97 | cmake -DCMAKE_INSTALL_PREFIX=/usr \
|
---|
98 | -DCMAKE_BUILD_TYPE=Release \
|
---|
99 | -DBUILD_TAB2SPACE=ON \
|
---|
100 | ../.. &&
|
---|
101 |
|
---|
102 | make</userinput></screen>
|
---|
103 |
|
---|
104 | <para>This package does not come with a test suite.</para>
|
---|
105 |
|
---|
106 | <para>Now, as the <systemitem class="username">root</systemitem> user:
|
---|
107 | </para>
|
---|
108 |
|
---|
109 | <screen role="root"><userinput>make install &&
|
---|
110 | install -v -m755 tab2space /usr/bin</userinput></screen>
|
---|
111 |
|
---|
112 | <para>If you wish to install the API documentation you must have <xref
|
---|
113 | linkend="doxygen"/> installed, then change directories into the <filename
|
---|
114 | class='directory'>documentation</filename> directory of the source tree and
|
---|
115 | issue the command <command>doxygen doxygen.cfg</command>. Then as the
|
---|
116 | <systemitem class="username">root</systemitem> user copy the <filename
|
---|
117 | class='directory'>documentation/temp/tidylib_api</filename> directory to
|
---|
118 | <filename
|
---|
119 | class='directory'>/usr/share/doc/tidy-&tidy-version;.</filename></para>
|
---|
120 |
|
---|
121 | </sect2>
|
---|
122 |
|
---|
123 | <sect2 role="commands">
|
---|
124 | <title>Command Explanations</title>
|
---|
125 |
|
---|
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>
|
---|
135 |
|
---|
136 | </sect2>
|
---|
137 |
|
---|
138 | <sect2 role="configuration">
|
---|
139 | <title>Configuring Tidy HTML5</title>
|
---|
140 |
|
---|
141 | <sect3>
|
---|
142 | <title>Config Files</title>
|
---|
143 |
|
---|
144 | <para>The absolute path of the file specified in
|
---|
145 | <envar>$HTML_TIDY</envar>.</para>
|
---|
146 |
|
---|
147 | </sect3>
|
---|
148 |
|
---|
149 | <sect3>
|
---|
150 | <title>Configuration Information</title>
|
---|
151 |
|
---|
152 | <para>The default configuration options can be set in the file defined in
|
---|
153 | <envar>$HTML_TIDY</envar>. Additional configuration options can be passed
|
---|
154 | to <command>tidy</command> via command line parameters or the
|
---|
155 | <option>-config <file></option> parameter.</para>
|
---|
156 |
|
---|
157 | </sect3>
|
---|
158 |
|
---|
159 | </sect2>
|
---|
160 |
|
---|
161 | <sect2 role="content">
|
---|
162 | <title>Contents</title>
|
---|
163 |
|
---|
164 | <segmentedlist>
|
---|
165 | <segtitle>Installed Programs</segtitle>
|
---|
166 | <segtitle>Installed Library</segtitle>
|
---|
167 | <segtitle>Installed Directory</segtitle>
|
---|
168 | <seglistitem>
|
---|
169 | <seg>tab2space and tidy</seg>
|
---|
170 | <seg>libtidy.so and libtidys.a</seg>
|
---|
171 | <seg>/usr/share/doc/tidy-&tidy-version;</seg>
|
---|
172 | </seglistitem>
|
---|
173 | </segmentedlist>
|
---|
174 |
|
---|
175 | <variablelist>
|
---|
176 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
177 | <?dbfo list-presentation="list"?>
|
---|
178 | <?dbhtml list-presentation="table"?>
|
---|
179 |
|
---|
180 | <varlistentry id="tab2space">
|
---|
181 | <term><command>tab2space</command></term>
|
---|
182 | <listitem>
|
---|
183 | <para>is a utility to expand tabs and ensure consistent line
|
---|
184 | endings.</para>
|
---|
185 | <indexterm zone="tidy-html tab2space">
|
---|
186 | <primary sortas="b-tab2space">tab2space</primary>
|
---|
187 | </indexterm>
|
---|
188 | </listitem>
|
---|
189 | </varlistentry>
|
---|
190 |
|
---|
191 | <varlistentry id="tidy">
|
---|
192 | <term><command>tidy</command></term>
|
---|
193 | <listitem>
|
---|
194 | <para>validates, corrects, and pretty-prints HTML files.</para>
|
---|
195 | <indexterm zone="tidy-html tidy">
|
---|
196 | <primary sortas="b-tidy">tidy</primary>
|
---|
197 | </indexterm>
|
---|
198 | </listitem>
|
---|
199 | </varlistentry>
|
---|
200 |
|
---|
201 | <varlistentry id="libtidy">
|
---|
202 | <term>
|
---|
203 | <filename class='libraryfile'>libtidy.so and libtidys.a</filename>
|
---|
204 | </term>
|
---|
205 | <listitem>
|
---|
206 | <para>library provides the <application>Tidy HTML5</application> API
|
---|
207 | functions to <command>tidy</command> and can also be called by other
|
---|
208 | programs.</para>
|
---|
209 | <indexterm zone="tidy-html libtidy">
|
---|
210 | <primary sortas="c-libtidy">libtidy.so</primary>
|
---|
211 | </indexterm>
|
---|
212 | </listitem>
|
---|
213 | </varlistentry>
|
---|
214 |
|
---|
215 | </variablelist>
|
---|
216 |
|
---|
217 | </sect2>
|
---|
218 |
|
---|
219 | </sect1>
|
---|