Ticket #179: corefilters_tidyfilter.diff

File corefilters_tidyfilter.diff, 1.8 kB (added by Markus Fischer <markus@fischer.name>, 8 months ago)

Documentation for TidyFilter

  • docs/phing_guide/book/chapters/appendixes/AppendixD2-CoreFilters.html

    old new  
    462462  </tbody> 
    463463</table> 
    464464 
     465<h2><a name="TidyFilter"></a>TidyFilter</h2> 
     466<p> 
     467The <em>TidyFilter</em> allows you to use the <a href="http://php.net/tidy">PHP 
     468tidy extension</a> to clean up and repeair HTML documents. Usage example: 
     469</p> 
     470<pre> 
     471&lt;filterchain&gt; 
     472  &lt;tidyfilter encoding=&quot;utf8&quot;&gt; 
     473    &lt;config name=&quot;indent&quot; value=&quot;true&quot; /&gt; 
     474    &lt;config name=&quot;output-xhtml&quot; value=&quot;true&quot; /&gt; 
     475  &lt;/tidyfilter&gt; 
     476&lt;/filterchain&gt; 
     477</pre> 
     478<h3>Attributes</h3> 
     479<table> 
     480  <caption> 
     481  Attributes for the <em>&lt;tidyfilter&gt;</em> tag 
     482  </caption> 
     483  <thead> 
     484    <tr> 
     485      <th>Name</th> 
     486      <th>Type</th> 
     487      <th>Description</th> 
     488      <th>Default</th> 
     489      <th>Required</th> 
     490    </tr> 
     491  </thead> 
     492  <tbody> 
     493    <tr> 
     494      <td>encoding</td> 
     495      <td>String</td> 
     496      <td> 
     497        The expected input encoding of the file. 
     498      </td> 
     499      <td>utf8</td> 
     500      <td>No</td> 
     501    </tr> 
     502  </tbody> 
     503</table> 
     504<h3>Nested Tags</h3> 
     505<p> 
     506The <em>TidyFilter</em> supports nested &lt;config&gt; tags to configure how 
     507Tidy should manipulate the documents. For a complete list of configuration 
     508options see the offical 
     509<a href="http://tidy.sourceforge.net/docs/quickref.html">Quick Reference</a>. 
     510</p> 
     511 
    465512<h2><a name="XincludeFilter"></a>XincludeFilter</h2> 
    466513<p> 
    467514The <em>XincludeFilter</em> processes a stream for Xinclude tags, and processes the inclusions.