nlopess Tue Aug 10 13:01:18 2004 EDT
Modified files:
/phpdoc/en/reference/tidy constants.xml
/phpdoc/en/reference/tidy/functions tidy-node-isPhp.xml
Log:
added explanation about tidy constants
docs and examples
http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/constants.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/tidy/constants.xml
diff -u phpdoc/en/reference/tidy/constants.xml:1.3
phpdoc/en/reference/tidy/constants.xml:1.4
--- phpdoc/en/reference/tidy/constants.xml:1.3 Sun Jul 4 06:06:18 2004
+++ phpdoc/en/reference/tidy/constants.xml Tue Aug 10 13:01:17 2004
@@ -1,18 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<section id="tidy.constants">
&reftitle.constants;
&extension.constants;
<para>
Each <constant>TIDY_TAG_XXX</constant> represents a HTML tag. For example,
<constant>TIDY_TAG_A</constant> represents a <a
- href="XX">link</a> tag.
+ href="XX">link</a> tag. Each <constant>TIDY_ATTR_XXX</constant>
+ represents a HTML atribute. For example <constant>TIDY_ATTR_HREF</constant>
+ would represent the href atribute in the previous example.
</para>
<para>
The following constants are defined:
<table>
<title>tidy tag constants</title>
- <tgroup cols="2">
+ <tgroup cols="1">
<thead>
<row>
<entry>constant</entry>
@@ -375,783 +377,474 @@
<para>
<table>
<title>tidy attribute constants</title>
- <tgroup cols="2">
+ <tgroup cols="1">
<thead>
<row>
<entry>constant</entry>
- <entry>description</entry>
</row>
</thead>
<tbody>
<row>
<entry>TIDY_ATTR_UNKNOWN</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_ABBR</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_ACCEPT</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_ACCEPT_CHARSET</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_ACCESSKEY</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_ACTION</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_ADD_DATE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_ALIGN</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_ALINK</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_ALT</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_ARCHIVE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_AXIS</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_BACKGROUND</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_BGCOLOR</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_BGPROPERTIES</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_BORDER</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_BORDERCOLOR</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_BOTTOMMARGIN</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_CELLPADDING</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_CELLSPACING</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_CHAR</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_CHAROFF</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_CHARSET</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_CHECKED</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_CITE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_CLASS</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_CLASSID</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_CLEAR</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_CODE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_CODEBASE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_CODETYPE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_COLOR</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_COLS</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_COLSPAN</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_COMPACT</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_CONTENT</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_COORDS</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_DATA</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_DATAFLD</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_DATAPAGESIZE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_DATASRC</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_DATETIME</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_DECLARE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_DEFER</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_DIR</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_DISABLED</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_ENCODING</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_ENCTYPE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_FACE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_FOR</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_FRAME</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_FRAMEBORDER</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_FRAMESPACING</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_GRIDX</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_GRIDY</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_HEADERS</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_HEIGHT</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_HREF</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_HREFLANG</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_HSPACE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_HTTP_EQUIV</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_ID</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_ISMAP</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_LABEL</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_LANG</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_LANGUAGE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_LAST_MODIFIED</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_LAST_VISIT</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_LEFTMARGIN</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_LINK</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_LONGDESC</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_LOWSRC</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_MARGINHEIGHT</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_MARGINWIDTH</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_MAXLENGTH</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_MEDIA</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_METHOD</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_MULTIPLE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_NAME</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_NOHREF</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_NORESIZE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_NOSHADE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_NOWRAP</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OBJECT</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnAFTERUPDATE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnBEFOREUNLOAD</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnBEFOREUPDATE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnBLUR</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnCHANGE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnCLICK</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnDATAAVAILABLE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnDATASETCHANGED</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnDATASETCOMPLETE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnDBLCLICK</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnERRORUPDATE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnFOCUS</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnKEYDOWN</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnKEYPRESS</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnKEYUP</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnLOAD</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnMOUSEDOWN</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnMOUSEMOVE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnMOUSEOUT</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnMOUSEOVER</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnMOUSEUP</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnRESET</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnROWENTER</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnROWEXIT</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnSELECT</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnSUBMIT</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_OnUNLOAD</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_PROFILE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_PROMPT</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_RBSPAN</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_READONLY</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_REL</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_REV</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_RIGHTMARGIN</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_ROWS</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_ROWSPAN</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_RULES</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_SCHEME</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_SCOPE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_SCROLLING</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_SELECTED</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_SHAPE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_SHOWGRID</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_SHOWGRIDX</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_SHOWGRIDY</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_SIZE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_SPAN</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_SRC</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_STANDBY</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_START</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_STYLE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_SUMMARY</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_TABINDEX</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_TARGET</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_TEXT</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_TITLE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_TOPMARGIN</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_TYPE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_USEMAP</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_VALIGN</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_VALUE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_VALUETYPE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_VERSION</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_VLINK</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_VSPACE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_WIDTH</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_WRAP</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_XML_LANG</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_XML_SPACE</entry>
- <entry>
- </entry>
</row>
<row>
<entry>TIDY_ATTR_XMLNS</entry>
- <entry>
- </entry>
</row>
</tbody>
</tgroup>
@@ -1171,73 +864,59 @@
<tbody>
<row>
<entry>TIDY_NODETYPE_ROOT</entry>
- <entry>
- </entry>
+ <entry>root node</entry>
</row>
<row>
<entry>TIDY_NODETYPE_DOCTYPE</entry>
- <entry>
- </entry>
+ <entry>doctype</entry>
</row>
<row>
<entry>TIDY_NODETYPE_COMMENT</entry>
- <entry>
- </entry>
+ <entry>HTML comment</entry>
</row>
<row>
<entry>TIDY_NODETYPE_PROCINS</entry>
- <entry>
- </entry>
+ <entry>Processing Instruction</entry>
</row>
<row>
<entry>TIDY_NODETYPE_TEXT</entry>
- <entry>
- </entry>
+ <entry>Text</entry>
</row>
<row>
<entry>TIDY_NODETYPE_START</entry>
- <entry>
- </entry>
+ <entry>start tag</entry>
</row>
<row>
<entry>TIDY_NODETYPE_END</entry>
- <entry>
- </entry>
+ <entry>end tag</entry>
</row>
<row>
<entry>TIDY_NODETYPE_STARTEND</entry>
- <entry>
- </entry>
+ <entry>empty tag</entry>
</row>
<row>
<entry>TIDY_NODETYPE_CDATA</entry>
- <entry>
- </entry>
+ <entry>CDATA</entry>
</row>
<row>
<entry>TIDY_NODETYPE_SECTION</entry>
- <entry>
- </entry>
+ <entry>XML section</entry>
</row>
<row>
<entry>TIDY_NODETYPE_ASP</entry>
- <entry>
- </entry>
+ <entry>ASP code</entry>
</row>
<row>
<entry>TIDY_NODETYPE_JSTE</entry>
- <entry>
- </entry>
+ <entry>JSTE code</entry>
</row>
<row>
<entry>TIDY_NODETYPE_PHP</entry>
- <entry>
- </entry>
+ <entry>PHP code</entry>
</row>
<row>
<entry>TIDY_NODETYPE_XMLDECL</entry>
- <entry>
- </entry>
+ <entry>XML declaration</entry>
</row>
</tbody>
</tgroup>
http://cvs.php.net/diff.php/phpdoc/en/reference/tidy/functions/tidy-node-isPhp.xml?r1=1.3&r2=1.4&ty=u
Index: phpdoc/en/reference/tidy/functions/tidy-node-isPhp.xml
diff -u phpdoc/en/reference/tidy/functions/tidy-node-isPhp.xml:1.3
phpdoc/en/reference/tidy/functions/tidy-node-isPhp.xml:1.4
--- phpdoc/en/reference/tidy/functions/tidy-node-isPhp.xml:1.3 Tue May 18 07:15:21
2004
+++ phpdoc/en/reference/tidy/functions/tidy-node-isPhp.xml Tue Aug 10 13:01:18
2004
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.3 $ -->
+<!-- $Revision: 1.4 $ -->
<refentry id="function.tidy-node-isPhp">
<refnamediv>
<refname>tidy_node->isPhp</refname>
@@ -13,9 +13,71 @@
<type>bool</type><methodname>tidy_node->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
- &warn.undocumented.func;
+$html = <<< HTML
+<html><head>
+<?php echo '<title>title</title>'; ?>
+</head>
+<body>
+<?php
+echo 'hello world!';
+?>
+
+</body></html>
+HTML;
+
+
+$tidy = tidy_parse_string($html);
+$num = 0;
+
+get_php($tidy->html());
+
+
+function get_php($node) {
+
+ // check if the current node is PHP code
+ if($node->isPHP()) {
+ echo "\n\n# PHP node #" . ++$GLOBALS['num'] . "\n";
+ echo $node->value;
+ }
+
+ // check if the current node has childrens
+ if($node->hasChildren()) {
+ foreach($node->child as $child) {
+ get_php($child);
+ }
+ }
+}
+
+?>
+]]>
+ </programlisting>
+ <para>
+ The above example will output:
+ </para>
+ <screen>
+<![CDATA[
+# PHP node #1
+<?php echo '<title>title</title>'; ?>
+
+# PHP node #2
+<?php
+echo 'hello world!';
+?>
+]]>
+ </screen>
+ </example>
+ </para>
<note>
<para>
This function was named <function>tidy_node->is_php</function> in
