phplib-commit

[Richard A. <ric...@us...>]

Update of /cvsroot/phplib/php-lib/doc/sgml
In directory usw-pr-cvs1:/tmp/cvs-serv5541

Modified Files:
	05-menu.sgml 
Log Message:
update menu.inc documentation

Index: 05-menu.sgml
===================================================================
RCS file: /cvsroot/phplib/php-lib/doc/sgml/05-menu.sgml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** 05-menu.sgml	1999/12/12 16:29:52	1.2
--- 05-menu.sgml	2001/08/20 06:36:52	1.3
***************
*** 49,55 ****
  extra level of indentation.<rowsep>
  
! $title<colsep>String. After calling <tt/get&lowbar;title()/, this variable contains the title of the page based on it's location in the menu hierarchy.<rowsep>
  
! $title&lowbar;delim<colsep>String. Used to delimit (i.e., separate) components in the page title built by <tt/get&lowbar;title()/. Default is <tt>" : "</tt><rowsep>
  
  </tabular>
--- 49,59 ----
  extra level of indentation.<rowsep>
  
! $title<colsep>String. After calling <tt/get&lowbar;title()/, this 
! variable contains the title of the page based on it's location in 
! the menu hierarchy.<rowsep>
  
! $title&lowbar;delim<colsep>String. Used to delimit (i.e., separate) 
! components in the page title built by <tt/get&lowbar;title()/. 
! Default is <tt>" : "</tt><rowsep>
  
  </tabular>
***************
*** 126,129 ****
--- 130,143 ----
  title and returns the title as a string.
  
+ <tag>get&lowbar;sitemap()</tag>
+ <p>
+ 
+ This function is identical to <tt/print $this->get()/ except that
+ all menu items are shown, not just the ones visible from the current page.
+ 
+ <tag>show&lowbar;sitemap()</tag>
+ <p>
+ A shorthand notation for <tt/print $this->get&lowbar;sitemap()/.
+ 
  <tag>setup()</tag> 
  <p> 
***************
*** 175,179 ****
  <tt/menu.inc/ in <tt/prepend.php3/. To use
  <tt/Menu&lowbar;Button/, you must enable the require statement
! for <tt/menu.inc/ and <tt/menu_button.inc/ in <tt/prepend.php3/.
  
  Use a subclass of either <tt/Menu/ or <tt/Menu&lowbar;Button/ to
--- 189,193 ----
  <tt/menu.inc/ in <tt/prepend.php3/. To use
  <tt/Menu&lowbar;Button/, you must enable the require statement
! for <tt/menu.inc/ and <tt/menu&lowbar;button.inc/ in <tt/prepend.php3/.
  
  Use a subclass of either <tt/Menu/ or <tt/Menu&lowbar;Button/ to
***************
*** 183,188 ****
  
  <tscreen><code>
! class Example_Menu extends Menu {
!   # Map of PHP_SELF URL strings to menu positions
    var $urlmap = array(
      "/menu/index.php3"   =&gt; "",
--- 197,202 ----
  
  <tscreen><code>
! class Example&lowbar;Menu extends Menu {
!   # Map of PHP&lowbar;SELF URL strings to menu positions
    var $urlmap = array(
      "/menu/index.php3"   =&gt; "",
***************
*** 216,220 ****
    );
  
!   function Example_Menu() {
      $this-&gt;setup();
    }
--- 230,234 ----
    );
  
!   function Example&lowbar;Menu() {
      $this-&gt;setup();
    }
***************
*** 228,232 ****
  <tscreen><code>
  &lt;?php
!   $m = new Example_Menu;
   ?&gt;&lt;html&gt;
  &lt;head&gt;
--- 242,246 ----
  <tscreen><code>
  &lt;?php
!   $m = new Example&lowbar;Menu;
   ?&gt;&lt;html&gt;
  &lt;head&gt;