nlopess Sun Feb 22 07:23:25 2004 EDT
Modified files:
/phpdoc/en/reference/tidy/functions tidy-get-config.xml
tidy-parse-file.xml
tidy-parse-string.xml
/phpdoc/entities global.ent
Log:
somre more tidy docs and examples
some examples and protos were fixed
http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-get-config.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/tidy/functions/tidy-get-config.xml
diff -u phpdoc/en/reference/tidy/functions/tidy-get-config.xml:1.2
phpdoc/en/reference/tidy/functions/tidy-get-config.xml:1.3
--- phpdoc/en/reference/tidy/functions/tidy-get-config.xml:1.2 Fri Dec 19 10:49:59
2003
+++ phpdoc/en/reference/tidy/functions/tidy-get-config.xml Sun Feb 22 07:23:24
2004
@@ -1,6 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.2 $ -->
-<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.tidy-get-config">
<refnamediv>
<refname>tidy_get_config</refname>
@@ -12,11 +11,129 @@
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>tidy_get_config</methodname>
- <void/>
+ <methodparam><type>resource</type><parameter>tidy</parameter></methodparam>
</methodsynopsis>
+ <para>
+ <function>tidy_get_config</function> returns an array with the
+ configuration options in use by the given resource.
+ </para>
+ <para>
+ For a explanation about each option, visit <ulink
url="&url.tidy.conf;">&url.tidy.conf;</ulink>.
+ </para>
+ <para>
+ <example>
+ <title><function>tidy_get_config</function> example</title>
+ <programlisting role="php">
+<![CDATA[
+<?php
+$html = '<p>test</p>';
+$config = array('indent' => TRUE,
+ 'output-xhtml' => TRUE,
+ 'wrap', 200);
- &warn.undocumented.func;
+$tidy = tidy_parse_string($html, $config);
+print_r(tidy_get_config($tidy));
+?>
+]]>
+ </programlisting>
+ <para>
+ The above example will output:
+ </para>
+ <screen>
+<![CDATA[
+Array
+(
+ [indent-spaces] => 2
+ [wrap] => 68
+ [tab-size] => 8
+ [char-encoding] => 1
+ [input-encoding] => 3
+ [output-encoding] => 1
+ [newline] => 1
+ [doctype-mode] => 1
+ [doctype] =>
+ [repeated-attributes] => 1
+ [alt-text] =>
+ [slide-style] =>
+ [error-file] =>
+ [output-file] =>
+ [write-back] =>
+ [markup] => 1
+ [show-warnings] => 1
+ [quiet] =>
+ [indent] => 1
+ [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] =>
+ [drop-empty-paras] => 1
+ [fix-bad-comments] => 1
+ [break-before-br] =>
+ [split] =>
+ [numeric-entities] =>
+ [quote-marks] =>
+ [quote-nbsp] => 1
+ [quote-ampersand] => 1
+ [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] =>
+ [fix-uri] => 1
+ [lower-literals] => 1
+ [hide-comments] =>
+ [indent-cdata] =>
+ [force-output] => 1
+ [show-errors] => 6
+ [ascii-chars] => 1
+ [join-classes] =>
+ [join-styles] => 1
+ [escape-cdata] =>
+ [language] =>
+ [ncr] => 1
+ [output-bom] => 2
+ [replace-color] =>
+ [css-prefix] =>
+ [new-inline-tags] =>
+ [new-blocklevel-tags] =>
+ [new-empty-tags] =>
+ [new-pre-tags] =>
+ [accessibility-check] => 0
+ [vertical-space] =>
+ [punctuation-wrap] =>
+)
+]]>
+ </screen>
+ </example>
+ </para>
+ <para>
+ See also <function>tidy_reset_config</function> and
+ <function>tidy_save_config</function>.
+ </para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-parse-file.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/tidy/functions/tidy-parse-file.xml
diff -u phpdoc/en/reference/tidy/functions/tidy-parse-file.xml:1.3
phpdoc/en/reference/tidy/functions/tidy-parse-file.xml:1.4
--- phpdoc/en/reference/tidy/functions/tidy-parse-file.xml:1.3 Wed Jan 7 09:48:55
2004
+++ phpdoc/en/reference/tidy/functions/tidy-parse-file.xml Sun Feb 22 07:23:25
2004
@@ -1,6 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.3 $ -->
-<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.tidy-parse-file">
<refnamediv>
<refname>tidy_parse_file</refname>
@@ -11,14 +10,21 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>bool</type><methodname>tidy_parse_file</methodname>
- <methodparam><type>string</type><parameter>file</parameter></methodparam>
- <methodparam
choice="opt"><type>array</type><parameter>config_options</parameter></methodparam>
+ <type>resource</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>
-
- &warn.undocumented.func;
-
+ <para>
+ This function parses the given file.
+ </para>
+ ¬e.tidy.2only;
+ <para>
+ See also <function>tidy_parse_string</function>,
+ <function>tidy_parse_string</function> and
+ <function>tidy_repair_string</function>.
+ </para>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-parse-string.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/tidy/functions/tidy-parse-string.xml
diff -u phpdoc/en/reference/tidy/functions/tidy-parse-string.xml:1.2
phpdoc/en/reference/tidy/functions/tidy-parse-string.xml:1.3
--- phpdoc/en/reference/tidy/functions/tidy-parse-string.xml:1.2 Sun Feb 15
12:21:04 2004
+++ phpdoc/en/reference/tidy/functions/tidy-parse-string.xml Sun Feb 22 07:23:25
2004
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<refentry id="function.tidy-parse-string">
<refnamediv>
<refname>tidy_parse_string</refname>
@@ -10,8 +10,10 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>bool</type><methodname>tidy_parse_string</methodname>
+ <type>resource</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>
<function>tidy_parse_string</function> parses a document stored in a
@@ -42,8 +44,9 @@
'output-xhtml' => TRUE,
'wrap', 200);
-$tidy = tidy_repair_string($buffer, $config, 'UTF8');
+$tidy = tidy_parse_string($buffer, $config, 'UTF8');
+$tidy->cleanRepair();
echo $tidy;
?>
]]>
@@ -72,6 +75,7 @@
</screen>
</example>
</para>
+ ¬e.tidy.2only;
<para>
See also <function>tidy_parse_file</function>,
<function>tidy_repair_file</function> and
http://cvs.php.net/diff.php/phpdoc/entities/global.ent?r1=1.166&r2=1.167&ty=u
Index: phpdoc/entities/global.ent
diff -u phpdoc/entities/global.ent:1.166 phpdoc/entities/global.ent:1.167
--- phpdoc/entities/global.ent:1.166 Fri Feb 20 13:05:31 2004
+++ phpdoc/entities/global.ent Sun Feb 22 07:23:25 2004
@@ -1,6 +1,6 @@
<!-- -*- SGML -*-
- $Id: global.ent,v 1.166 2004/02/20 18:05:31 pollita Exp $
+ $Id: global.ent,v 1.167 2004/02/22 12:23:25 nlopess Exp $
Contains global "macros" for all the XML documents.
@@ -269,11 +269,13 @@
<!ENTITY url.t1lib "ftp://sunsite.unc.edu/pub/Linux/libs/graphics/";>
<!ENTITY url.tiff "http://www.libtiff.org/";>
<!ENTITY url.tidy "http://tidy.sourceforge.net/";>
+<!ENTITY url.tidy.conf "http://tidy.sourceforge.net/docs/quickref.html";>
<!ENTITY url.net-snmp "http://www.net-snmp.org/";>
<!ENTITY url.ultimatezip "http://www.ultimatezip.com/";>
<!ENTITY url.unicode "http://www.unicode.org/";>
<!ENTITY url.unicode.reports "http://www.unicode.org/unicode/reports/tr21/";>
<!ENTITY url.vb4linux "http://sourceforge.net/projects/vb4linux/";>
+<!ENTITY url.w3.access "http://www.w3.org/WAI/GL/";>
<!ENTITY url.w3.validator "http://validator.w3.org/";>
<!ENTITY url.win32.buildtools "http://www.php.net/extra/win32build.zip";>
<!ENTITY url.win32.dnsresolver "http://www.php.net/extra/bindlib_w32.zip";>
