sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

WS, prepare for new doc style

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@249387 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2007-12-30 00:34:38 +00:00
parent 65206b229b
commit 7439959e0b
42 changed files with 1178 additions and 1262 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

66
reference/tidy/functions/ob-tidyhandler.xml
View file

@ -1,27 +1,25 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.ob-tidyhandler" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ob_tidyhandler</refname>
<refpurpose>
ob_start callback function to repair the buffer
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>ob_tidyhandler</methodname>
<methodparam><type>string</type><parameter>input</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
<function>ob_tidyhandler</function> is intended to be used as a
callback function for <function>ob_start</function> to repair the buffer.
</para>
<para>
<example>
<title><function>ob_tidyhandler</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.ob-tidyhandler" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ob_tidyhandler</refname>
<refpurpose>ob_start callback function to repair the buffer</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>ob_tidyhandler</methodname>
<methodparam><type>string</type><parameter>input</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam>
</methodsynopsis>
<para>
<function>ob_tidyhandler</function> is intended to be used as a
callback function for <function>ob_start</function> to repair the buffer.
</para>
<para>
<example>
<title><function>ob_tidyhandler</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
ob_start('ob_tidyhandler');
@ -29,9 +27,9 @@ ob_start('ob_tidyhandler');
echo '<p>test</i>';
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
@ -43,14 +41,14 @@ echo '<p>test</i>';
</body>
</html>
]]>
</screen>
</example>
</para>
<para>
See also <function>ob_start</function>.
</para>
</refsect1>
</refentry>
</screen>
</example>
</para>
<para>
See also <function>ob_start</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

78
reference/tidy/functions/tidy-access-count.xml
View file

@ -1,35 +1,33 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.tidy-access-count" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_access_count</refname>
<refpurpose>
Returns the Number of Tidy accessibility warnings encountered for specified document
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>tidy_access_count</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_access_count</function> returns the number of
accessibility warnings found for the specified document.
</para>
<note>
<para>
Due to the design of the TidyLib, you must call
<function>tidy_diagnose</function> before
<function>tidy_access_count</function> or it will return always
<literal>0</literal>. You must also need to enable the
<literal>accessibility-check</literal> option.
</para>
</note>
<para>
<example>
<title><function>tidy_access_count</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.tidy-access-count" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_access_count</refname>
<refpurpose>Returns the Number of Tidy accessibility warnings encountered for specified document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>tidy_access_count</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_access_count</function> returns the number of
accessibility warnings found for the specified document.
</para>
<note>
<para>
Due to the design of the TidyLib, you must call
<function>tidy_diagnose</function> before
<function>tidy_access_count</function> or it will return always
<literal>0</literal>. You must also need to enable the
<literal>accessibility-check</literal> option.
</para>
</note>
<para>
<example>
<title><function>tidy_access_count</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -56,15 +54,15 @@ echo tidy_access_count($tidy); //5
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>tidy_error_count</function> and
<function>tidy_warning_count</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<para>
See also <function>tidy_error_count</function> and
<function>tidy_warning_count</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

78
reference/tidy/functions/tidy-clean-repair.xml
View file

@ -1,32 +1,30 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.tidy-clean-repair" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_clean_repair</refname>
<refpurpose>
Execute configured cleanup and repair operations on parsed markup
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>tidy_clean_repair</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>bool</type><methodname>tidy->cleanRepair</methodname>
<void />
</methodsynopsis>
<para>
This function cleans and repairs the given tidy
<parameter>object</parameter>.
</para>
<para>
<example>
<title><function>tidy_clean_repair</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.tidy-clean-repair" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_clean_repair</refname>
<refpurpose>Execute configured cleanup and repair operations on parsed markup</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>tidy_clean_repair</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>bool</type><methodname>tidy->cleanRepair</methodname>
<void />
</methodsynopsis>
<para>
This function cleans and repairs the given tidy
<parameter>object</parameter>.
</para>
<para>
<example>
<title><function>tidy_clean_repair</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$html = '<p>test</I>';
@ -37,9 +35,9 @@ tidy_clean_repair($tidy);
echo $tidy;
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
@ -51,15 +49,15 @@ echo $tidy;
</body>
</html>
]]>
</screen>
</example>
</para>
<para>
See also <function>tidy_repair_file</function> and
<function>tidy_repair_string</function>.
</para>
</refsect1>
</refentry>
</screen>
</example>
</para>
<para>
See also <function>tidy_repair_file</function> and
<function>tidy_repair_string</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

54
reference/tidy/functions/tidy-config-count.xml
View file

@ -1,27 +1,25 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.tidy-config-count" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_config_count</refname>
<refpurpose>
Returns the Number of Tidy configuration errors encountered for specified document
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>tidy_config_count</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_config_count</function> returns the number of errors
encountered in the configuration of the specified tidy
<parameter>object</parameter>.
</para>
<para>
<example>
<title><function>tidy_config_count</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.tidy-config-count" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_config_count</refname>
<refpurpose>Returns the Number of Tidy configuration errors encountered for specified document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>tidy_config_count</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_config_count</function> returns the number of errors
encountered in the configuration of the specified tidy
<parameter>object</parameter>.
</para>
<para>
<example>
<title><function>tidy_config_count</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$html = '<p>test</I>';
@ -34,11 +32,11 @@ $tidy = tidy_parse_string($html, $config);
echo tidy_config_count($tidy);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

82
reference/tidy/functions/tidy-construct.xml
View file

@ -1,34 +1,32 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.tidy-construct" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy::__construct</refname>
<refpurpose>
Constructs a new tidy object
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>tidy</type><methodname>tidy::__construct</methodname>
<methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy::__construct</function> constructs a new tidy object.
</para>
<para>
If the <parameter>filename</parameter> parameter is given, this function
will also read that file and initialize the object with the file,
acting like <function>tidy_parse_file</function>.
</para>
&tidy.conf-enc;
<para>
<example>
<title><function>tidy::__construct</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.tidy-construct" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy::__construct</refname>
<refpurpose>Constructs a new tidy object</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>tidy</type><methodname>tidy::__construct</methodname>
<methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy::__construct</function> constructs a new tidy object.
</para>
<para>
If the <parameter>filename</parameter> parameter is given, this function
will also read that file and initialize the object with the file,
acting like <function>tidy_parse_file</function>.
</para>
&tidy.conf-enc;
<para>
<example>
<title><function>tidy::__construct</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -58,23 +56,23 @@ if ($tidy->errorBuffer) {
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
The following errors were detected:
line 8 column 14 - Error: <bt> is not recognized!
line 8 column 14 - Warning: discarding unexpected <bt>
]]>
</screen>
</example>
</para>
<para>
See also <function>tidy_parse_file</function> and
<function>tidy_parse_string</function>.
</para>
</refsect1>
</refentry>
</screen>
</example>
</para>
<para>
See also <function>tidy_parse_file</function> and
<function>tidy_parse_string</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

84
reference/tidy/functions/tidy-diagnose.xml
View file

@ -1,36 +1,34 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.tidy-diagnose" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_diagnose</refname>
<refpurpose>
Run configured diagnostics on parsed and repaired markup
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>tidy_diagnose</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>bool</type><methodname>tidy->diagnose</methodname>
<void />
</methodsynopsis>
<para>
<function>tidy_diagnose</function> runs diagnostic tests on the given
tidy <parameter>object</parameter>, adding some more information about
the document in the error buffer.
</para>
<para>
&return.success;
</para>
<para>
<example>
<title><function>tidy_diagnose</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.tidy-diagnose" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_diagnose</refname>
<refpurpose>Run configured diagnostics on parsed and repaired markup</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>tidy_diagnose</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>bool</type><methodname>tidy->diagnose</methodname>
<void />
</methodsynopsis>
<para>
<function>tidy_diagnose</function> runs diagnostic tests on the given
tidy <parameter>object</parameter>, adding some more information about
the document in the error buffer.
</para>
<para>
&return.success;
</para>
<para>
<example>
<title><function>tidy_diagnose</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -52,9 +50,9 @@ echo tidy_get_error_buffer($tidy);
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
line 5 column 1 - Warning: <p> isn't allowed in <head> elements
line 5 column 1 - Warning: inserting missing 'title' element
@ -65,14 +63,14 @@ Info: Doctype given is "-//W3C//DTD XHTML 1.0 Strict//EN"
Info: Document content looks like XHTML 1.0 Strict
2 warnings, 0 errors were found!
]]>
</screen>
</example>
</para>
<para>
See also <function>tidy_get_error_buffer</function>.
</para>
</refsect1>
</refentry>
</screen>
</example>
</para>
<para>
See also <function>tidy_get_error_buffer</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

66
reference/tidy/functions/tidy-error-count.xml
View file

@ -1,26 +1,24 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.tidy-error-count" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_error_count</refname>
<refpurpose>
Returns the Number of Tidy errors encountered for specified document
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>tidy_error_count</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_error_count</function> returns the number of Tidy errors
encountered for the specified document.
</para>
<para>
<example>
<title><function>tidy_error_count</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.tidy-error-count" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_error_count</refname>
<refpurpose>Returns the Number of Tidy errors encountered for specified document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>tidy_error_count</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_error_count</function> returns the number of Tidy errors
encountered for the specified document.
</para>
<para>
<example>
<title><function>tidy_error_count</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$html = '<p>test</i>
@ -33,9 +31,9 @@ echo tidy_error_count($tidy) . "\n"; //1
echo $tidy->errorBuffer;
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
1
line 1 column 1 - Warning: missing <!DOCTYPE> declaration
@ -45,15 +43,15 @@ line 2 column 1 - Warning: discarding unexpected <bogustag>
line 2 column 16 - Warning: discarding unexpected </bogustag>
line 1 column 1 - Warning: inserting missing 'title' element
]]>
</screen>
</example>
</para>
<para>
See also <function>tidy_access_count</function> and
<function>tidy_warning_count</function>.
</para>
</refsect1>
</refentry>
</screen>
</example>
</para>
<para>
See also <function>tidy_access_count</function> and
<function>tidy_warning_count</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

80
reference/tidy/functions/tidy-get-body.xml
View file

@ -1,32 +1,30 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.tidy-get-body" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_get_body</refname>
<refpurpose>
Returns a tidyNode Object starting from the &lt;body&gt; tag of the tidy parse tree
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>tidyNode</type><methodname>tidy_get_body</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>tidyNode</type><methodname>tidy->body</methodname>
<void />
</methodsynopsis>
<para>
This function returns a tidyNode object starting from the &lt;body&gt;
tag of the tidy parse tree.
</para>
<para>
<example>
<title><function>tidy_get_body</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.10 $ -->
<refentry xml:id="function.tidy-get-body" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_get_body</refname>
<refpurpose>Returns a tidyNode Object starting from the &lt;body&gt; tag of the tidy parse tree</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>tidyNode</type><methodname>tidy_get_body</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>tidyNode</type><methodname>tidy->body</methodname>
<void />
</methodsynopsis>
<para>
This function returns a tidyNode object starting from the &lt;body&gt;
tag of the tidy parse tree.
</para>
<para>
<example>
<title><function>tidy_get_body</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$html = '
@ -45,24 +43,24 @@ $body = tidy_get_body($tidy);
echo $body->value;
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
<body>
<p>paragraph</p>
</body>
]]>
</screen>
</example>
</para>
&note.tidy.ze2;
<para>
See also <function>tidy_get_head</function> and
<function>tidy_get_html</function>.
</para>
</refsect1>
</refentry>
</screen>
</example>
</para>
&note.tidy.ze2;
<para>
See also <function>tidy_get_head</function> and
<function>tidy_get_html</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

186
reference/tidy/functions/tidy-get-config.xml
View file

@ -1,37 +1,35 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.tidy-get-config" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>tidy_get_config</refname>
<refpurpose>
Get current Tidy configuration
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>array</type><methodname>tidy_get_config</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>array</type><methodname>tidy->getConfig</methodname>
<void />
</methodsynopsis>
<para>
<function>tidy_get_config</function> returns an array with the
configuration options in use by the given tidy
<parameter>object</parameter>.
</para>
<para>
For an explanation about each option, visit <link
xlink:href="&url.tidy.conf;">&url.tidy.conf;</link>.
</para>
<para>
<example>
<title><function>tidy_get_config</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.tidy-get-config" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>tidy_get_config</refname>
<refpurpose>Get current Tidy configuration</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>array</type><methodname>tidy_get_config</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>array</type><methodname>tidy->getConfig</methodname>
<void />
</methodsynopsis>
<para>
<function>tidy_get_config</function> returns an array with the
configuration options in use by the given tidy
<parameter>object</parameter>.
</para>
<para>
For an explanation about each option, visit <link
xlink:href="&url.tidy.conf;">&url.tidy.conf;</link>.
</para>
<para>
<example>
<title><function>tidy_get_config</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$html = '<p>test</p>';
@ -44,9 +42,9 @@ $tidy = tidy_parse_string($html, $config);
print_r(tidy_get_config($tidy));
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Array
(
@ -58,91 +56,91 @@ Array
[output-encoding] => 1
[newline] => 1
[doctype-mode] => 1
[doctype] =>
[doctype] =>
[repeated-attributes] => 1
[alt-text] =>
[slide-style] =>
[error-file] =>
[output-file] =>
[write-back] =>
[alt-text] =>
[slide-style] =>
[error-file] =>
[output-file] =>
[write-back] =>
[markup] => 1
[show-warnings] => 1
[quiet] =>
[quiet] =>
[indent] => 1
[hide-endtags] =>
[input-xml] =>
[hide-endtags] =>
[input-xml] =>
[output-xml] => 1
[output-xhtml] => 1
[output-html] =>
[add-xml-decl] =>
[uppercase-tags] =>
[uppercase-attributes] =>
[bare] =>
[clean] =>
[logical-emphasis] =>
[drop-proprietary-attributes] =>
[drop-font-tags] =>
[output-html] =>
[add-xml-decl] =>
[uppercase-tags] =>
[uppercase-attributes] =>
[bare] =>
[clean] =>
[logical-emphasis] =>
[drop-proprietary-attributes] =>
[drop-font-tags] =>
[drop-empty-paras] => 1
[fix-bad-comments] => 1
[break-before-br] =>
[split] =>
[numeric-entities] =>
[quote-marks] =>
[break-before-br] =>
[split] =>
[numeric-entities] =>
[quote-marks] =>
[quote-nbsp] => 1
[quote-ampersand] => 1
[wrap-attributes] =>
[wrap-script-literals] =>
[wrap-attributes] =>
[wrap-script-literals] =>
[wrap-sections] => 1
[wrap-asp] => 1
[wrap-jste] => 1
[wrap-php] => 1
[fix-backslash] => 1
[indent-attributes] =>
[assume-xml-procins] =>
[add-xml-space] =>
[enclose-text] =>
[enclose-block-text] =>
[keep-time] =>
[word-2000] =>
[tidy-mark] =>
[gnu-emacs] =>
[gnu-emacs-file] =>
[literal-attributes] =>
[show-body-only] =>
[indent-attributes] =>
[assume-xml-procins] =>
[add-xml-space] =>
[enclose-text] =>
[enclose-block-text] =>
[keep-time] =>
[word-2000] =>
[tidy-mark] =>
[gnu-emacs] =>
[gnu-emacs-file] =>
[literal-attributes] =>
[show-body-only] =>
[fix-uri] => 1
[lower-literals] => 1
[hide-comments] =>
[indent-cdata] =>
[hide-comments] =>
[indent-cdata] =>
[force-output] => 1
[show-errors] => 6
[ascii-chars] => 1
[join-classes] =>
[join-classes] =>
[join-styles] => 1
[escape-cdata] =>
[language] =>
[escape-cdata] =>
[language] =>
[ncr] => 1
[output-bom] => 2
[replace-color] =>
[css-prefix] =>
[new-inline-tags] =>
[new-blocklevel-tags] =>
[new-empty-tags] =>
[new-pre-tags] =>
[replace-color] =>
[css-prefix] =>
[new-inline-tags] =>
[new-blocklevel-tags] =>
[new-empty-tags] =>
[new-pre-tags] =>
[accessibility-check] => 0
[vertical-space] =>
[punctuation-wrap] =>
[vertical-space] =>
[punctuation-wrap] =>
[merge-divs] => 1
)
]]>
</screen>
</example>
</para>
<para>
See also <function>tidy_reset_config</function> and
<function>tidy_save_config</function>.
</para>
</refsect1>
</refentry>
</screen>
</example>
</para>
<para>
See also <function>tidy_reset_config</function> and
<function>tidy_save_config</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

80
reference/tidy/functions/tidy-get-error-buffer.xml
View file

@ -1,32 +1,30 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.tidy-get-error-buffer" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_get_error_buffer</refname>
<refpurpose>
Return warnings and errors which occurred parsing the specified document
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>tidy_get_error_buffer</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>tidy</classname></ooclass>
<fieldsynopsis><type>string</type><varname>errorBuffer</varname></fieldsynopsis>
</classsynopsis>
<para>
<function>tidy_get_error_buffer</function> returns warnings and errors
which occurred parsing the specified document.
</para>
<para>
<example>
<title><function>tidy_get_error_buffer</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.tidy-get-error-buffer" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_get_error_buffer</refname>
<refpurpose>Return warnings and errors which occurred parsing the specified document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>tidy_get_error_buffer</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style (property):</para>
<classsynopsis>
<ooclass><classname>tidy</classname></ooclass>
<fieldsynopsis><type>string</type><varname>errorBuffer</varname></fieldsynopsis>
</classsynopsis>
<para>
<function>tidy_get_error_buffer</function> returns warnings and errors
which occurred parsing the specified document.
</para>
<para>
<example>
<title><function>tidy_get_error_buffer</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$html = '<p>paragraph</p>';
@ -38,23 +36,23 @@ echo tidy_get_error_buffer($tidy);
echo $tidy->errorBuffer;
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
line 1 column 1 - Warning: missing <!DOCTYPE> declaration
line 1 column 1 - Warning: inserting missing 'title' element
]]>
</screen>
</example>
</para>
<para>
See also <function>tidy_access_count</function>,
<function>tidy_error_count</function> and
<function>tidy_warning_count</function>.
</para>
</refsect1>
</refentry>
</screen>
</example>
</para>
<para>
See also <function>tidy_access_count</function>,
<function>tidy_error_count</function> and
<function>tidy_warning_count</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

80
reference/tidy/functions/tidy-get-head.xml
View file

@ -1,32 +1,30 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.tidy-get-head" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_get_head</refname>
<refpurpose>
Returns a tidyNode Object starting from the &lt;head&gt; tag of the tidy parse tree
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>tidyNode</type><methodname>tidy_get_head</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>tidyNode</type><methodname>tidy->head</methodname>
<void />
</methodsynopsis>
<para>
This function returns a tidyNode object starting from the &lt;head&gt;
tag of the tidy parse tree.
</para>
<para>
<example>
<title><function>tidy_get_head</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.10 $ -->
<refentry xml:id="function.tidy-get-head" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_get_head</refname>
<refpurpose>Returns a tidyNode Object starting from the &lt;head&gt; tag of the tidy parse tree</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>tidyNode</type><methodname>tidy_get_head</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>tidyNode</type><methodname>tidy->head</methodname>
<void />
</methodsynopsis>
<para>
This function returns a tidyNode object starting from the &lt;head&gt;
tag of the tidy parse tree.
</para>
<para>
<example>
<title><function>tidy_get_head</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$html = '
@ -45,24 +43,24 @@ $head = tidy_get_head($tidy);
echo $head->value;
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
<head>
<title>test</title>
</head>
]]>
</screen>
</example>
</para>
&note.tidy.ze2;
<para>
See also <function>tidy_get_body</function> and
<function>tidy_get_html</function>.
</para>
</refsect1>
</refentry>
</screen>
</example>
</para>
&note.tidy.ze2;
<para>
See also <function>tidy_get_body</function> and
<function>tidy_get_html</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

62
reference/tidy/functions/tidy-get-html-ver.xml
View file

@ -1,36 +1,34 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.tidy-get-html-ver" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_get_html_ver</refname>
<refpurpose>
Get the Detected HTML version for the specified document
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>tidy_get_html_ver</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>int</type><methodname>tidy->getHtmlVer</methodname>
<void />
</methodsynopsis>
<para>
<function>tidy_get_html_ver</function> returns the detected HTML version
for the specified tidy <parameter>object</parameter>.
</para>
<warning>
<para>
This function is not yet implemented in the Tidylib itself, so it always
return <literal>0</literal>.
</para>
</warning>
</refsect1>
</refentry>
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.tidy-get-html-ver" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_get_html_ver</refname>
<refpurpose>Get the Detected HTML version for the specified document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>tidy_get_html_ver</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>int</type><methodname>tidy->getHtmlVer</methodname>
<void />
</methodsynopsis>
<para>
<function>tidy_get_html_ver</function> returns the detected HTML version
for the specified tidy <parameter>object</parameter>.
</para>
<warning>
<para>
This function is not yet implemented in the Tidylib itself, so it always
return <literal>0</literal>.
</para>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

80
reference/tidy/functions/tidy-get-html.xml
View file

@ -1,32 +1,30 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.10 $ -->
<refentry xml:id="function.tidy-get-html" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_get_html</refname>
<refpurpose>
Returns a tidyNode Object starting from the &lt;html&gt; tag of the tidy parse tree
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>tidyNode</type><methodname>tidy_get_html</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>tidyNode</type><methodname>tidy->html</methodname>
<void />
</methodsynopsis>
<para>
This function returns a tidyNode object starting from the &lt;html&gt;
tag of the tidy parse tree.
</para>
<para>
<example>
<title><function>tidy_get_html</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.11 $ -->
<refentry xml:id="function.tidy-get-html" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_get_html</refname>
<refpurpose>Returns a tidyNode Object starting from the &lt;html&gt; tag of the tidy parse tree</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>tidyNode</type><methodname>tidy_get_html</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>tidyNode</type><methodname>tidy->html</methodname>
<void />
</methodsynopsis>
<para>
This function returns a tidyNode object starting from the &lt;html&gt;
tag of the tidy parse tree.
</para>
<para>
<example>
<title><function>tidy_get_html</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$html = '
@ -45,9 +43,9 @@ $html = tidy_get_html($tidy);
echo $html->value;
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
<html>
<head>
@ -58,16 +56,16 @@ echo $html->value;
</body>
</html>
]]>
</screen>
</example>
</para>
&note.tidy.ze2;
<para>
See also <function>tidy_get_body</function> and
<function>tidy_get_head</function>.
</para>
</refsect1>
</refentry>
</screen>
</example>
</para>
&note.tidy.ze2;
<para>
See also <function>tidy_get_body</function> and
<function>tidy_get_head</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

58
reference/tidy/functions/tidy-get-output.xml
View file

@ -1,26 +1,24 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.tidy-get-output" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_get_output</refname>
<refpurpose>
Return a string representing the parsed tidy markup
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>tidy_get_output</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_get_output</function> returns a string with the repaired
html.
</para>
<para>
<example>
<title><function>tidy_get_output</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.tidy-get-output" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_get_output</refname>
<refpurpose>Return a string representing the parsed tidy markup</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>tidy_get_output</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_get_output</function> returns a string with the repaired
html.
</para>
<para>
<example>
<title><function>tidy_get_output</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -32,9 +30,9 @@ $tidy->CleanRepair();
echo tidy_get_output($tidy);
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
@ -46,11 +44,11 @@ echo tidy_get_output($tidy);
</body>
</html>
]]>
</screen>
</example>
</para>
</refsect1>
</refentry>
</screen>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

48
reference/tidy/functions/tidy-get-release.xml
View file

@ -1,29 +1,27 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.tidy-get-release" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_get_release</refname>
<refpurpose>
Get release date (version) for Tidy library
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>tidy_get_release</methodname>
<void/>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>string</type><methodname>tidy->getRelease</methodname>
<void />
</methodsynopsis>
<para>
This function returns a string with the release date of the Tidy library.
</para>
</refsect1>
</refentry>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.tidy-get-release" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_get_release</refname>
<refpurpose>Get release date (version) for Tidy library</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>string</type><methodname>tidy_get_release</methodname>
<void/>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>string</type><methodname>tidy->getRelease</methodname>
<void />
</methodsynopsis>
<para>
This function returns a string with the release date of the Tidy library.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

70
reference/tidy/functions/tidy-get-root.xml
View file

@ -1,31 +1,29 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.tidy-get-root" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_get_root</refname>
<refpurpose>
Returns a tidyNode object representing the root of the tidy parse tree
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>tidyNode</type><methodname>tidy_get_root</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>tidyNode</type><methodname>tidy->root</methodname>
<void />
</methodsynopsis>
<para>
Returns a tidyNode object representing the root of the tidy parse tree.
</para>
<para>
<example>
<title>dump nodes</title>
<programlisting role="php">
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.tidy-get-root" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_get_root</refname>
<refpurpose>Returns a tidyNode object representing the root of the tidy parse tree</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>tidyNode</type><methodname>tidy_get_root</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>tidyNode</type><methodname>tidy->root</methodname>
<void />
</methodsynopsis>
<para>
Returns a tidyNode object representing the root of the tidy parse tree.
</para>
<para>
<example>
<title>dump nodes</title>
<programlisting role="php">
<![CDATA[
<?php
@ -54,9 +52,9 @@ function dump_nodes($node, $indent) {
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
..html
....head
@ -66,13 +64,13 @@ function dump_nodes($node, $indent) {
........"paragraph"
......br
]]>
</screen>
</example>
</para>
</screen>
</example>
</para>
&note.tidy.ze2;
</refsect1>
</refentry>
&note.tidy.ze2;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

66
reference/tidy/functions/tidy-get-status.xml
View file

@ -1,33 +1,31 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.tidy-get-status" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_get_status</refname>
<refpurpose>
Get status of specified document
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>tidy_get_status</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>int</type><methodname>tidy->getStatus</methodname>
<void />
</methodsynopsis>
<para>
<function>tidy_get_status</function> returns the status for the specified
tidy <parameter>object</parameter>. It returns 0 if no error/warning
was raised, 1 for warnings or accessibility errors, or 2 for errors.
</para>
<para>
<example>
<title><function>tidy_get_status</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.tidy-get-status" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_get_status</refname>
<refpurpose>Get status of specified document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>int</type><methodname>tidy_get_status</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>int</type><methodname>tidy->getStatus</methodname>
<void />
</methodsynopsis>
<para>
<function>tidy_get_status</function> returns the status for the specified
tidy <parameter>object</parameter>. It returns 0 if no error/warning
was raised, 1 for warnings or accessibility errors, or 2 for errors.
</para>
<para>
<example>
<title><function>tidy_get_status</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$html = '<p>paragraph</i>';
@ -41,11 +39,11 @@ echo tidy_get_status($tidy); //1
echo tidy_get_status($tidy2); //2
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

80
reference/tidy/functions/tidy-getopt.xml
View file

@ -1,37 +1,35 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.tidy-getopt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>tidy_getopt</refname>
<refpurpose>
Returns the value of the specified configuration option for the tidy document
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>mixed</type><methodname>tidy_getopt</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
<methodparam><type>string</type><parameter>option</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>mixed</type><methodname>tidy->getOpt</methodname>
<methodparam><type>string</type><parameter>option</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_getopt</function> returns the value of the specified
<parameter>option</parameter> for the specified tidy
<parameter>object</parameter>. The return type depends on the type
of the specified <parameter>option</parameter>. You will find a list with
each configuration option and their types at: <link
xlink:href="&url.tidy.conf;">&url.tidy.conf;</link>.
</para>
<para>
<example>
<title><function>tidy_getopt</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.tidy-getopt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>tidy_getopt</refname>
<refpurpose>Returns the value of the specified configuration option for the tidy document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>mixed</type><methodname>tidy_getopt</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
<methodparam><type>string</type><parameter>option</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>mixed</type><methodname>tidy->getOpt</methodname>
<methodparam><type>string</type><parameter>option</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_getopt</function> returns the value of the specified
<parameter>option</parameter> for the specified tidy
<parameter>object</parameter>. The return type depends on the type
of the specified <parameter>option</parameter>. You will find a list with
each configuration option and their types at: <link
xlink:href="&url.tidy.conf;">&url.tidy.conf;</link>.
</para>
<para>
<example>
<title><function>tidy_getopt</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
@ -56,19 +54,19 @@ var_dump($tidy->getOpt('alt-text')); //string
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
int(3)
bool(true)
string(9) "some text"
]]>
</screen>
</example>
</para>
</refsect1>
</refentry>
</screen>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

62
reference/tidy/functions/tidy-is-xhtml.xml
View file

@ -1,36 +1,34 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.tidy-is-xhtml" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_is_xhtml</refname>
<refpurpose>
Indicates if the document is a XHTML document
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>tidy_is_xhtml</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>bool</type><methodname>tidy->isXhtml</methodname>
<void />
</methodsynopsis>
<para>
This function returns &true; if the specified tidy
<parameter>object</parameter> is a XHTML document, or &false; otherwise.
</para>
<warning>
<para>
This function is not yet implemented in the Tidylib itself, so it always
return &false;.
</para>
</warning>
</refsect1>
</refentry>
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.tidy-is-xhtml" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_is_xhtml</refname>
<refpurpose>Indicates if the document is a XHTML document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>tidy_is_xhtml</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>bool</type><methodname>tidy->isXhtml</methodname>
<void />
</methodsynopsis>
<para>
This function returns &true; if the specified tidy
<parameter>object</parameter> is a XHTML document, or &false; otherwise.
</para>
<warning>
<para>
This function is not yet implemented in the Tidylib itself, so it always
return &false;.
</para>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

64
reference/tidy/functions/tidy-is-xml.xml
View file

@ -1,37 +1,35 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.tidy-is-xml" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_is_xml</refname>
<refpurpose>
Indicates if the document is a generic (non HTML/XHTML) XML document
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>tidy_is_xml</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>bool</type><methodname>tidy->isXml</methodname>
<void />
</methodsynopsis>
<para>
This function returns &true; if the specified tidy
<parameter>object</parameter> is a generic XML document (non HTML/XHTML),
or &false; otherwise.
</para>
<warning>
<para>
This function is not yet implemented in the Tidylib itself, so it always
return &false;.
</para>
</warning>
</refsect1>
</refentry>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.tidy-is-xml" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_is_xml</refname>
<refpurpose>Indicates if the document is a generic (non HTML/XHTML) XML document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>bool</type><methodname>tidy_is_xml</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>bool</type><methodname>tidy->isXml</methodname>
<void />
</methodsynopsis>
<para>
This function returns &true; if the specified tidy
<parameter>object</parameter> is a generic XML document (non HTML/XHTML),
or &false; otherwise.
</para>
<warning>
<para>
This function is not yet implemented in the Tidylib itself, so it always
return &false;.
</para>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

42
reference/tidy/functions/tidy-load-config.xml
View file

@ -1,26 +1,24 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.tidy-load-config" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_load_config</refname>
<refpurpose>
Load an ASCII Tidy configuration file with the specified encoding
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>tidy_load_config</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
This function loads a Tidy configuration file, with the specified
<parameter>encoding</parameter>.
</para>
&note.tidy.1only;
</refsect1>
</refentry>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.tidy-load-config" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_load_config</refname>
<refpurpose>Load an ASCII Tidy configuration file with the specified encoding</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>tidy_load_config</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
This function loads a Tidy configuration file, with the specified
<parameter>encoding</parameter>.
</para>
&note.tidy.1only;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

32
reference/tidy/functions/tidy-node-get-attr.xml
View file

@ -1,23 +1,21 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.tidy-node-get-attr" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_node->get_attr</refname>
<refpurpose>
Return the attribute with the provided attribute id
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>tidy_attr</type><methodname>tidy_node->get_attr</methodname>
<methodparam><type>int</type><parameter>attrib_id</parameter></methodparam>
</methodsynopsis>
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.tidy-node-get-attr" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_node->get_attr</refname>
<refpurpose>Return the attribute with the provided attribute id</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>tidy_attr</type><methodname>tidy_node->get_attr</methodname>
<methodparam><type>int</type><parameter>attrib_id</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
&warn.undocumented.func;
</refsect1>
</refentry>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

32
reference/tidy/functions/tidy-node-get-nodes.xml
View file

@ -1,23 +1,21 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.tidy-node-get-nodes" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_node->get_nodes</refname>
<refpurpose>
Return an array of nodes under this node with the specified id
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>tidy_node->get_nodes</methodname>
<methodparam><type>int</type><parameter>node_id</parameter></methodparam>
</methodsynopsis>
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.tidy-node-get-nodes" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_node->get_nodes</refname>
<refpurpose>Return an array of nodes under this node with the specified id</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>tidy_node->get_nodes</methodname>
<methodparam><type>int</type><parameter>node_id</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
&warn.undocumented.func;
</refsect1>
</refentry>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

32
reference/tidy/functions/tidy-node-next.xml
View file

@ -1,23 +1,21 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.tidy-node-next" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_node->next</refname>
<refpurpose>
Returns the next sibling to this node
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>tidy_node</type><methodname>tidy_node->next</methodname>
<void/>
</methodsynopsis>
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.tidy-node-next" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_node->next</refname>
<refpurpose>Returns the next sibling to this node</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>tidy_node</type><methodname>tidy_node->next</methodname>
<void/>
</methodsynopsis>
&warn.undocumented.func;
&warn.undocumented.func;
</refsect1>
</refentry>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

32
reference/tidy/functions/tidy-node-prev.xml
View file

@ -1,23 +1,21 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.tidy-node-prev" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_node->prev</refname>
<refpurpose>
Returns the previous sibling to this node
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>tidy_node</type><methodname>tidy_node->prev</methodname>
<void/>
</methodsynopsis>
<!-- $Revision: 1.4 $ -->
<refentry xml:id="function.tidy-node-prev" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_node->prev</refname>
<refpurpose>Returns the previous sibling to this node</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>tidy_node</type><methodname>tidy_node->prev</methodname>
<void/>
</methodsynopsis>
&warn.undocumented.func;
&warn.undocumented.func;
</refsect1>
</refentry>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

90
reference/tidy/functions/tidy-parse-file.xml
View file

@ -1,61 +1,59 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.tidy-parse-file" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_parse_file</refname>
<refpurpose>
Parse markup in file or URI
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>tidy</type><methodname>tidy_parse_file</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>bool</type><methodname>tidy->parseFile</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter></methodparam>
</methodsynopsis>
<para>
This function parses the given file.
</para>
&tidy.conf-enc;
<para>
<example>
<title><function>tidy_parse_file</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.10 $ -->
<refentry xml:id="function.tidy-parse-file" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_parse_file</refname>
<refpurpose>Parse markup in file or URI</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>tidy</type><methodname>tidy_parse_file</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>bool</type><methodname>tidy->parseFile</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter></methodparam>
</methodsynopsis>
<para>
This function parses the given file.
</para>
&tidy.conf-enc;
<para>
<example>
<title><function>tidy_parse_file</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$tidy = tidy_parse_file('file.html');
$tidy->cleanRepair();
if(!empty($tidy->errorBuffer)) {
echo "The following errors or warnings occured:\n";
echo $tidy->errorBuffer;
}
?>
]]>
</programlisting>
</example>
</para>
&note.tidy.2only;
<para>
See also <function>tidy_parse_string</function>,
<function>tidy_repair_file</function> and
<function>tidy_repair_string</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
&note.tidy.2only;
<para>
See also <function>tidy_parse_string</function>,
<function>tidy_repair_file</function> and
<function>tidy_repair_string</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

92
reference/tidy/functions/tidy-parse-string.xml
View file

@ -1,37 +1,35 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.9 $ -->
<refentry xml:id="function.tidy-parse-string" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_parse_string</refname>
<refpurpose>
Parse a document stored in a string
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>tidy</type><methodname>tidy_parse_string</methodname>
<methodparam><type>string</type><parameter>input</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>bool</type><methodname>tidy->parseString</methodname>
<methodparam><type>string</type><parameter>input</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_parse_string</function> parses a document stored in a
string.
</para>
&tidy.conf-enc;
<para>
<example>
<title><function>tidy_parse_string</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.10 $ -->
<refentry xml:id="function.tidy-parse-string" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_parse_string</refname>
<refpurpose>Parse a document stored in a string</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>Procedural style:</para>
<methodsynopsis>
<type>tidy</type><methodname>tidy_parse_string</methodname>
<methodparam><type>string</type><parameter>input</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>Object oriented style:</para>
<methodsynopsis>
<type>bool</type><methodname>tidy->parseString</methodname>
<methodparam><type>string</type><parameter>input</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_parse_string</function> parses a document stored in a
string.
</para>
&tidy.conf-enc;
<para>
<example>
<title><function>tidy_parse_string</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
ob_start();
@ -59,9 +57,9 @@ $tidy->cleanRepair();
echo $tidy;
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
@ -79,17 +77,17 @@ echo $tidy;
</body>
</html>
]]>
</screen>
</example>
</para>
&note.tidy.2only;
<para>
See also <function>tidy_parse_file</function>,
<function>tidy_repair_file</function> and
<function>tidy_repair_string</function>.
</para>
</refsect1>
</refentry>
</screen>
</example>
</para>
&note.tidy.2only;
<para>
See also <function>tidy_parse_file</function>,
<function>tidy_repair_file</function> and
<function>tidy_repair_string</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

70
reference/tidy/functions/tidy-repair-file.xml
View file

@ -1,29 +1,27 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.tidy-repair-file" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_repair_file</refname>
<refpurpose>
Repair a file and return it as a string
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>tidy_repair_file</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter></methodparam>
</methodsynopsis>
<para>
This function repairs the given file and returns it as a string.
</para>
&tidy.conf-enc;
<para>
<example>
<title><function>tidy_repair_file</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.tidy-repair-file" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_repair_file</refname>
<refpurpose>Repair a file and return it as a string</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>tidy_repair_file</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>use_include_path</parameter></methodparam>
</methodsynopsis>
<para>
This function repairs the given file and returns it as a string.
</para>
&tidy.conf-enc;
<para>
<example>
<title><function>tidy_repair_file</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$file = 'file.html';
@ -34,17 +32,17 @@ rename($file, $file . '.bak');
file_put_contents($file, $repaired);
?>
]]>
</programlisting>
</example>
</para>
&note.tidy.2only;
<para>
See also <function>tidy_parse_file</function>,
<function>tidy_parse_string</function> and
<function>tidy_repair_string</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
&note.tidy.2only;
<para>
See also <function>tidy_parse_file</function>,
<function>tidy_parse_string</function> and
<function>tidy_repair_string</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

74
reference/tidy/functions/tidy-repair-string.xml
View file

@ -1,28 +1,26 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.10 $ -->
<refentry xml:id="function.tidy-repair-string" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_repair_string</refname>
<refpurpose>
Repair a string using an optionally provided configuration file
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>tidy_repair_string</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
This function repairs the given string.
</para>
&tidy.conf-enc;
<para>
<example>
<title><function>tidy_repair_string</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.11 $ -->
<refentry xml:id="function.tidy-repair-string" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_repair_string</refname>
<refpurpose>Repair a string using an optionally provided configuration file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>tidy_repair_string</methodname>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
<methodparam choice="opt"><type>mixed</type><parameter>config</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
This function repairs the given string.
</para>
&tidy.conf-enc;
<para>
<example>
<title><function>tidy_repair_string</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
ob_start();
@ -45,9 +43,9 @@ $tidy = tidy_repair_string($buffer);
echo $tidy;
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2//EN">
<html>
@ -59,17 +57,17 @@ echo $tidy;
</body>
</html>
]]>
</screen>
</example>
</para>
&note.tidy.2only;
<para>
See also <function>tidy_parse_file</function>,
<function>tidy_parse_string</function> and
<function>tidy_repair_file</function>.
</para>
</refsect1>
</refentry>
</screen>
</example>
</para>
&note.tidy.2only;
<para>
See also <function>tidy_parse_file</function>,
<function>tidy_parse_string</function> and
<function>tidy_repair_file</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

38
reference/tidy/functions/tidy-reset-config.xml
View file

@ -1,24 +1,22 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.tidy-reset-config" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_reset_config</refname>
<refpurpose>
Restore Tidy configuration to default values
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>tidy_reset_config</methodname>
<void/>
</methodsynopsis>
<para>
This function restores the Tidy configuration to the default values.
</para>
&note.tidy.1only;
</refsect1>
</refentry>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.tidy-reset-config" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_reset_config</refname>
<refpurpose>Restore Tidy configuration to default values</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>tidy_reset_config</methodname>
<void/>
</methodsynopsis>
<para>
This function restores the Tidy configuration to the default values.
</para>
&note.tidy.1only;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

52
reference/tidy/functions/tidy-save-config.xml
View file

@ -1,31 +1,29 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.tidy-save-config" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_save_config</refname>
<refpurpose>
Save current settings to named file
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>tidy_save_config</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_save_config</function> saves current settings to the
specified file. Only non-default values are written.
</para>
<para>
See also <function>tidy_get_config</function>,
<function>tidy_getopt</function>,
<function>tidy_reset_config</function> and
<function>tidy_setopt</function>.
</para>
&note.tidy.1only;
</refsect1>
</refentry>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.tidy-save-config" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_save_config</refname>
<refpurpose>Save current settings to named file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>tidy_save_config</methodname>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_save_config</function> saves current settings to the
specified file. Only non-default values are written.
</para>
<para>
See also <function>tidy_get_config</function>,
<function>tidy_getopt</function>,
<function>tidy_reset_config</function> and
<function>tidy_setopt</function>.
</para>
&note.tidy.1only;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

44
reference/tidy/functions/tidy-set-encoding.xml
View file

@ -1,27 +1,25 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.10 $ -->
<refentry xml:id="function.tidy-set-encoding" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_set_encoding</refname>
<refpurpose>
Set the input/output character encoding for parsing markup
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>tidy_set_encoding</methodname>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
Sets the encoding for input/output documents. &return.success;
Possible values for <parameter>encoding</parameter> are
ascii, latin0, latin1, raw, utf8, iso2022, mac, win1252, ibm858, utf16,
utf16le, utf16be, big5 and shiftjis
</para>
&note.tidy.1only;
</refsect1>
</refentry>
<!-- $Revision: 1.11 $ -->
<refentry xml:id="function.tidy-set-encoding" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_set_encoding</refname>
<refpurpose>Set the input/output character encoding for parsing markup</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>tidy_set_encoding</methodname>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
Sets the encoding for input/output documents. &return.success;
Possible values for <parameter>encoding</parameter> are
ascii, latin0, latin1, raw, utf8, iso2022, mac, win1252, ibm858, utf16,
utf16le, utf16be, big5 and shiftjis
</para>
&note.tidy.1only;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

72
reference/tidy/functions/tidy-setopt.xml
View file

@ -1,29 +1,27 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.7 $ -->
<refentry xml:id="function.tidy-setopt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>tidy_setopt</refname>
<refpurpose>
Updates the configuration settings for the specified tidy document
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>tidy_setopt</methodname>
<methodparam><type>string</type><parameter>option</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_setopt</function> updates the specified
<parameter>option</parameter> with a new <parameter>value</parameter>.
You will find a list with each configuration option at: <link
xlink:href="&url.tidy.conf;">&url.tidy.conf;</link>.
</para>
<para>
<example>
<title><function>tidy_setopt</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.8 $ -->
<refentry xml:id="function.tidy-setopt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>tidy_setopt</refname>
<refpurpose>Updates the configuration settings for the specified tidy document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>tidy_setopt</methodname>
<methodparam><type>string</type><parameter>option</parameter></methodparam>
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_setopt</function> updates the specified
<parameter>option</parameter> with a new <parameter>value</parameter>.
You will find a list with each configuration option at: <link
xlink:href="&url.tidy.conf;">&url.tidy.conf;</link>.
</para>
<para>
<example>
<title><function>tidy_setopt</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$html = '<p>test</i>';
@ -33,18 +31,18 @@ $tidy = tidy_parse_string($html);
tidy_setopt('indent', FALSE);
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>tidy_getopt</function>,
<function>tidy_get_config</function>,
<function>tidy_reset_config</function> and
<function>tidy_save_config</function>.
</para>
&note.tidy.1only;
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<para>
See also <function>tidy_getopt</function>,
<function>tidy_get_config</function>,
<function>tidy_reset_config</function> and
<function>tidy_save_config</function>.
</para>
&note.tidy.1only;
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

60
reference/tidy/functions/tidy-warning-count.xml
View file

@ -1,26 +1,24 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.5 $ -->
<refentry xml:id="function.tidy-warning-count" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_warning_count</refname>
<refpurpose>
Returns the Number of Tidy warnings encountered for specified document
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>tidy_warning_count</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_warning_count</function> returns the number of Tidy warnings
encountered for the specified document.
</para>
<para>
<example>
<title><function>tidy_warning_count</function> example</title>
<programlisting role="php">
<!-- $Revision: 1.6 $ -->
<refentry xml:id="function.tidy-warning-count" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_warning_count</refname>
<refpurpose>Returns the Number of Tidy warnings encountered for specified document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>tidy_warning_count</methodname>
<methodparam><type>tidy</type><parameter>object</parameter></methodparam>
</methodsynopsis>
<para>
<function>tidy_warning_count</function> returns the number of Tidy warnings
encountered for the specified document.
</para>
<para>
<example>
<title><function>tidy_warning_count</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$html = '<p>test</i>
@ -32,15 +30,15 @@ echo tidy_error_count($tidy) . "\n"; //1
echo tidy_warning_count($tidy) . "\n"; //5
?>
]]>
</programlisting>
</example>
</para>
<para>
See also <function>tidy_access_count</function> and
<function>tidy_error_count</function>.
</para>
</refsect1>
</refentry>
</programlisting>
</example>
</para>
<para>
See also <function>tidy_access_count</function> and
<function>tidy_error_count</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

6
reference/tidy/functions/tidyNode-hasChildren.xml
View file

@ -1,11 +1,9 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.tidyNode-hasChildren" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode->hasChildren</refname>
<refpurpose>
Returns true if this node has children
</refpurpose>
<refpurpose>Returns true if this node has children</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>

6
reference/tidy/functions/tidyNode-hasSiblings.xml
View file

@ -1,11 +1,9 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.tidyNode-hasSiblings" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode->hasSiblings</refname>
<refpurpose>
Returns true if this node has siblings
</refpurpose>
<refpurpose>Returns true if this node has siblings</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>

50
reference/tidy/functions/tidyNode-isAsp.xml
View file

@ -1,30 +1,28 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.tidyNode-isAsp" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode->isAsp</refname>
<refpurpose>
Returns true if this node is ASP
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>tidyNode->isAsp</methodname>
<void/>
</methodsynopsis>
<para>
This functions returns &true; if the current node is ASP, or &false;
otherwise.
</para>
<note>
<para>
This function was named <function>tidy_node->is_asp</function> in
PHP 4/Tidy 1.
</para>
</note>
</refsect1>
</refentry>
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.tidyNode-isAsp" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode->isAsp</refname>
<refpurpose>Returns true if this node is ASP</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>tidyNode->isAsp</methodname>
<void/>
</methodsynopsis>
<para>
This functions returns &true; if the current node is ASP, or &false;
otherwise.
</para>
<note>
<para>
This function was named <function>tidy_node->is_asp</function> in
PHP 4/Tidy 1.
</para>
</note>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

6
reference/tidy/functions/tidyNode-isComment.xml
View file

@ -1,11 +1,9 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.tidyNode-isComment" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode->isComment</refname>
<refpurpose>
Returns true if this node represents a comment
</refpurpose>
<refpurpose>Returns true if this node represents a comment</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>

6
reference/tidy/functions/tidyNode-isHtml.xml
View file

@ -1,11 +1,9 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.tidyNode-isHtml" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode->isHtml</refname>
<refpurpose>
Returns true if this node is part of a HTML document
</refpurpose>
<refpurpose>Returns true if this node is part of a HTML document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>

6
reference/tidy/functions/tidyNode-isJste.xml
View file

@ -1,11 +1,9 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.tidyNode-isJste" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode->isJste</refname>
<refpurpose>
Returns true if this node is JSTE
</refpurpose>
<refpurpose>Returns true if this node is JSTE</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>

68
reference/tidy/functions/tidyNode-isPhp.xml
View file

@ -1,25 +1,23 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<refentry xml:id="function.tidyNode-isPhp" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode->isPhp</refname>
<refpurpose>
Returns true if this node is PHP
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>tidyNode->isPhp</methodname>
<void/>
</methodsynopsis>
<para>
Returns &true; if the current node is PHP code, &false; otherwise.
</para>
<para>
<example>
<title>get the PHP code from a mixed HTML/PHP document</title>
<programlisting role="php">
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.tidyNode-isPhp" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode->isPhp</refname>
<refpurpose>Returns true if this node is PHP</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>tidyNode->isPhp</methodname>
<void/>
</methodsynopsis>
<para>
Returns &true; if the current node is PHP code, &false; otherwise.
</para>
<para>
<example>
<title>get the PHP code from a mixed HTML/PHP document</title>
<programlisting role="php">
<![CDATA[
<?php
@ -61,9 +59,9 @@ function get_php($node) {
?>
]]>
</programlisting>
&example.outputs;
<screen>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
# PHP node #1
<?php echo '<title>title</title>'; ?>
@ -73,17 +71,17 @@ function get_php($node) {
echo 'hello world!';
?>
]]>
</screen>
</example>
</para>
<note>
<para>
This function was named <function>tidy_node->is_php</function> in
PHP 4/Tidy 1.
</para>
</note>
</refsect1>
</refentry>
</screen>
</example>
</para>
<note>
<para>
This function was named <function>tidy_node->is_php</function> in
PHP 4/Tidy 1.
</para>
</note>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:

6
reference/tidy/functions/tidyNode-isText.xml
View file

@ -1,11 +1,9 @@
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<refentry xml:id="function.tidyNode-isText" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidyNode->isText</refname>
<refpurpose>
Returns true if this node represents text (no markup)
</refpurpose>
<refpurpose>Returns true if this node represents text (no markup)</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>