WB 2.08.x

show_menu2, version 4.9

=======================

can be generated with extensive customisation of the resulting HTML.

   the "Uninstall Module" list and choose the "Uninstall" button.

5. In the "Install Module" section, enter the path to the show_menu2 zip file

   that you downloaded in step 1, and choose the "Install" button.

USING SHOW_MENU2

================

wish to have the menu displayed. Remember when you replace calls to the old

Often times the default menu generated by show_menu2 is all that you need.

This menu shows the current page and children of the current page. It is

generated by just calling show_menu2 with no parameters. For example:

    show_menu2();

Note that the call to show_menu2 is PHP, so you usually need to wrap it in the

PHP code brackets so that it will execute. Like this:

This default menu generates a complete list based menu with many classes that

allow easy CSS styling. For example, the current menu item will have the

"menu-current" class added to the <li> tag. Additionally, every menu item with

you to create CSS rules to style those menu items differently. For example:

    li.menu-expand  { font-weight: bold; }

    li.menu-current { background: red; }

to show only menu items from the top level of the menu you use:

    show_menu2(0, SM2_ROOT, SM2_START);

Alternatively, to show up to two levels of the child menus of the current page:

    show_menu2(0, SM2_CURR+1, SM2_CURR+2);

There are many more possible menus that can be generated by show_menu2. See the

COMMON QUESTIONS

================

A:  Nup. This is it. Go hard. Gambarre.

Q:  How do I create a drop-down menu?

    to display the menu as a drop-down. Try the "allcss2" template from the WB

Q:  Why does the menu disappear after I do a search on my multilingual WB site?

A:  You're missing some required lines in your template.

        <input type="hidden" name="referrer" value="[REFERRER_ID]" />

        immediately following the search <form> open tag.

        <input type="hidden" name="referrer" value="<?php echo defined('REFERRER_ID')?REFERRER_ID:PAGE_ID;?>" />

Q:  Multilingual? That sounds cool. How do I do that?

Q:  SM2 is generating a warning every time the page is accessed:

    "show_menu2 error: $aOptions is invalid. No flags from group 1 supplied!"

    correct flag values to pass for the $aOptions parameter.

Q:  How do I use a different class/picture/color/widget for each entry in a menu?

    class or id for each menu item, then reference that item in your CSS or Javascript

    to do whatever you want.

    To add a unique class for each menu item (or similar):

        "<li><a href="[url]" target="[target]" class="[class] p[page_id]">[menu_title]</a>"

        ... creating menu items like ...

        <li><a href="/pages/foo/bar.php" target="_top" class="menu-top p45">Top Menu</a>

        Reference this in your CSS like:

        a.p45 { color: red; }

    To add a unique ID for each menu item (or similar):

        "<li><a id="p[page_id]" href="[url]" target="[target]" class="[class]">[menu_title]</a>"

        ... creating menu items like ...

        <li><a id="p45" href="/pages/foo/bar.php" target="_top" class="menu-top">Top Menu</a>

        Reference this in your CSS like:

        a#p45 { color: red; }

        Note that the ID can only be used if that menu is generated and displayed one time

FUNCTION

========

Ensure that you use each parameter correctly. Use the following rules:

    $aMenu will be 0 for most people.

    $aStart must be either a page ID or a value starting with "SM2_".

    $aMaxLevel must be only values that start with "SM2_".

    in a very small minority of users).

    output for menus and menu items.

the default value.

HTML OUTPUT

===========

for each menu. Note that items will have multiple classes when relevant.

    CLASS           ATTACHED TO

    The following classes are added only if SM2_NUMCLASS flag has been used.

                    menu is always menu-0, the next level is menu-1, etc.

                    with the relative depth of the submenu starting at 0.

PARAMETERS

==========

    page. Supplying SM2_ALLMENU will return all menus in the system.

    Specify where the menu generation should start from. This is most

    following values:

        SM2_ROOT+N  Start N levels down from the root. e.g.

                      SM2_ROOT+1    Start 1 level below the root

                      SM2_ROOT+2    Start 2 levels below the root

        SM2_CURR+N  Start N levels down from the current page level. e.g.

                      SM2_CURR+1    Starts 1 level down from the current

                                    page with the children menus.

        page_id     Display using the specific page as the parent. All

                        http://SITE/admin/pages/modify.php?page_id=35

    Maximum menu level to display. Menus are displayed from the start

    level down to this level.

        SM2_ALL     No limit, all levels are displayed

                      SM2_CURR      Current (no children)

                      SM2_CURR+3    All parents + current + 3 children

        SM2_START+N Always show from the starting level + N levels. The

                    what level the current page is.

                      SM2_START     Single level of menus from starting level

                      SM2_START+1   Starting level and 1 level down

                    won't be shown if they are below the current level.

                      SM2_MAX       Starting level only (same as SM2_START)

                      SM2_MAX+1     Maximum of starting level and 1 level.

    Specify flags for different generation options for the menu. The flags

    may be combined together using bitwise OR (|). For example, to specify

    both TRIM and PRETTY you should use, (SM2_TRIM | SM2_PRETTY).

    GROUP 1

    -------

    SM2_ALL         Show all branches of the menu tree

                            -> B-2 -> C-1

                                   -> C-2 (CURRENT)

                                          -> D-1

                                   -> C-3

                        A-2 -> B-3

                            -> B-4

                    are removed.

                            -> B-2 -> C-1

                                   -> C-2 (CURRENT)

                                          -> D-1

                                          -> D-2

                                   -> C-3

    SM2_CRUMB       Show only the breadcrumb trail, i.e. the current

                    menu and all of it's ancestor menus.

                        A-1 -> B-2 -> C-2 (CURRENT)

                    trimmed to show only the path.

                        A-1 -> B-2 -> C-1

                                   -> C-2 (CURRENT)

    -------

    All of these flags are optional. Any number of them may be combined.

                    classes will be added.

    SM2_ALLINFO     Load all fields from the page table of the database.

                    This will result in quite a lot of memory being used

                    and is not recommended, however it will make keywords,

                    NOTE: This flag must be used on the *FIRST* call to

                    show_menu2 *for this menu ID*, or in combination with

                    SM2_NOCACHE otherwise it will have no effect.

    SM2_NOCACHE     Do not reuse or store the data read from the database

    SM2_PRETTY      Pretty print the menu HTML with spacing and newlines

                    for debugging purposes.

                    internally and return it as a string from show_menu2.

                    Only items in the current menu tree will be output.

                    This can be combined with any of the Group 1 flags as

                    necessary.

    SM2_ESCAPE      Call htmlspecialchars on the menu strings. This may be

                    required with older installations of WB. By escaping the

                    formatting in them that would cause otherwise cause

                    when they are active (i.e. current page or a parent page).

                    Use private pages for time when you want pages to be

                    hidden except when active. However for compatibility with

	SM2_NO_TITLE	Supress the value of the 'title'-attributes on links which

					are created by [a] or [ac] formatted links.

    Most users will NOT need to use this.

$aItemOpen

    Format string to use for creating each individual menu item entry.

    false, it uses the default of '[li][a][menu_title]</a>' to maintain

    compatibility with show_menu(). Note however that CSS formatting is

    often easier if the classes are added to the <a> tag. Use the format

    string of '<li>[ac][menu_title]</a>' for this style of tag.

    class for the menu. See the section "Formatter" below for details of

    arguments after $aItemOpen are ignored.

$aItemClose

    String used to close each item. Note that this is not a format

    the default of '</li>'.

$aMenuOpen

    false, it uses the default of '[ul]'.

$aMenuClose

    String used to close each menu. Note that this is not a format

    the default of '</ul>'.

$aTopItemOpen

    format as $aItemOpen.

    format as $aMenuOpen.

EXTENDED OPTIONS

================

The $aOptions parameter is a dual mode parameter. For most users, only the

must be supplied as an associative array. Note that the SM2_* flags are

still required and must be supplied as 'flags'.

    'flags'     **REQUIRED** These are the flags described in PARAMETERS

                $aStart that will always be displayed. This will cause the

                SM2_TRIM flag to be ignored for these levels.

should be created and passed as the $aOptions parameter:

    $options = array('flags' => (SM2_TRIM|...), 'notrim' => 1);

    show_menu2(0, SM2_ROOT, SM2_CURR+1, $options);

FORMAT STRINGS

==============

$aMenuOpen and will be replaced with the appropriate text.

[a]             <a> tag (no class):         '<a href="[url]" target="[target]">'

    [if(A){B}]

    [if(A){B}else{C}]

    A   Conditional test. See below for more details.

        exception of the conditional test (because '}' is not permitted).

        exception of the conditional test (because '}' is not permitted).

The conditional test is a combination of one or more boolean tests.

If more than one test is supplied, it must be combined with other tests

A single test is made up of the left operand, operator and right operand.

e.g. X == Y where X is the left operand, == is the operator and Y is the

right operand.

    Left operand. It must be one of the following keywords:

        class       Test for existence of one of the classes. Only the

                    "==" and "!=" operators are permitted. In this case

                    instead of "equals".

        level       Test against the page level.

        sib         Test against the current page sibling number.

        sibCount    Test against the number of siblings in the menu.

        id          Test against the page id.

		target		Test against the target attribute

    Operator. It must be one of the following:

        <           Less Than

        <=          Less Than Equals

        !=          Not Equal

        >=          Greater Than Equals

        >           Greater Than

    Right operand. The type of this operand depends on the keyword used

    for the left operand:

                    section "OUTPUT".

        level       Test the page level against the following values:

                      <number>  absolute page level

                    the count of siblings in this menu.

        sibCount    A positive integer.

		target		A string, containing a possible target

For example, valid tests are expression "exp" is emitted only when the menu item:

    [if(class==menu-expand){exp}]   has a sub-menu

    [if(class==menu-first){exp}]    is first item in a menu

    [if(class!=menu-first){exp}]    is NOT first item in a menu

    [if(id==parent){exp}]           is the parent of the current page

	[if(target==_self){exp}]		if value of target-attribute is '_self'

emitted in all other cases. For example the expression "foo" is emitted

whenever the if-test is false, so therefore:

For multiple tests, the expression "exp" is emitted only when the menu item:

        [is the first item] OR [is the 4th or larger item] in the menu

    [if(id == current && class == menu-expand){exp}

        [is the current item] AND [it has children]

Note that all tests are evaluated in the order listed because:

 * there is no short-circuit evaluation (all individual tests are always evaluated)

 * there is no grouping of tests (i.e. no support for parenthesis)

=========

Note: This is an advanced and rarely needed feature!

predefined menu formatter that show_menu2 is uses with a custom module. See the

written. The API it must use is:

class SM2_Formatter

{

    // called once before any menu is processed to allow object initialization

    function initialize() { }

    // called to open the menu list

    function startList($aPage, $aUrl) { }

    // called to open the menu item

    function startItem($aPage, $aUrl, $aCurrSib, $aSibCount) { }

    // called to close the menu item

    function finishItem() { }

    // called to close the menu list

    function finishList() { }

    // called once after all menu has been processed to allow object finalization

    function finalize() { }

    // called once after finalize() if the SM2_NOOUTPUT flag is used

    function getOutput() { }

};