O4WMenu routine [Revelation On-Line Wiki]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== O4WMenu routine     ======


 
==== Description ====
 
Builds a menu on the current page using the menu definition.
 
==== Syntax ====
 
O4WMenu(menuName, errMsg, replaceName, overrideType, styleInfo)
 
==== Parameters ====
 
The function has the following parameters:

^Parameter^Description^
|menuName|The menu definition.  \\ \\ The location and type of the menu is determined by the location of special “tags” in the template.  These tags should be placed in the template wherever the menu should be displayed, along with an optional orientation to specify which type of menu should be used.  The standard tags are %MENU-H% (for a horizontal menu), %MENU-V% (for a vertical menu), %MENU-T% (for a tree menu), or %MENU% (to use the orientation specified in the configuration record).  A special tag, %MENU-NONE%, is used to indicate that no menu should be displayed.  Users can also create additional “named” menu tags for specific menus; these are accessed by specifying which named menu to use in the specificName parameter.  Specific menu tags can be placed in the template by using the format “%MENU.<specificname>{-<orientation>}%” (for example, “%MENU.leftside%” or “%MENU.top-H%”), where <orientation> can be “H” (for Horizontal), “V” (for vertical), “T” (for a tree menu), or “NONE” to indicate the menu should NOT be displayed.  If <orientation> is omitted, the default orientation specified in the configuration record is used.\\ \\ If no menu tags are found for either the default or named menus, the menu is drawn at the current location in the “flow” of the web page output.|
|errMsg|A string is placed in this parameter if an error is encountered.|
|replaceName|The name of tag to look for in the template.  Defaults to "MENU".|
|overrideType|The type of menu to draw, overriding what is found in the template.\\ \\  0 - Vertical Menu\\ 1 - Horizontal Menu\\ 2 - Tree Menu|
|styleInfo|The style values to be applied to the menu.  Include support for the O4WHTMLOptions for "return html".||