Manual:$wgUseTidy

From MediaWiki.org
Jump to: navigation, search
Tidy: $wgUseTidy
Use tidy to make sure HTML output is sane.
Introduced in version: 1.3.0
Removed in version: still in use
Allowed values: (boolean)
Default value: false

Other settings: Alphabetical | By Function


Details[edit | edit source]

Use "HTML tidy" to make sure HTML output is sane.

HTML tidy is a free tool that fixes broken HTML. See Wikipedia:HTML tidy and http://www.w3.org/People/Raggett/tidy/

You may wish to setup this tool, and set $wgUseTidy=true, to ensure that the wiki outputs reasonably clean and compliant HTML, even when malicious or foolish users add corrupt/badly formatted HTML to wiki pages.

Note that MediaWiki already does some built-in checks and corrections to user's HTML, and limits the range of html tags and attributes which can be used (unless you set $wgRawHtml=true Dangerous!) Limitations are described at meta:Help:HTML in wikitext. The logic for this is found in includes/Sanitizer.php. As such, you may decide that running HTML tidy over the output is not necessary.

Note: HTML tidy will irreversibly and unexpectedly mangle standard HTML markup when it feels like it. For example, wikitext like [[Link|<div>Text</div>]] will not actually produce a clickable link. There are several dozen particular bugs identified that are likely never to be fixed (see bug 2542 and its list of blockers). If you enable Tidy, you're in for a world of hurt.

Configuration[edit | edit source]

The location of the tidy configuration file can be set using $wgTidyConf - before MediaWiki 1.10, this was required. In later versions, a working default is provided.

However, this may not always work: see $wgTidyInternal for some more installation information.

Effects[edit | edit source]

Tidy is still required to mix wiki table and html table syntax, as well as simple wikicode and html-style markup.

example code Parser without Tidy Tidy
Mixed nested tags.
{|
|| foo
<tr><td>bar</td></tr>
|}
<table>
<tr>
<td> foo
<p>&lt;tr&gt;&lt;td&gt;bar&lt;/td&gt;&lt;/tr&gt;</p>
</td></tr></table>
<table>
<tr><td>foo</td></tr>
<tr><td>bar</td></tr>
</table>
Mixed open/close tags.
'''foo</b>
<b>foo&lt;/b&gt;</b>
<b>foo</b>
Definition list nesting
; hi
:# one
<dl><dt> hi
<ol><li> one</li></ol>
</dt></dl>
<dl><dt>hi</dt><dd>
<ol><li>one</li></ol>
</dd></dl>

Tidy can correct most bad HTML, which can be bad user input like <table><tr></td></table> or conflicting or badly written extensions (and even some bugs in the core software). However, it does not resolve all strict XHTML validation issues, such as duplicate xml ID attribute values, or IDs starting with numbers.

See also[edit | edit source]

Language: English  • 日本語