About HTML Tidy

It's very easy to make mistakes when editing HTML documents. It's difficult to fix these mistakes automatically and sometimes even harder to tidy up sloppy editing. Dave Raggett's HTML Tidy utility has been designed to make these tasks quick and painless. HTML Tidy works great on the hard to read markup generated by specialized HTML editors and conversion tools and can help you identify where you need to pay further attention on making your pages more accessible to people with disabilities.

 Running Tidy

To run Tidy with the current settings in this dialog, press the Run HTML Tidy Using Above Settings button.

Tidy will modify your document and display processing results in the Results sidebar with the line number and column so that you can see where the problems lie in your markup.

 Configuring Tidy

Tidy can be configured a number of different ways using the many options it makes available. Please set the options below to your liking and press the Save button to save them to a file. Once the settings are saved, they can be loaded again using the Load button.

Remember to declare tags Tidy doesn't recognize in the Custom Tags section below. Unless you declare new tags, Tidy will refuse to generate a tidied file if the input includes unknown tags.

 Settings

General Options | Document Information Options | XML Flags | Tab and Indent Options | Wrapping Options | Formatting Options | Custom Tags

 General Options

markup
Determines whether Tidy generates a pretty printed version of the markup. Bool values are either yes or no. Note that Tidy won't generate a pretty printed version if it finds unknown tags, or missing trailing quotes on attribute values, or missing trailing '>' on tags. The default is yes.

show-warnings
If set to no, warnings are suppressed. This can be useful when a few errors are hidden in a flurry of warnings. The default is yes.

hide-endtags
If set to yes, optional end-tags will be omitted when generating the pretty printed markup. This option is ignored if you are outputting to XML. The default is no.

Back to Settings.

 Document Information Options

doctype:
This property controls the doctype declaration generated by Tidy. If set to omit the output file won't contain a doctype declaration. If set to auto (the default) Tidy will use an educated guess based upon the contents of the document. If set to strict, Tidy will set the doctype to the strict DTD. If set to loose, the doctype is set to the loose (transitional) DTD.

char-encoding:
Determines how Tidy interprets character streams. For ascii, Tidy will accept Latin-1 character values, but will use entities for all characters whose value > 127. For raw, Tidy will output values above 127 without translating them into entities. For latin1 characters above 255 will be written as entities. For utf8, Tidy assumes that both input and output is encoded as UTF-8. You can use iso2022 for files encoded using the ISO2022 family of encodings e.g. ISO 2022-JP. The default is ascii.

tidy-mark
If set to yes (the default) Tidy will add a meta element to the document head to indicate that the document has been tidied. To suppress this, set tidy-mark to no. Tidy won't add a meta element if one is already present.

Back to Settings.

 XML Flags

input-xml
If set to yes, Tidy will use the XML parser rather than the error correcting HTML parser. The default is no.

output-xml
If set to yes, Tidy will use generate the pretty printed output writing it as well-formed XML. Any entities not defined in XML 1.0 will be written as numeric entities to allow them to be parsed by an XML parser. The tags and attributes will be in the case used in the input document, regardless of other options. The default is no.

add-xml-pi

add-xml-decl
If set to yes, Tidy will add the XML declatation when outputting XML or XHTML. The default is no. Note that if the input document includes an <?xml?> declaration then it will appear in the output independent of the value of this option.

output-xhtml
If set to yes, Tidy will generate the pretty printed output writing it as extensible HTML. The default is no. This option causes Tidy to set the doctype and default namespace as appropriate to XHTML. If a doctype or namespace is given they will checked for consistency with the content of the document. In the case of an inconsistency, the corrected values will appear in the output. For XHTML, entities can be written as named or numeric entities according to the value of the "numeric-entities" property. The tags and attributes will be output in the case used in the input document, regardless of other options.

Back to Settings.

 Tab and Indent Options

tab-size:
Sets the number of columns between successive tab stops. The default is 4. It is used to map tabs to spaces when reading files. Tidy never outputs files with tabs.

indent:
If set to yes Tidy will indent block-level tags. The default is no. If set to auto Tidy will decide whether or not to indent the content of tags such as title, h1-h6, li, td, th, or p depending on whether or not the content includes a block-level element. You are advised to avoid setting indent to yes as this can expose layout bugs in some browsers.

indent-spaces:
Sets the number of spaces to indent content when indentation is enabled. The default is 2 spaces.

indent-attributes
If set to yes, each attribute will begin on a new line. The default is no.

Back to Settings.

 Wrapping Options

wrap:
Sets the right margin for line wrapping. Tidy tries to wrap lines so that they do not exceed this length. The default is 0. Set wrap to zero if you want to disable line wrapping.

wrap-attributes
If set to yes, attribute values may be wrapped across lines for easier editing. The default is no. This option can be set independently of wrap-scriptlets

wrap-script-literals
If set to yes, this allows lines to be wrapped within string literals that appear in script attributes. The default is no. The example shows how Tidy wraps a really really long script string literal inserting a backslash character before the linebreak:

<a href="somewhere.html" onmouseover="document.status = '...some \
really, really, really, really, really, really, really, really, \
really, really long string..';">test</a>

wrap-asp
If set to no, this prevents lines from being wrapped within ASP pseudo elements, which look like: <% ... %>. The default is yes.

wrap-jste
If set to no, this prevents lines from being wrapped within JSTE pseudo elements, which look like: <# ... #>. The default is yes.

wrap-php
If set to no, this prevents lines from being wrapped within PHP pseudo elements. The default is yes.

Back to Settings.

 Formatting Options

numeric-entities
Causes entities other than the basic XML 1.0 named entities to be written in the numeric rather than the named entity form. The default is no.

quote-marks
If set to yes, this causes " characters to be written out as &quot; as is preferred by some editing environments. The apostrophe character ' is written out as &#39; since many web browsers don't yet support &apos;. The default is no.

quote-nbsp
If set, this causes non-breaking space characters to be written out as entities. The default is yes.

quote-ampersand
If set to yes, this causes unadorned & characters to be written out as &amp;. The default is yes.

assume-xml-procins
If set to yes, this changes the parsing of processing instructions to require ?> as the terminator rather than >. The default is no. This option is automatically set if the input is in XML.

fix-backslash
If set to yes, this causes backslash characters "\" in URLs to be replaced by forward slashes "/". The default is yes.

break-before-br
If set, Tidy will output a line break before each <br> element. The default is no.

uppercase-tags
Causes tag names to be output in upper case. The default is no resulting in lowercase, except for XML input where the original case is preserved.

uppercase-attributes
Causes attribute names to be output in upper case. The default is no resulting in lowercase, except for XML where the original case is preserved.

word-2000
If set, Tidy will go to great pains to strip out all the surplus stuff Microsoft Word 2000 inserts when you save Word documents as "Web pages". The default is no. Note that Tidy doesn't yet know what to do with VML markup from Word, but in future I hope to be able to map VML to SVG.

Microsoft has developed its own optional filter for exporting to HTML, and the 2.0 version is much improved. You can download the filter free from the Microsoft Office Update site.

clean
If set, causes Tidy to strip out surplus presentational tags and attributes replacing them by style rules and structural markup as appropriate. It works well on the html saved from Microsoft Office'97. The default is no.

logical-emphasis
If set, causes Tidy to replace any occurrence of i by em and any occurrence of b by strong. In both cases, the attributes are preserved unchanged. The default is no. This option can now be set independently of the clean and drop-font-tags options.

drop-empty-paras
If set to yes, empty paragraphs will be discarded. If set to no, empty paragraphs are replaced by a pair of br elements as HTML4 precludes empty paragraphs. The default is yes.

drop-font-tags
If set together with the clean option (see above), Tidy will discard font and center tags rather than creating the corresponding style rules. The default is no.

enclose-text
If set, this causes Tidy to enclose any text it finds in the body element within a p element. This is useful when you want to take an existing html file and use it with a style sheet. Any text at the body level will screw up the margins, but wrap the text within a p element and all is well! The default is no.

enclose-block-text
If set, this causes Tidy to insert a p element to enclose any text it finds in any element that allows mixed content for HTML transitional but not HTML strict. The default is no.

fix-bad-comments
If set, this causes Tidy to replace unexpected hyphens with "=" characters when it comes across adjacent hyphens. The default is yes. This option is provided for users of Cold Fusion which uses the comment syntax: <!--- --->

alt-text:
This allows you to set the default alt text for img attributes. This feature is dangerous as it suppresses further accessibility warnings. YOU ARE RESPONSIBLE FOR MAKING YOUR DOCUMENTS ACCESSIBLE TO PEOPLE WHO CAN'T SEE THE IMAGES!!!

Back to Settings.

 Custom Tags

new-empty-tags:

Use this to declare new empty inline tags. The option takes a space or comma separated list of tag names. Unless you declare new tags, Tidy will refuse to generate a tidied file if the input includes previously unknown tags. Remember to also declare empty tags as either inline or blocklevel, see below.

new-inline-tags:

Use this to declare new non-empty inline tags. The option takes a space or comma separated list of tag names. Unless you declare new tags, Tidy will refuse to generate a tidied file if the input includes previously unknown tags.

new-blocklevel-tags:

Use this to declare new block-level tags. The option takes a space or comma separated list of tag names. Unless you declare new tags, Tidy will refuse to generate a tidied file if the input includes previously unknown tags. Note you can't change the content model for elements such as table, ul, ol and dl. This is explained in more detail in the release notes.

new-pre-tags:

Use this to declare new tags that are to be processed in exactly the same way as HTML's pre element. The option takes a space or comma separated list of tag names. Unless you declare new tags, Tidy will refuse to generate a tidied file if the input includes previously unknown tags. Note you can't as yet add new CDATA elements (similar to script).

Back to Settings.

 Credits

Spider Writer HTML Tidy Interface
     Copyright (c) 2000-2001 Actipro Software LLC

HTML Tidy
     Written by Dave Raggett
     Copyright (c) 1998-2000 World Wide Web Consortium

The above setting descriptions were taken from the HTML Tidy documentation.
Visit http://www.w3.org/People/Raggett/tidy/ for the latest version of HTML Tidy.

Back to top.