svn: /pear/peardoc/trunk/en/package/console/ console-progressbar.xml

cweiske                                  Thu, 15 Oct 2009 04:37:53 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=289650

Log:
Fix bug #13925: render options missing

Bug: http://pear.php.net/bugs/13925 (unknown) 
      
Changed paths:
    U   pear/peardoc/trunk/en/package/console/console-progressbar.xml

Modified: pear/peardoc/trunk/en/package/console/console-progressbar.xml
===================================================================
--- pear/peardoc/trunk/en/package/console/console-progressbar.xml	2009-10-15 03:45:14 UTC (rev 289649)
+++ pear/peardoc/trunk/en/package/console/console-progressbar.xml	2009-10-15 04:37:53 UTC (rev 289650)
@@ -1,5 +1,9 @@
 <?xml version="1.0" encoding="utf-8"?>
-<book xmlns="http://docbook.org/ns/docbook" version="lillet" xml:id="package.console.console-progressbar">
+<book xmlns="http://docbook.org/ns/docbook"
+ xmlns:phd="http://www.php.net/ns/phd"
+ version="lillet"
+ xml:id="package.console.console-progressbar"
+>
  <info>
   <title>Console_ProgressBar</title>
  </info>
@@ -11,8 +15,8 @@
   progress bar in the console/terminal.
  </para>

- <example><info><title>Some progress bar examples</title></info>
-
+ <example>
+  <info><title>Some progress bar examples</title></info>
   <screen><![CDATA[
 This will display a very simple bar:
 =====================================================
@@ -52,7 +56,7 @@
    <listitem>
     <para>
      Call
-     <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&phpdocbase.console-progressbar;update"><function>update</function></link>
+     <phd:pearapi phd:package="Console_ProgressBar" phd:linkend="Console_ProgressBar::update">update()</phd:pearapi>
      whenever some progress has
      been made.
     </para>
@@ -60,14 +64,14 @@
    <listitem>
     <para>
      (optional)
-     <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&phpdocbase.console-progressbar;erase"><function>erase</function></link>.
+     <phd:pearapi phd:package="Console_ProgressBar" phd:linkend="Console_ProgressBar::update">erase()</phd:pearapi>
      after you're finished.
     </para>
    </listitem>
  </orderedlist>

- <example><info><title>Simple progressbar example</title></info>
-
+ <example>
+  <info><title>Simple progressbar example</title></info>
   <programlisting role="php"><![CDATA[
 <?php
 require_once 'Console/ProgressBar.php';
@@ -89,6 +93,8 @@
  </example>

  </chapter>
+
+
  <chapter>
   <info>
    <title>Creating the bar</title>
@@ -114,7 +120,7 @@
    <listitem>
     <para>
      <literal>%current%</literal> is the current value set via
-     <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&phpdocbase.console-progressbar;update"><function>update</function></link>.
+     <phd:pearapi phd:package="Console_ProgressBar" phd:linkend="Console_ProgressBar::update">update()</phd:pearapi>.
     </para>
    </listitem>
    <listitem>
@@ -173,7 +179,15 @@
    example, if you wanted to display a progress bar for a download of a
    file that is 115 KB big, you would pass 115 here.
   </para>
+
+  <para>
+   For the full documentation of all parameters, see the API documentation
+   of
+   <phd:pearapi phd:package="Console_ProgressBar" phd:linkend="Console_ProgressBar::reset">reset()</phd:pearapi>.
+  </para>
  </chapter>
+
+
  <chapter>
   <info>
    <title>Updating and finishing</title>
@@ -183,13 +197,13 @@
    After setting up the progress bar, you can start doing the real work
    - up- or downloading files, calculating something etc.
    Whenever you did a step forward, call
-   <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&phpdocbase.console-progressbar;update"><function>update</function></link>
+   <phd:pearapi phd:package="Console_ProgressBar" phd:linkend="Console_ProgressBar::update">update()</phd:pearapi>
    with the current step number.
   </para>
   <para>
    When you're finished, you may want to remove the progress bar from
    screen - use
-   <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="&phpdocbase.console-progressbar;erase"><function>erase</function></link>
+   <phd:pearapi phd:package="Console_ProgressBar" phd:linkend="Console_ProgressBar::erase">erase()</phd:pearapi>
    for this.
   </para>
  </chapter>