cvs: peardoc /en/package/xml xml-statistics.xml /en/package/xml/xml-statistics/xml-statistics counttag.xml counttagsindepth.xml

schst Fri Oct 31 12:35:10 2003 EDT Added files: /peardoc/en/package/xml/xml-statistics/xml-statistics counttag.xml counttagsindepth.xml Modified files: /peardoc/en/package/xml xml-statistics.xml Log: added docs for XML_Statistics Index: peardoc/en/package/xml/xml-statistics.xml diff -u peardoc/en/package/xml/xml-statistics.xml:1.2 peardoc/en/package/xml/xml-statistics.xml:1.3 --- peardoc/en/package/xml/xml-statistics.xml:1.2 Sun Oct 26 15:20:47 2003 +++ peardoc/en/package/xml/xml-statistics.xml Fri Oct 31 12:35:09 2003 @@ -1,4 +1,4 @@ -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <sect1 id="package.xml.xml-statistics"> <title>XML_Statistics</title> @@ -10,6 +10,8 @@ &package.xml.xml-statistics.xml-statistics.apiversion; &package.xml.xml-statistics.xml-statistics.analyzefile; &package.xml.xml-statistics.xml-statistics.analyzestring; + &package.xml.xml-statistics.xml-statistics.counttag; + &package.xml.xml-statistics.xml-statistics.counttagsindepth; </sect1> <!-- Keep this comment at the end of the file Local variables: Index: peardoc/en/package/xml/xml-statistics/xml-statistics/counttag.xml +++ peardoc/en/package/xml/xml-statistics/xml-statistics/counttag.xml <!-- $Revision: 1.1 $ --> <refentry id="package.xml.xml-statistics.xml-statistics.counttag"> <refnamediv> <refname><function>XML_Statistics::countTag</function></refname> <refpurpose>count the occurences of a tag</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'XML/Statistics.php'; </funcsynopsisinfo> <funcprototype> <funcdef>integer <function>XML_Statistics::countTag</function></funcdef> <paramdef>string <parameter><optional>$tagname = null</optional></parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.xml.xml-statistics.xml-statistics.counttag.desc"> &title.desc; <para> Counts how often a certain tag is used in the document. If no tagname is specified ot will count the total number of tags. </para> </refsect1> <refsect1 id="package.default.xml-util.xml-util.createtag.param"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>string $tagname</parameter> - name of the tag to count </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.xml.xml-statistics.xml-statistics.counttag.return"> &title.returns; <para> <emphasis>integer</emphasis> occurences of the tag </para> </refsect1> <refsect1 id="package.xml.xml-statistics.xml-statistics.counttag.note"> &title.note; &note.notstatic; </refsect1> <refsect1 id="package.xml.xml-statistics.xml-statistics.counttag.see"> &title.see; <para> <link linkend="package.xml.xml-statistics.xml-statistics.counttagsindepth"><function>XML_Statistics::countTagsInDepth</function></link> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t sgml-parent-document:nil sgml-default-dtd-file:"../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> Index: peardoc/en/package/xml/xml-statistics/xml-statistics/counttagsindepth.xml +++ peardoc/en/package/xml/xml-statistics/xml-statistics/counttagsindepth.xml <!-- $Revision: 1.1 $ --> <refentry id="package.xml.xml-statistics.xml-statistics.counttagsindepthsindepth"> <refnamediv> <refname><function>XML_Statistics::countTagsInDepth</function></refname> <refpurpose>count the tags in a certain depth</refpurpose> </refnamediv> <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo> require_once 'XML/Statistics.php'; </funcsynopsisinfo> <funcprototype> <funcdef>integer <function>XML_Statistics::counttagsindepth</function></funcdef> <paramdef>integer <parameter>$depth</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> <refsect1 id="package.xml.xml-statistics.xml-statistics.counttagsindepth.desc"> &title.desc; <para> Thru nesting a tag can be at a certain depth. The root tag is at depth zero. By counting the amount of tags in a depth you can count the number of recordsets in an XML document. </para> </refsect1> <refsect1 id="package.default.xml-util.xml-util.createtag.param"> &title.param; <para> <itemizedlist> <listitem> <para> <parameter>integer $depth</parameter> - tag depth (0 is root) </para> </listitem> </itemizedlist> </para> </refsect1> <refsect1 id="package.xml.xml-statistics.xml-statistics.counttagsindepth.return"> &title.returns; <para> <emphasis>integer</emphasis> number of tags in this depth </para> </refsect1> <refsect1 id="package.xml.xml-statistics.xml-statistics.counttagsindepth.note"> &title.note; &note.notstatic; </refsect1> <refsect1 id="package.xml.xml-statistics.xml-statistics.counttagsindepth.see"> &title.see; <para> <link linkend="package.xml.xml-statistics.xml-statistics.counttag"><function>XML_Statistics::countTag</function></link> </para> </refsect1> </refentry> <!-- Keep this comment at the end of the file Local variables: mode: sgml sgml-omittag:t sgml-shorttag:t sgml-minimize-attributes:nil sgml-always-quote-attributes:t sgml-indent-step:1 sgml-indent-data:t sgml-parent-document:nil sgml-default-dtd-file:"../../../manual.ced" sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil End: vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 -->