source: general/genutils/tidy-html5.xml@ 24ac3c20

11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt plabs/newcss python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 24ac3c20 was 3f2db3a6, checked in by Pierre Labastie <pierre.labastie@…>, 19 months ago

Remove sect1info tags

They only contain a date tag that is nowhere used.

  • Property mode set to 100644
File size: 6.2 KB
RevLine 
[9766fba]1<?xml version="1.0" encoding="ISO-8859-1"?>
[6732c094]2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
[9766fba]4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
[59e19f73]7 <!ENTITY tidy-html5-download-http "https://github.com/htacg/tidy-html5/archive/&tidy-html5-version;/tidy-html5-&tidy-html5-version;.tar.gz">
[2b65035a]8 <!ENTITY tidy-html5-download-ftp " ">
[f249e1f]9 <!ENTITY tidy-html5-md5sum "0f6c55ef651e258adbe5750f555af50f">
10 <!ENTITY tidy-html5-size "992 KB">
[11759d2]11 <!ENTITY tidy-html5-buildsize "11 MB">
[dcff87e8]12 <!ENTITY tidy-html5-time "0.2 SBU">
[9766fba]13]>
14
[2b65035a]15<sect1 id="tidy-html5" xreflabel="tidy-html5-&tidy-html5-version;">
16 <?dbhtml filename="tidy-html5.html"?>
[85965ed]17
18
[2b65035a]19 <title>tidy-html5-&tidy-html5-version;</title>
[85965ed]20
[2b65035a]21 <indexterm zone="tidy-html5">
22 <primary sortas="a-Tidy-HTML5">Tidy HTML5</primary>
[c18d3b25]23 </indexterm>
24
25 <sect2 role="package">
[523c6e95]26 <title>Introduction to Tidy HTML5</title>
[85965ed]27
[b7a85cd9]28 <para>
29 The <application>Tidy HTML5</application> package contains a
30 command line tool and libraries used to read HTML, XHTML and XML files
31 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 W3C compliant and compatible with most browsers.
34 </para>
[85965ed]35
[48cb482]36 &lfs112_checked;
[50929e8]37
[c18d3b25]38 <bridgehead renderas="sect3">Package Information</bridgehead>
39 <itemizedlist spacing="compact">
40 <listitem>
[b7a85cd9]41 <para>
42 Download (HTTP): <ulink url="&tidy-html5-download-http;"/>
43 </para>
[c18d3b25]44 </listitem>
45 <listitem>
[b7a85cd9]46 <para>
47 Download (FTP): <ulink url="&tidy-html5-download-ftp;"/>
48 </para>
[c18d3b25]49 </listitem>
50 <listitem>
[b7a85cd9]51 <para>
52 Download MD5 sum: &tidy-html5-md5sum;
53 </para>
[c18d3b25]54 </listitem>
55 <listitem>
[b7a85cd9]56 <para>
57 Download size: &tidy-html5-size;
58 </para>
[c18d3b25]59 </listitem>
60 <listitem>
[b7a85cd9]61 <para>
62 Estimated disk space required: &tidy-html5-buildsize;
63 </para>
[c18d3b25]64 </listitem>
65 <listitem>
[b7a85cd9]66 <para>
67 Estimated build time: &tidy-html5-time;
68 </para>
[c18d3b25]69 </listitem>
70 </itemizedlist>
[b7a85cd9]71
[523c6e95]72 <bridgehead renderas="sect3">Tidy HTML5 Dependencies</bridgehead>
73
74 <bridgehead renderas="sect4">Required</bridgehead>
[b7a85cd9]75 <para role="required">
76 <xref linkend="cmake"/>
77 </para>
[523c6e95]78
79 <bridgehead renderas="sect4">Recommended</bridgehead>
[b7a85cd9]80 <para role="recommended">
81 <xref linkend="libxslt"/>
82 </para>
[85965ed]83
[1039de3]84 <para condition="html" role="usernotes">User Notes:
85 <ulink url="&blfs-wiki;/tidy"/></para>
86
[c18d3b25]87 </sect2>
[85965ed]88
[c18d3b25]89 <sect2 role="installation">
[523c6e95]90 <title>Installation of Tidy HTML5</title>
91
[b7a85cd9]92 <para>
93 Install <application>Tidy HTML5</application> by running the following
94 commands:
95 </para>
[c18d3b25]96
[523c6e95]97<screen><userinput>cd build/cmake &amp;&amp;
98
99cmake -DCMAKE_INSTALL_PREFIX=/usr \
100 -DCMAKE_BUILD_TYPE=Release \
101 -DBUILD_TAB2SPACE=ON \
102 ../.. &amp;&amp;
[c18d3b25]103
104make</userinput></screen>
[afd6889]105
[b7a85cd9]106 <para>
107 This package does not come with a test suite.
108 </para>
[7c43113]109
[b7a85cd9]110 <para>
111 Now, as the <systemitem class="username">root</systemitem> user:
[523c6e95]112 </para>
[85965ed]113
[f3eefa7]114<screen role="root"><userinput>make install &amp;&amp;
[b4ce81fd]115rm -fv /usr/lib/libtidy.a &amp;&amp;
[523c6e95]116install -v -m755 tab2space /usr/bin</userinput></screen>
[0124b3a]117
[c18d3b25]118 </sect2>
[85965ed]119
[22d9f68]120 <sect2 role="commands">
121 <title>Command Explanations</title>
122
[523c6e95]123 <para>
124 <parameter>-DCMAKE_BUILD_TYPE=Release</parameter>: This switch is used to
125 build the release library without any debug `assert` in the code.
126 </para>
127
128 <para>
129 <parameter>-DBUILD_TAB2SPACE=ON</parameter>: This switch is used to enable
130 building the <command>tab2space</command> utility.
131 </para>
[22d9f68]132
133 </sect2>
134
[c18d3b25]135 <sect2 role="configuration">
[523c6e95]136 <title>Configuring Tidy HTML5</title>
[c18d3b25]137
138 <sect3>
139 <title>Config Files</title>
[85965ed]140
[b7a85cd9]141 <para>
142 The absolute path of the file specified in <envar>HTML_TIDY</envar>.
143 </para>
[85965ed]144
[c18d3b25]145 </sect3>
146
147 <sect3>
148 <title>Configuration Information</title>
[85965ed]149
[b7a85cd9]150 <para>
151 The default configuration options can be set in the file defined in
152 <envar>HTML_TIDY</envar>. Additional configuration options can be
153 passed to <command>tidy</command> via command line parameters or the
154 <option>-config &lt;file&gt;</option> parameter.
155 </para>
[85965ed]156
[c18d3b25]157 </sect3>
[85965ed]158
[c18d3b25]159 </sect2>
[85965ed]160
[c18d3b25]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>
[b4ce81fd]170 <seg>libtidy.so</seg>
[2b65035a]171 <seg>/usr/share/doc/tidy-&tidy-html5-version;</seg>
[c18d3b25]172 </seglistitem>
173 </segmentedlist>
[85965ed]174
[c18d3b25]175 <variablelist>
176 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
177 <?dbfo list-presentation="list"?>
178 <?dbhtml list-presentation="table"?>
[85965ed]179
[c18d3b25]180 <varlistentry id="tab2space">
181 <term><command>tab2space</command></term>
182 <listitem>
[b7a85cd9]183 <para>
[4c24eb0a]184 is a utility to expand tabs and ensure consistent line endings
[b7a85cd9]185 </para>
[2b65035a]186 <indexterm zone="tidy-html5 tab2space">
[c18d3b25]187 <primary sortas="b-tab2space">tab2space</primary>
188 </indexterm>
189 </listitem>
190 </varlistentry>
[85965ed]191
[c18d3b25]192 <varlistentry id="tidy">
193 <term><command>tidy</command></term>
194 <listitem>
[b7a85cd9]195 <para>
[4c24eb0a]196 validates, corrects, and pretty-prints HTML files
[b7a85cd9]197 </para>
[2b65035a]198 <indexterm zone="tidy-html5 tidy">
[c18d3b25]199 <primary sortas="b-tidy">tidy</primary>
200 </indexterm>
201 </listitem>
202 </varlistentry>
[85965ed]203
[c18d3b25]204 <varlistentry id="libtidy">
[523c6e95]205 <term>
[b4ce81fd]206 <filename class="libraryfile">libtidy.so</filename>
[523c6e95]207 </term>
[c18d3b25]208 <listitem>
[b7a85cd9]209 <para>
210 library provides the <application>Tidy HTML5</application> API
211 functions to <command>tidy</command> and can also be called by other
[4c24eb0a]212 programs
[b7a85cd9]213 </para>
[2b65035a]214 <indexterm zone="tidy-html5 libtidy">
[22d9f68]215 <primary sortas="c-libtidy">libtidy.so</primary>
[c18d3b25]216 </indexterm>
217 </listitem>
218 </varlistentry>
[85965ed]219
[c18d3b25]220 </variablelist>
221
222 </sect2>
[9766fba]223
224</sect1>
Note: See TracBrowser for help on using the repository browser.