source: general/genutils/tidy-html5.xml@ 45ab6c7

11.0 qt5new trunk
Last change on this file since 45ab6c7 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 5 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

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