WB 2.08.x

<?php

/**

 *

 * @category        modules

 * @package         show_menu2

 * @author          Independend-Software-Team

 * @author          WebsiteBaker Project

 * @copyright       2004-2009, Ryan Djurovich

 * @copyright       2009-2011, Website Baker Org. e.V.

 * @link            http://www.websitebaker2.org/

 * @license         http://www.gnu.org/licenses/gpl.html

 * @platform        WebsiteBaker 2.8.x

 * @requirements    PHP 5.2.2 and higher

 * @version         $Id$

 * @filesource      $HeadURL$

 * @lastmodified    $Date$

 *

 */

// Must include code to stop this file being access directly

if(defined('WB_PATH') == false) { exit("Cannot access this file directly"); }

?>

<?php

/**

 *

 * @category        modules

 * @package         show_menu2

 * @author          Independend-Software-Team

 * @author          WebsiteBaker Project

 * @copyright       2004-2009, Ryan Djurovich

 * @copyright       2009-2011, Website Baker Org. e.V.

 * @link            http://www.websitebaker2.org/

 * @license         http://www.gnu.org/licenses/gpl.html

 * @platform        WebsiteBaker 2.8.x

 * @requirements    PHP 5.2.2 and higher

 * @version         $Id$

 * @filesource      $HeadURL$

 * @lastmodified    $Date$

 *

 */

// Must include code to stop this file being access directly

if(defined('WB_PATH') == false) { die("Cannot access this file directly"); }

?>

<?php

/**

 *

 * @category        module

 * @package         show_menu2

 * @author          WebsiteBaker Project

 * @copyright       2004-2009, Ryan Djurovich

 * @copyright       2009-2011, Website Baker Org. e.V.

 * @link			http://www.websitebaker2.org/

 * @license         http://www.gnu.org/licenses/gpl.html

 * @platform        WebsiteBaker 2.7.0 | 2.8.x

 * @requirements    PHP 5.2.2 and higher

 * @version         $Id$

 * @filesource		$HeadURL$

 * @lastmodified    $Date$

 *

 */

/*

    This file provides backward compatibility between show_menu2 and the

    old functions show_menu() and menu(). Note that it is highly recommended 

    for you to update your templates to use show_menu2 directly.

 */    

/* ----------------------------------------------------------------------------

   show_menu

 From: http://forum.websitebaker.org/index.php/topic,2251.msg13978.html#msg13978  

 * By calling it multiple times, you can have one menu just

 * showing the root level, one for the sub-pages, and so on

 * The order of the arguments has been changed compared

 * to the page_menu() function, so read carefully the list

 * of arguments!

 * To just display the standard menu, use

 * <?php show_menu(); ?> within your template's html code.

 * You don't normally need anymore than the first four arguments.

 * Usual calls would be (inside php code!)

 * show_menu(1,0,-1,false); - displays the complete page tree

 * show_menu(1,1,1); - show only first sub level

 * show_menu(1,1,-1); -    show an expanding/collapsing menu tree starting at level 1

 * Have fun experimenting!

 *

 * Full list of arguments:

 * 1. $menu_number:   With activitated "multiple menu" feature

 *                  you can choose which menu will be displayed

 *                  default: 1

 * 2. $start_level: The depth level of the root of the displayed

 *               menu tree. Defaults to '0', which is the top level.

 *                  '1' will show all pages starting from the first sub level.

 * 3. $recurse:     Gives the maximum number of levels to be displayed. Default

 *                  is '-1' which means 'all'.

 * 4. $collapse:    Specifies, whether the menu tree shall be

 *               expandable/collapsible (if set to 'true')

 *               or complete (all pages being displayed) if set to 'false'

 * 5. $item_template: Gives the possibility to specify the html code that is

 *                  displayed before displaying sub-pages

 * 6. $item_footer: The html code to appear after sub-pages were displayed.

 * 7. $menu_header: The html code to appear before the entire menu code and each

 *               sub tree.

 * 8. $menu_footer: The html code to appear after the entire menu code and each

 *               sub tree.

 * 9. $default_class: The (CSS) class of every menu item except the currently viewed page

 * 10. $current_class: The class of the currently viewed page

 * 11. $parent:    (used internally) The page_id of the menu's root node, defaults is '0' (root level)

 */

// Must include code to stop this file being access directly

if(defined('WB_PATH') == false) { die("Cannot access this file directly"); }

class SM2_ShowMenuFormatter

{

    var $output;

    var $itemTemplate;

    var $itemFooter;

    var $menuHeader;

    var $menuFooter;

    var $defaultClass;

    var $currentClass;

    function output($aString) {

        if ($this->flags & SM2::BUFFER) {

            $this->output .= $aString;

        }

        else {

            echo $aString;

        }

    }

    function initialize() { $this->output = ''; }

    function startList($aPage, $aUrl) { 

        echo $this->menuHeader;

    }

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

        // determine the class string to use

        $thisClass = $this->defaultClass;

        if ($aPage['page_id'] == PAGE_ID) {

            $thisClass = $this->currentClass;

        }

        // format and display this item

        $item = str_replace( 

                array(

                    '[a]','[/a]','[menu_title]','[page_title]','[url]',

                    '[target]','[class]'

                    ),

                array(

                    "<a href='$aUrl' target='".$aPage['target']."'>", '</a>',

                    $aPage['menu_title'], $aPage['page_title'], $aUrl, 

                    $aPage['target'], $thisClass

                    ),

                $this->itemTemplate);

        echo $item;

    }

    function finishItem() { 

        echo $this->itemFooter;

    }

    function finishList() { 

        echo $this->menuFooter;

    }

    function finalize() { }

    function getOutput() {

        return $this->output;

    }

}

function show_menu(

    $aMenu          = 1, 

    $aStartLevel    = 0, 

    $aRecurse       = -1, 

    $aCollapse      = true,

    $aItemTemplate  = '<li><span[class]>[a][menu_title][/a]</span>',

    $aItemFooter    = '</li>',

    $aMenuHeader    = '<ul>',

    $aMenuFooter    = '</ul>',

    $aDefaultClass  = ' class="menu_default"',

    $aCurrentClass  = ' class="menu_current"',

    $aParent        = 0

    )

{

    static $formatter;

    if (!isset($formatter)) {

        $formatter = new SM2_ShowMenuFormatter;

    }

    $formatter->itemTemplate  = $aItemTemplate;

    $formatter->itemFooter    = $aItemFooter;  

    $formatter->menuHeader    = $aMenuHeader;  

    $formatter->menuFooter    = $aMenuFooter;  

    $formatter->defaultClass  = $aDefaultClass;

    $formatter->currentClass  = $aCurrentClass;

    $start = SM2::ROOT + $aStartLevel;

    if ($aParent != 0) {

        $start = $aParent;

    }

    $maxLevel = 0;

    if ($aRecurse == 0) {

        return;

    }

    if ($aRecurse < 0) {

        $maxLevel = SM2::ALL;

    }

    else {

        $maxLevel = SM2::START + $aRecurse - 1;

    }

    $flags = $aCollapse ? SM2::TRIM : SM2::ALL;

    // special case for default case

    if ($aStartLevel == 0 && $aRecurse == -1 && $aCollapse) {

        $maxLevel = SM2::CURR + 1;

    }

    show_menu2($aMenu, $start, $maxLevel, $flags, $formatter);

}

function page_menu(

    $aParent = 0, 

    $menu_number = 1, 

    $item_template = '<li[class]>[a][menu_title][/a]</li>', 

    $menu_header = '<ul>', 

    $menu_footer = '</ul>', 

    $default_class = ' class="menu_default"', 

    $current_class = ' class="menu_current"', 

    $recurse = LEVEL    // page['level']

    ) 

{

    show_menu($menu_number, 0, $recurse+2, true, $item_template, '', 

        $menu_header, $menu_footer, $default_class, $current_class, $aParent);

}

?>

show_menu2, version 4.9

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

A code snippet for the Website Baker CMS software. It provides a complete

replacement for the builtin menu functions. All menu data is retrieved using

a single database query, all types of menu styles (lists, breadcrums, sitemaps)

can be generated with extensive customisation of the resulting HTML.

INSTALLATION

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

1. Download the latest version from http://code.jellycan.com/show_menu2/

2. Log into your WebsiteBaker installation

3. Go to Addons -> Modules

4. If a previous version of show_menu2 is already installed, select it from

   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

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

You need to modify the PHP files of your template to call show_menu2 where you

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

menu functions to use the new parameters that show_menu2 requires.

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:

    <?php show_menu2(); ?>

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

a sub-menu will have the "menu-expand" class added to the <li> tag. This allows

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

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

    li.menu-current { background: red; }

See the "Output" section for details of exactly what classes are added to each

element. More elaborate and different menu structures are able to be created by

supplying different parameters to the show_menu2 function call. For example,

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

demonstration website at http://code.jellycan.com/sm2test/ for more examples.

COMMON QUESTIONS

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

Q:  I'm not a programmer. Do you have simpler documentation?

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

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

A:  This is unrelated to show_menu2. You need to change the template CSS code

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

    addon repository. http://addons.websitebaker.org/

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.

    1.  Log into WB administration, and go to Settings -> Show advanced settings

        -> Search Settings -> Header Code and add the following input field

        after the <form> open tag:

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

    2.  In the index.php of your template, add the following input field

        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?

A:  http://www.websitebaker2.org/en/help/designer-guide/multilingual-websites.php

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

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

A:  You are passing the wrong values to the function. Have a closer look at the

    parameters that you are passing. See the PARAMETERS section below for the

    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?

A:  Use the [page_id] format string in the $aItemOpen string. Create a unique

    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

        only on the page (because HTML ID's must be unique within a page).

FUNCTION

========

The complete call signature and default parameter value for show_menu2 is:

    show_menu2(

        $aMenu          = 0,

        $aStart         = SM2_ROOT,

        $aMaxLevel      = SM2_CURR+1,

        $aOptions       = SM2_TRIM,

        $aItemOpen      = '[li][a][menu_title]</a>',

        $aItemClose     = '</li>',

        $aMenuOpen      = '[ul]',

        $aMenuClose     = '</ul>',

        $aTopItemOpen   = false,

        $aTopMenuOpen   = false

        )

See the "Parameters" section for detailed descriptions of each parameter.

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_".

    $aOptions must be only values that start with "SM2_" (unless you are

    in a very small minority of users).

    All other parameters are the HTML tag templates that will be

    output for menus and menu items.

Note that every parameter from $aItemOpen can be supplied as false to get

the default value.

HTML OUTPUT

===========

The menu is output differently depending on what parameters have been

supplied to the function, however in general the following classes are used

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

    CLASS           ATTACHED TO

    ------------    -------------------------------------------------------

    menu-top        First menu tag only

    menu-parent     Every parent menu item of the current page.

    menu-current    Only the menu item for the current page.

    menu-sibling    Every sibling of the current page.

    menu-child      Every sub-menu of the current page.

    menu-expand     Every menu item with children.

    menu-first      First item in any menu or sub-menu.

    menu-last       Last item in any menu or sub-menu.

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

    menu-N          Every menu item. The N is replaced with the ABSOLUTE

                    menu depth of the item starting with 0. The root level

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

    menu-child-N    Every sub-menu of the current page, the N is replaced

                    with the relative depth of the submenu starting at 0.

<ul class="menu-top menu-0">

  <li class="menu-0 menu-first">  ... </li>

  <li class="menu-0 menu-expand menu-parent">  ...

  <ul class="menu-1">

    <li class="menu-1 menu-expand menu-first">  ...

    <ul class="menu-2">

      <li class="menu-2 menu-first">  ...

      <li class="menu-2 menu-last">  ...

    </ul>

    </li>

    <li class="menu-1 menu-expand menu-parent">  ...

    <ul class="menu-2">

      <li class="menu-2 menu-expand menu-current menu-first">  ...      ** CURRENT PAGE **

      <ul class="menu-3">

        <li class="menu-3 menu-child menu-child-0 menu-first">  ...

        <ul class="menu-4">

          <li class="menu-4 menu-child menu-child-1 menu-first">  ... </li>

          <li class="menu-4 menu-child menu-child-1 menu-last">  ... </li>

        </ul>

        </li>

        <li class="menu-3 menu-child menu-child-0 menu-last">  ... </li>

      </ul>

      </li>

      <li class="menu-2 menu-sibling menu-last">  ... </li>

    </ul>

    </li>

    <li class="menu-1">  ... </li>

    <li class="menu-1 menu-expand menu-last">  ...

    <ul class="menu-2">

      <li class="menu-2 menu-first menu-last">  ... </li>

    </ul>

    </li>

  </ul>

  </li>

  <li class="menu-0 menu-last">  ... </li>

</ul>

PARAMETERS

==========

$aMenu

    Menu number to use. This is useful when you are using multiple menus.

    Supplying a menu number of 0 will use the default menu for the current

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

$aStart

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

    times the parent item of the menu to display. It must be one of the

    following values:

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

                      SM2_ROOT      Starting at the root menu

                      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      Starts at the current page level. All

                                    sibling menus to the current page.

                      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

                    child menus of that page will be displayed. The

                    page_id can be found by editing the page in WB admin

                    interface. The page_id is included in the URL like:

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

$aMaxLevel

    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+N  Always show to the current page + N levels.

                      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

                    levels of menu will always be displayed regardless of

                    what level the current page is.

                      SM2_START     Single level of menus from starting level

                      SM2_START+1   Starting level and 1 level down

        SM2_MAX+N   Show at most N levels from the starting level. Levels

                    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.

$aOptions

    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

    -------

    Exactly one flag from this group must always be supplied. These flags

    affect how the siblings in the tree are removed from the output.

    SM2_ALL         Show all branches of the menu tree

                        A-1 -> B-1

                            -> B-2 -> C-1

                                   -> C-2 (CURRENT)

                                          -> D-1

                                          -> D-2

                                   -> C-3

                        A-2 -> B-3

                            -> B-4

    SM2_TRIM        Show all sibling menus of pages on the current path.

                    All sub-menus of elements that are not on the path

                    are removed.

                        A-1 -> B-1

                            -> B-2 -> C-1

                                   -> C-2 (CURRENT)

                                          -> D-1

                                          -> D-2

                                   -> C-3

                        A-2

    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)

    SM2_SIBLING     The same as SM2_TRIM however only sibling menus of

                    the current page are displayed. All other menus are

                    trimmed to show only the path.

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

                                   -> C-2 (CURRENT)

                                          -> D-1

                                          -> D-2

                                   -> C-3

    GROUP 2

    -------

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

    SM2_NUMCLASS    Add the numbered menu classes to the menu. If this

                    flag is supplied, the "menu-N" and "menu-child-N"

                    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,

                    descriptions, and other fields available. This data

                    is not loaded by default.

                    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

                    between calls to show_menu2.

    SM2_PRETTY      Pretty print the menu HTML with spacing and newlines

                    for debugging purposes.

    SM2_BUFFER      Do not output the menu HTML but instead buffer it

                    internally and return it as a string from show_menu2.

    SM2_CURRTREE    Exclude all other top level menus from being considered.

                    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

                    raw database strings, it permits menus to have HTML

                    formatting in them that would cause otherwise cause

                    pages to fail validation.

    SM2_SHOWHIDDEN  Hidden pages are usually hidden all of the time, including

                    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

                    release 4.8, supply this flag to enable hidden pages to

                    become visible when they are active.

    SM2_XHTML_STRICT	From all links, created by [a] or [ac], the 'target' -

					attribute will be removed to preserve the XHTML-Compatibility

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

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

    This parameter also has an extended mode where an associative array of

    options is supplied. See the EXTENDED OPTIONS section for details.

    Most users will NOT need to use this.

$aItemOpen

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

    A different format string may be used for the very first entry by

    supplying a different format string for $aTopItemOpen. When set to

    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.

    This parameter may also be specified as an instance of a formatting

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

    the API this class must expose. When a formatter is supplied, all

    arguments after $aItemOpen are ignored.

$aItemClose

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

    string and no keywords will be replaced. When set to false, it uses

    the default of '</li>'.

$aMenuOpen

    Format string to use for opening a list of menu item entries. A

    different format string may be used for the very first menu by

    supplying a different format string for $aTopMenuOpen. When set to

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

$aMenuClose

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

    string and no keywords will be replaced. When set to false, it uses

    the default of '</ul>'.

$aTopItemOpen

    Format string for the first item. When set to false, it uses the same

    format as $aItemOpen.

$aTopMenuOpen

    Format string for the first menu. When set to false, it uses the same

    format as $aMenuOpen.

EXTENDED OPTIONS

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

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

SM2_* flags will be sufficient. However, to access the extra options, it

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

                above for the $aOptions parameter.

    'notrim'    Specify a number of levels relative to the menu level of

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

                SM2_TRIM flag to be ignored for these levels.

To supply one of these options in addition to the flags, the option array

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

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

The following tags may be included in the format strings for $aItemOpen and

$aMenuOpen and will be replaced with the appropriate text.

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

[ac]            <a> tag including class:    '<a href="[url]" target="[target]" class="[class]">'

[li]            <li> tag including class:   '<li class="[class]">'

[ul]            <ul> tag including class:   '<ul class="[class]">'

[class]         List of classes for that page

[menu_title]    Menu title text (HTML entity escaped unless SM2_NOESCAPE flag is used)

[menu_icon_0]	URL poining to an image for display normal - status (from WB2.8.4)

[menu_icon_1]	URL poining to an image for display active/hover - status (from WB2.8.4)

[page_title]    Page title text (HTML entity escaped unless SM2_NOESCAPE flag is used)

[page_icon]		URL poining to an image relating to the current page (from WB2.8.4)

[tooltip]       Tooltip caption, normaly shown in title-attribute of links (ab WB2.8.4)

[url]           Page URL for the <a> tag

[target]        Page target for the <a> tag

[page_id]       Page ID of the current menu item

[parent]        Page ID of the parent menu item

[level]         Page level, the same number as is used for the "menu-N" CSS tag.

[sib]           Current menu sibling number

[sibCount]      Total number of siblings in this menu

[if]            Conditional test (see section CONDITIONAL FORMATTING)

The following tags are only available when the SM2_ALLINFO flag is used.

[description]   Page description

[keywords]      Page keywords

CONDITIONAL FORMATTING

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

The conditional formatting directive takes one of the following forms:

    [if(A){B}]

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

    A   Conditional test. See below for more details.

    B   Expression emitted when the if-test is true. This may be any string

        that does NOT include the '}' character. It may include any of the

        format strings described in the section FORMAT STRINGS with the

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

    C   Expression emitted when the if-test is false. This may be any string

        that does NOT include the '}' character. It may include any of the

        format strings described in the section FORMAT STRINGS with the

        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

using either || (boolean OR) or && (boolean AND).

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

                    these operators have the meaning of "includes"

                    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

        ==          Equals

        !=          Not Equal

        >=          Greater Than Equals

        >           Greater Than

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

    for the left operand:

        class       One of the "menu-*" class names as listed in the

                    section "OUTPUT".

        level       Test the page level against the following values:

                      <number>  absolute page level

                      root      the root page level

                      granny    the grand-parent page level

                      parent    the parent page level

                      current   the current page level

                      child     the child page level

        id          Test the page id against the following values:

                      <number>  absolute page id

                      parent    the parent page id

                      current   the current page id

        sib         A positive integer, or "sibCount" to test against

                    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(class==menu-last){exp}]     is last item in a menu

    [if(level==0){exp}]             is at the root

    [if(level>0){exp}]              is not at the root

    [if(sib==2){exp}]               is the second item in a menu

    [if(sibCount>1){exp}]           is in a menu with more than 1 entry

    [if(sibCount!=2){exp}]          is in a menu which doesn't have exactly

    [if(level>parent){exp}]         is in a sibling menu or child of a sibling

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

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

If an else-clause was added, then the expression for the else would be

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

whenever the if-test is false, so therefore:

    [if(sib==2){exp}else{foo}]          is NOT the second item in a menu

    [if(sibCount>2){exp}else{foo}]      is NOT in a menu with more than 2 entries

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

    [if(sib == 1 || sib > 3){exp}]

        [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)

 * both || and && are considered the same level

FORMATTER

=========

Note: This is an advanced and rarely needed feature!

If you are capable of extensive PHP programming, it is possible to replace the

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

include.php file of show_menu2 for an example of how the menu formatter must be

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() { }

};

<?php

/**

 *

 * @category        modules

 * @package         show_menu2

 * @author          Independend-Software-Team

 * @author          WebsiteBaker Project

 * @copyright       2004-2009, Ryan Djurovich

 * @copyright       2009-2011, Website Baker Org. e.V.

 * @link            http://www.websitebaker2.org/

 * @license         http://www.gnu.org/licenses/gpl.html

 * @platform        WebsiteBaker 2.8.x

 * @requirements    PHP 5.2.2 and higher

 * @version         $Id$

 * @filesource      $HeadURL$

 * @lastmodified    $Date$

 *

 */

// Must include code to stop this file being access directly

if(defined('WB_PATH') == false) { die("Cannot access this file directly"); }

?>

show_menu2, version 4.9

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

Ist ein Code-Snippet für das CMS Website Baker. Es stellt einen kompletten

Ersatz für die eingebaute Menüfuntionalität zur Verfügung. Alle, für die

Erzeugung des Menüs erforderlichen Daten, werden durch eine einzige

Datenbankabfrage erzeugt. Durch umfangreiche Anpassungsmöglichkeiten des

erzeugten HTML-Code können alle möglichen Menüarten (Listen, Breadcrumbs,

Sitemaps, usw.) erzeugt werden.

---

Deutsche Übersetzung von BerndJM. Dies ist eine weitgehend direkte Übersetzung

des englischen Originals. Bei Übersetzungs- oder Interpretationsfehlern, bitte

eine Email an bjm@wwnw.de.

---

INSTALLATION

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

1. Die aktuelle Version von http://code.jellycan.com/show_menu2/ herunterladen.

2. In das Admin-Backend der Website Baker Installation einlogen.

3. Erweiterungen -> Module aufrufen.

4. Wenn bereits eine frühere Version von show_menu2 installiert ist, diese über

   "Modul deinstallieren" auswählen und deinstallieren.

5. Im Abschnitt "Modul installieren" das im Schritt 1 heruntergeladene zip-File

   auswählen und installieren.

BENUTZUNG VON SHOW_MENU2

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

Um show_menu2 zu benutzen muss das verwendete Template an den Stellen

modifiziert werden, an denen das Menü erscheinen soll. Bitte beachten: Wenn alte

Menüaufrufe ersetzt werden, müssen unbedingt auch die entsprechenden neuen

Parameter verwendet werden die show_menu2 benötigt.

In den meisten Fällen genügt bereits der Standardaufruf ohne weitere Parameter

von show_menu2. In diesem Fall werden die Vorgabewerte verwendet, dies erzeugt

ein Menü das die aktuelle Seite und die Unterseiten der aktuellen Seite anzeigt:

    show_menu2();

Bitte beachten: der Aufruf von show_menu2 ist PHP und muss normalerweise in PHP-

Codezeichen eingeschlossen werden (ausser der Aufruf erfolgt bereits innerhalb

von PHP Code):

    <?php show_menu2(); ?>

Dieses Vorgabe Menü erzeugt bereits ein komplettes Menü auf Listenbasis mit

etlichen Klassen, die eine leichte Formatierung mittels CSS ermöglichen. Es wird

z.B. die Klasse "menu-current" zu dem <li> tag des aktuellen Menüpunktes

hinzugefügt. Zusätzlich erhält jeder Menüpunkt der Unterpunkte enthält die

Klasse "menu-expand". Das erlaubt es sehr differenzierte CSS Regeln für die

einzelnen Menüpunkte aufzustellen.

Zum Beispiel:

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

    li.menu-current { background: red; }

Im Abschnitt "HTML-Ausgabe" findet sich eine detaillierte Beschreibung welche

Klassen welchem Element zugeordnet werden. Durch die Verwendung von

verschiedenen Parametern bei dem show_menu2 Funktionsaufruf lassen sich auch

recht umfangreiche und unterschiedliche Menüstrukturen erzeugen. Um

beispielsweise nur Menüpunkte aus der obersten Ebene der Menüstruktur

darzustellen, könnte man folgenden Aufruf verwenden:

    show_menu2(0, SM2_ROOT, SM2_START);

Oder um beispielsweise bis zu zwei Unterebenen der aktuellen Seite anzuzeigen:

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

Es gibt jede Menge Möglichkeiten, um die unterschiedlichsten Menüstrukturen zu

erzeugen. Zahlreiche Beispiele dazu findet man auf der Demo-Website: http://

code.jellycan.com/sm2test/

HÄUFIGE FRAGEN

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

Q:  Ich bin kein Programmierer. Gibt es keine einfachere Dokumentation?

A:  Nein, denn dies hier ist bereits die einfache Dokumentation.

Q:  Wie kann ich ein sogenanntes Drop-Down Menü erstellen?

A:  Dies hat nichts mit show_menu2 zu tun. Um ein Drop-Down Menü zu erzeugen muß

    lediglich der CSS-Code des jeweiligen Templates angepaßt werden. Die nötigen

    Anpassungen findet man z.B. im "allcss2" Template aus dem WB Addon

    Repository -> http://addons.websitebaker.org/

Q:  Warum verschwindet das Menü nachdem ich in einer mehrsprachigen WB-Site die

    Suchfunktion benutzt habe?

A:  Im verwendeten Template fehlen die notwendigen Zeilen:

    1.  Im WB Admin Backend: Optionen -> Erweiterte Optionen anzeigen ->

        Suchoptionen -> Kopfzeile - hier direkt nach dem öffnenden <form> tag

        folgende Zeile einfügen:

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

    2.  In der index.php des verwendeten Templates folgende Zeile unmittelbar

        nach dem öffnenden <form> tag der Suche einfügen:

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

Q:  Mehrsprachig? Das klingt toll. Wie macht man das?

A:  http://www.websitebaker2.org/de/hilfe/designerhandbuch/mehrsprachige-webseiten.php

Q:  Jedesmal wenn eine Seite aufgerufen wird, erzeugt SM2 folgende Warnmeldung:

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

A:  Der Funktion wurden die falschen Werte oder eine falsche Anzahl an

    Werten übergeben.

    Siehe den Abschnitt PARAMETER für die korrekten Flag Werte die dem

    $aOptions Parameter zu übergeben sind.

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

A:  Use the [page_id] format string in the $aItemOpen string. Create a unique

    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

        only on the page (because HTML ID's must be unique within a page).

FUNKTION

========

Der komplette Aufruf und die Vorgabe Parameterwerte für show_menu2 sind wie folgt:

    show_menu2(

        $aMenu          = 0,

        $aStart         = SM2_ROOT,

        $aMaxLevel      = SM2_CURR+1,

        $aOptions       = SM2_TRIM,

        $aItemOpen      = '[li][a][menu_title]</a>',

        $aItemClose     = '</li>',

        $aMenuOpen      = '[ul]',

        $aMenuClose     = '</ul>',

        $aTopItemOpen   = false,

        $aTopMenuOpen   = false

        )

Im Abschnitt "Parameter" findet sich eine detaillierte Beschreibung jedes

einzelnen Parameters.

Jeder Parameter muß absolut korrekt verwendet werden. Folgende Regeln können

dabei helfen:

    $aMenu = 0 ist in den meisten Anwendungsfällen der beste Wert.

    $aStart muß entweder eine page ID oder ein Wert der mit "SM2_" beginnt sein.

    $aMaxLevel kann nur Werte erhalten, die mit "SM2_" beginnen.

    $aOptions bis auf einige wenige Spezialfälle sind hier nur Werte die mit

    "SM2_" beginnen zulässig.

    Alle weiteren Parameter enthalten die (HTML)Tags die die Ausgabe des Menüs

    steuern.

    Ab $aItemOpen kann jedem Parameter der Wert false übergeben werden um den

    jeweiligen Vorgabewert zu erhalten.

    Dies kann beispielsweise verwendet werden um eine nummerierte Liste zu

    erzeugen, während für die einzelnen Menüpunkte trotzdem die Vorgabewerte

    Verwendung finden:

        show_menu2(0, SM2_ROOT, SM2_ALL, SM2_ALL, false, false, '<ol>', '</ol>');

Bitte beachten: bis einschliesslich $aOptions müssen alle Parameter explizit übergeben werden!

HTML-AUSGABE

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

Die HTML-Ausgabe hängt wesentlich davon ab, welche Parameter an die Funktion übergeben werden.

Unabhängig davon werden nachfolgende Klassen grundsätzlich für jedes Menü verwendet, wobei

einzelne Menüpunkte, wenn es erforderlich ist, auch mehrere Klassen erhalten können.

    KLASSE          ZUORDNUNG

    ------------    -------------------------------------------------------

    menu-top        Nur der erste Menüpunkt.

    menu-parent     Jeder Hauptmenüpunkt.

    menu-current    Nur der Menüpunkt der aktuellen Seite.

    menu-sibling    Alle "Geschwister" der aktuellen Seite.

    menu-child      Jedes Untermenü der aktuellen Seite.

    menu-expand     Jedes Menü das Untermenüs hat.

    menu-first      Der erste Punkt eines jeden Menüs oder Untermenüs.

    menu-last       Der letzte Punkt eines jeden Menüs oder Untermenüs.

    Folgende Klassen werden nur hinzugefügt, wenn das SM2_NUMCLASS Flag gesetzt

    ist:

    menu-N          Jeder Menüpunkt, wobei das N für die ABSOLUTE Menütiefe,

                    beginnend bei 0, des jeweiligen Menüpunktes steht.

                    Die oberste Ebene ist also immer menu-0, die nächste

                    Ebene menu-1 usw.

    menu-child-N    Jedes Untermenü der aktuellen Seiten, wobei das N für die

                    RELATIVE Tiefe des Untermenüs, beginnend bei 0, steht.

Beispiel einer HTML-Ausgabe:

<ul class="menu-top menu-0">

  <li class="menu-0 menu-first">  ... </li>

  <li class="menu-0 menu-expand menu-parent">  ...

  <ul class="menu-1">

    <li class="menu-1 menu-expand menu-first">  ...

    <ul class="menu-2">

      <li class="menu-2 menu-first">  ...

      <li class="menu-2 menu-last">  ...

    </ul>

    </li>

    <li class="menu-1 menu-expand menu-parent">  ...

    <ul class="menu-2">

      <li class="menu-2 menu-expand menu-current menu-first">  ...      ** CURRENT PAGE **

      <ul class="menu-3">

        <li class="menu-3 menu-child menu-child-0 menu-first">  ...

        <ul class="menu-4">

          <li class="menu-4 menu-child menu-child-1 menu-first">  ... </li>

          <li class="menu-4 menu-child menu-child-1 menu-last">  ... </li>

        </ul>

        </li>

        <li class="menu-3 menu-child menu-child-0 menu-last">  ... </li>

      </ul>

      </li>

      <li class="menu-2 menu-sibling menu-last">  ... </li>

    </ul>

    </li>

    <li class="menu-1">  ... </li>

    <li class="menu-1 menu-expand menu-last">  ...

    <ul class="menu-2">

      <li class="menu-2 menu-first menu-last">  ... </li>

    </ul>

    </li>

  </ul>

  </li>

  <li class="menu-0 menu-last">  ... </li>

</ul>

PARAMETER

=========

$aMenu

    Nummer des Menüs. Diese ist nützlich um mehrere Menüs auf einer Seite zu

    verwenden.

    Menü Nummer 0 ist das Vorgabemenü der aktuellen Seite, SM2_ALLMENU gibt alle

    im System verwendeten Menüs zurück.

$aStart

    Gibt an, ab welcher Ebene die Erzeugung des Menüs beginnen soll. In den

    meisten Fällen wird dies die oberste Ebene des anzuzeigenden Menüs sein. Es

    kann einer der folgenden Werte verwendet werden:

        SM2_ROOT+N  Beginnt N Ebenen unterhalb der obersten Ebene, z.B.:

                    SM2_ROOT      Beginnt auf der obersten Ebene

                    SM2_ROOT+1    Beginnt eine Ebene unterhalb der obersten Ebene

                    SM2_ROOT+2    Beginnt zwei Ebenen unterhalb der obersten Ebene

        SM2_CURR+N  Beginnt N Ebenen unterhalb der aktuellen Ebene, z.B.:

                    SM2_CURR      Beginnt auf der aktuellen Ebene. Alle Geschwister

                                  der aktuellen Ebene

                    SM2_CURR+1    Beginnt eine Ebene unterhalb der aktuellen Ebene

                                  mit allen Unterebenen

        page_id     Verwendet die Seite mit der angegebenen page id als Elternelement.

                    Alle Untermenüs dieser Seite werden angezeigt.

                    (Die page id kann ermittelt werden, wenn man die Seite im

                    Admin-Backend editiert, sie steht dann in der Adresszeile des

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

$aMaxLevel

    Die maximale Anzahl der Ebenen die angezeigt werden. Die Anzeige

    beginnt ab der in $aStart festgelegten Ebene, bis hin zu der hier

    festgelegten Ebene.

        SM2_ALL      Keine Beschränkung, alle Ebenen werden angezeigt

        SM2_CURR+N   Zeigt immer die aktuelle Seite + N Ebenen.

                     SM2_CURR      Aktuelle Ebene (keine Unterebene)

                     SM2_CURR+3    Alle übergeordneten + aktuelle + 3 Unterebenen

        SM2_START+N  Beginnt immer auf der Startebene + N Ebenen.

                     Die Ebenen werden unabhängig davon angezeigt,egal

                     auf welcher Ebene sich die aktuelle Seite befindet.

                     SM2_START     Eine einzelne Ebene ab der Startebene.

                     SM2_START+1   Startebene + eine Ebene darunter.

        SM2_MAX+N    Zeigt höchstens N Ebenen ab der Startebene.

                     Ebenen unterhalb der aktuellen Ebene werden nicht angezeigt.

                     SM2_MAX       Nur die Startebene (gleiche Wirkung wie SM2_START)

                     SM2_MAX+1     Die Startebene und eine Ebene darunter.

$aOptions

    Spezielle Flags für verschiedene Menügenerierungs Optionen. Sie können mittels

    einer ODER Verknüpfung (|) miteinander kombiniert werden. Um beispielsweise

    sowohl TRIM als auch PRETTY zu definieren, verwendet man: (SM2_TRIM | SM2_PRETTY).

    GROUP 1

    -------

    Aus dieser Gruppe muss stets genau ein Flag angegeben werden. Diese Flags

    bestimmen auf welche Weise die Geschwisterelemente im Menübaum in der

    Ausgabe unterdrückt werden.

    SM2_ALL         Zeigt alle Zweige des Menübaums

                        A-1 -> B-1

                            -> B-2 -> C-1

                                   -> C-2 (CURRENT)

                                          -> D-1

                                          -> D-2

                                   -> C-3

                        A-2 -> B-3

                            -> B-4

    SM2_TRIM        Zeigt alle Geschwistermenüs der Seite im aktuellen Pfad.

                    Alle Untermenüs von Elemnten die sich nicht im Pfad befinden

                    werden entfernt.

                        A-1 -> B-1

                            -> B-2 -> C-1

                                   -> C-2 (CURRENT)

                                          -> D-1

                                          -> D-2

                                   -> C-3

                        A-2

    SM2_CRUMB       Zeigt den Breadcrumb Pfad des Menüs an, also den aktuellen

                    Menüpunkt sowie alle Menüpunkte die dorthin führen.

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

    SM2_SIBLING     Wie SM2_TRIM, es werden aber nur Geschwistermenüs der aktuellen

                    Seite angezeigt. Alle anderen Punkte werden unterdrückt.

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

                                   -> C-2 (CURRENT)

                                          -> D-1

                                          -> D-2

                                   -> C-3

    GROUP 2

    -------

    Diese Flags sind optional, sie können in beliebiger Anzahl kombiniert werden.

    SM2_NUMCLASS    Fügt die nummerierten Menüklassen "menu-N" und

                    "menu-child-N hinzu.

    SM2_ALLINFO     Lädt alle Felder aus der Seitentabelle der Datenbank.

                    Dies verursacht einen ziemlich hohen Speicherverbauch und sollte

                    deshalb nur mit Bedacht verwendet werden.

                    Dadurch werden z.B. die Keywords, die Seitenbeschreibung sowie

                    all die anderen Informationen verfügbar, die normalerweise nicht

                    geladen werden.

                    Bitte beachten: dieses Flag muss beim ERSTEN Aufruf von schow_menu2

                    für die jeweilige Menü ID verwendet werden, oder in Verbindung

                    mit SM2_NOCACHE, sonst zeigt es keine Wirkung.

    SM2_NOCACHE     Die aus der Datenbank gelesenen Daten werden bei erneutem Aufruf von

                    show_menu2 nicht wiederverwendet sondern erneut aus der Datenbank

                    gelesen.

    SM2_PRETTY      Bringt die HTML-Ausgabe des Menüs mittels Leerzeichen und

                    Zeilenumbrüchen in eine gut lesbare Form. Das ist besonders

                    nützlich beim Debuggen der Menüausgabe.

    SM2_BUFFER      Gibt den HTML-Code nicht direkt aus, sondern speichert ihn intern

                    zwischen und gibt ihn als kompletten String aus.

    SM2_CURRTREE    Schliesst alle anderen Toplevelmenüs von der Betrachtung aus.

                    Es werden nur Menüpunkte des aktuellen Menüzweiges dargestellt.

                    Dieses Flag kann bei Bedarf mit jedem Flag aus der Gruppe 1

                    kombiniert werden.

    SM2_ESCAPE      Wendet htmlspecialchars auf den Menüstring an.

                    Dies kann bei älteren Websitebaker Installationen erforderlich

                    sein um eine valide HTML Ausgabe zu erzeugen.

    SM2_SHOWHIDDEN  Hidden pages are usually hidden all of the time, including

                    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

                    release 4.8, supply this flag to enable hidden pages to

                    become visible when they are active.

    SM2_XHTML_STRICT	Stellt die XHTML-Kompatibilität der Links sicher indem

					in per [a] oder [ac] formatierten Links die Targetangabe

					entfernt und das Argument title="[page_titel]" eingefügt

					wird. Bei manuell zusammengestellten Links ist der Designer

					selbst für die XHTML-Konformität zuständig.

	SM2_NO_TITLE	Unterdrückt die Ausgabe des Inhaltes des Title-Attributes

					bei [a] oder [ac] formatierten links. Im XHTML-Strikt Modus

                    wird 'title' mit einen   ausgegeben.

    Für diesen Parameter gibt es auch einen erweiterten Modus, bei dem die Optionen

    als assoziatives Array übergeben werden. Näheres dazu im Abschnitt ERWEITERTE

    OPTIONEN. Für die meisten Anwendungsfälle wird dies jedoch NICHT benötigt.

$aItemOpen

    Dies legt den Formatstring fest, mit dem jeder einzelne Menüeintrag begonnen

    wird. Für den allerersten Menüeintrag kann mittels $aTopItemOpen ein anderer

    Formatstring definiert werden.

    Wenn dieser Parameter auf false gesetzt wird, wird der Vorgabe Formatstring

    '[li][a][menu_title]</a>' verwendet um die Kompatibilität zur Website Baker

    Standardfunktion show_menu() zu gewährleisten.

    Da die Formatierung mittels CSS-Klassen oftmals einfacher ist, wenn sie auf den

    <a> tag angewendet werden, empfiehlt es sich hier folgenden Formatstring zu

    verwenden: '<li>[ac][menu_title]</a>'.

    Dieser Parameter kann auch als Instanz eine Formatierungklasse für das Menü

    verwendet werden. Die nähere Beschreibung dazu findet sich im Abschnitt FORMATTER.

    Wenn hier ein Formatter angegeben wird, werden alle Argumente

    nach $aItemOpen ignoriert.

$aItemClose

    Dieser String schließt jeden Menüpunkt ab.

    Bitte beachten: dies ist kein Formatstring und es werden keine Schlüsselworte

    ersetzt!

    Wenn dieser Parameter auf false gesetzt ist, wird die Vorgabe '</li>' verwendet.

$aMenuOpen

    Mit diesem Formatstring wird eine Liste von Menüeinträgen geöffnet. Für das erste

    Menü kann mittels $aTopMenuOpen ein davon abweichender Formatstring definiert

    werden.

    Wenn dieser Parameter auf false gesetzt ist wird der Vorgabewert '[ul]'

    verwendet.

$aMenuClose

    Dieser String schließt jedes Menü ab.

    Bitte beachten: dies ist kein Formatstring und es werden keine Schlüsselworte

    ersetzt!

    Wenn dieser Parameter auf false gesetzt ist, wird die Vorgabe '</ul>' verwendet.

$aTopItemOpen

    Der Formatstring für den allerersten Menüpunkt. Wenn dieser Parameter auf false

    gesetzt wird, wird der selbe Formatstring wie bei $aItemOpen verwendet.

$aTopMenuOpen

    Der Formatstring für das erste Menü. Wenn dieser Parameter auf false

    gesetzt wird, wird der selbe Formatstring wie bei $aMenuOpen verwendet.

ERWEITERTE OPTIONEN

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

Der Parameter $aOptions kann auf zweierlei Arten verwendet werden. Zum einen, wie oben

im Abschnitt PARAMETER beschrieben, diese Art sollte für die allermeisten

Anwendungsfälle ausreichen. Um allerdings in speziellen Fällen die Sonderoptionen

ansprechen zu können, müssen die erforderlichen Werte als assoziatives Array

bereitgestellt werden.

Bitte beachten: Die SM2_* Flags sind auch hierbei erforderlich und müßen als 'flags'

übergeben werden.

    'flags'     **ZWINGEND ERFORDELICH** Dies sind die Flags die oben im Abschnitt

                PARAMETER unter $aOptions beschrieben wurden.

    'notrim'    Hiermit wird eine Anzahl von Ebenen festegelegt, die relativ bezogen

                auf die in $aStart festgelegte Menüebene, immer angezeigt werden. Dies

                bewirkt, daß für diese Ebenen das SM2_TRIM Flag ignoriert wird.

Um dieses Array zu verwenden, empfiehlt es sich es erst anzulegen und dann den

$aOptions parameter mit dem angelegten Array zu beliefern:

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

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

FORMAT STRINGS

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

Die folgenden Tags können in den Formatstrings für $aItemOpen und $aMenuOpen

verwendet werden und sollen durch den entsprechenden Text ersetzt werden.

[a]             <a> tag ohne Klasse:   '<a href="[url]" target="[target]">'

[ac]            <a> tag mit Klasse:    '<a href="[url]" target="[target]" class="[class]">'

[li]            <li> tag mit Klasse:   '<li class="[class]">'

[ul]            <ul> tag mit Klasse:   '<ul class="[class]">'

[class]         Liste der Klassen für diese Seite

[menu_title]    Text des Menütitel

                (HTML entity escaped ausser das SM2_NOESCAPE Flag ist gesetzt)

[menu_icon_0]	die URL zu einer Bilddatei mit normal - Darstellung (ab WB2.8.4)

[menu_icon_1]	die URL zu einer Bilddatei mit active/hover - Darstellung (ab WB2.8.4)

[page_title]    text des Seitentitel

                (HTML entity escaped ausser das SM2_NOESCAPE Flag ist gesetzt)

[page_icon]		die URL zu einer seitenbezogenen Bilddatei (ab WB2.8.4)

[tooltip]       Tooltip-Text, der normal im title-Attribut der Links ausgegeben wird (ab WB2.8.4)

[url]           die URL der Seiten für den <a> tag

[target]        das Seitenziel für den <a> tag

[page_id]       die Page ID des aktuellen Menüpunktes.

[parent]        die Page ID des übergeordneten Menüpunktes.

[level]         die Seitenebene,

                dies ist die gleiche Zahl die im "menu-N" CSS tag verwendet wird.

[sib]           Anzahl der Geschwister des aktuellen Menüpunktes.

[sibCount]      Anzahl aller Geschwister in diesem Menü.

[if]            Bedingung (Details hierzu im Abschnitt "Bedingte Formatierung')

Folgende tags sind NUR verfügbar, wenn das SM2_ALLINFO Flag gesetzt ist.

[description]   Seitenbeschreibung