Beyond Linux® From Scratch - Version 8.0

Chapter 11. General Utilities

tidy-html5-5.2.0

Introduction to Tidy HTML5

The Tidy HTML5 package contains a command line tool and libraries used to read HTML, XHTML and XML files and write cleaned up markup. It detects and corrects many common coding errors and strives to produce visually equivalent markup that is both W3C compliant and compatible with most browsers.

This package is known to build and work properly using an LFS-8.0 platform.

Package Information

[Note]

Note

The Tidy HTML5 source tarball shown above downloads with the correct name, tidy-html5-5.2.0.tar.gz, if using a browser such as Firefox. If you prefer to use a command line program such as wget, you normally would obtain 5.2.0.tar.gz. To obtain this package with the proper filename, run: 

wget -c https://github.com/htacg/tidy-html5/archive/5.2.0.tar.gz \
     -O tidy-html5-5.2.0.tar.gz

Tidy HTML5 Dependencies

Required

CMake-3.7.2

Recommended

libxslt-1.1.29

Optional

Doxygen-1.8.13

User Notes: http://wiki.linuxfromscratch.org/blfs/wiki/tidy

Installation of Tidy HTML5

Install Tidy HTML5 by running the following commands: 

cd build/cmake &&

cmake -DCMAKE_INSTALL_PREFIX=/usr \
      -DCMAKE_BUILD_TYPE=Release  \
      -DBUILD_TAB2SPACE=ON        \
      ../..    &&

make

This package does not come with a test suite.

Now, as the root user: 

make install &&
install -v -m755 tab2space /usr/bin

If you wish to install the API documentation you must have Doxygen-1.8.13 installed, then change directories into the documentation directory of the source tree and issue the command doxygen doxygen.cfg. Then as the root user copy the documentation/temp/tidylib_api directory to /usr/share/doc/tidy-5.2.0.

Command Explanations

-DCMAKE_BUILD_TYPE=Release: This switch is used to build the release library without any debug `assert` in the code.

-DBUILD_TAB2SPACE=ON: This switch is used to enable building the tab2space utility.

Configuring Tidy HTML5

Config Files

The absolute path of the file specified in $HTML_TIDY.

Configuration Information

The default configuration options can be set in the file defined in $HTML_TIDY. Additional configuration options can be passed to tidy via command line parameters or the -config <file> parameter.

Contents

Installed Programs: tab2space and tidy
Installed Library: libtidy.so and libtidys.a
Installed Directory: /usr/share/doc/tidy-5.2.0

Short Descriptions

tab2space

is a utility to expand tabs and ensure consistent line endings.

tidy

validates, corrects, and pretty-prints HTML files.

libtidy.so and libtidys.a

library provides the Tidy HTML5 API functions to tidy and can also be called by other programs.

Last updated on 2017-02-14 19:04:01 -0800