WB 2.08.x

show_menu2, version 4.9

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

Sitemaps, usw.) erzeugt werden.

---

eine Email an bjm@wwnw.de.

---

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

   auswählen und installieren.

BENUTZUNG VON SHOW_MENU2

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

Parameter verwendet werden die show_menu2 benötigt.

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-

von PHP Code):

    <?php show_menu2(); ?>

einzelnen Menüpunkte aufzustellen.

Zum Beispiel:

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

    li.menu-current { background: red; }

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

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

code.jellycan.com/sm2test/

HÄUFIGE FRAGEN

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

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ß

    Suchfunktion benutzt habe?

A:  Im verwendeten Template fehlen die notwendigen Zeilen:

        folgende Zeile einfügen:

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

        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?

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

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

    Werten übergeben.

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

FUNKTION

========

        $aTopMenuOpen   = false

        )

einzelnen Parameters.

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.

    "SM2_" beginnen zulässig.

    steuern.

    jeweiligen Vorgabewert zu erhalten.

    Verwendung finden:

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

HTML-AUSGABE

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

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

    KLASSE          ZUORDNUNG

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

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

    ist:

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

PARAMETER

=========

    verwenden.

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

    im System verwendeten Menüs zurück.

    kann einer der folgenden Werte verwendet werden:

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

                                  mit allen Unterebenen

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

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

    Die maximale Anzahl der Ebenen die angezeigt werden. Die Anzeige

    festgelegten Ebene.

        SM2_ALL      Keine Beschränkung, alle Ebenen werden angezeigt

                     SM2_CURR      Aktuelle Ebene (keine Unterebene)

                     SM2_CURR+3    Alle übergeordneten + aktuelle + 3 Unterebenen

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

                     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       Nur die Startebene (gleiche Wirkung wie SM2_START)

                     SM2_MAX+1     Die Startebene und eine Ebene darunter.

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

    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

                            -> B-2 -> C-1

                                   -> C-2 (CURRENT)

                                          -> D-1

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

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

                    werden entfernt.

                            -> B-2 -> C-1

                                   -> C-2 (CURRENT)

                                          -> D-1

                                          -> D-2

                                   -> C-3

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

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

    -------

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

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

                    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

                    gelesen.

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

                    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.

                    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

    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

    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.

    <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ü

    Wenn hier ein Formatter angegeben wird, werden alle Argumente

    nach $aItemOpen ignoriert.

$aItemClose

    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

    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.

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

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

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

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

ERWEITERTE OPTIONEN

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

bereitgestellt werden.

übergeben werden.

                PARAMETER unter $aOptions beschrieben wurden.

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

$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

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

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

[class]         Liste der Klassen für diese Seite

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

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

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

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

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

    A   Die Bedingung. Details dazu, siehe unten.

    B   Der Ausdruck der verwendet wird, wenn die Bedingung erfüllt ist.

        Dies kann ein beliebiger String sein, der jedoch nicht das Zeichen '}'

        enthalten darf. Er kann jeden beliebigen Formatstring aus dem Abschnitt

        Zeichen '}' nicht erlaubt ist).

    C   Der Ausdruck der verwendet wird, wenn die Bedingung nicht erfüllt ist.

        Dies kann ein beliebiger String sein, der jedoch nicht das Zeichen '}'

        enthalten darf. Er kann jeden beliebigen Formatstring aus dem Abschnitt

        Zeichen '}' nicht erlaubt ist).

Die Bedingung ist eine Kombination von einem oder mehreren boolschen Vergleichen.

Wenn mehr als ein Vergleich erforderlich ist, so muss dieser mit den anderen Vergleichen

Operanden.

z.B. X == Y  - hierbei ist X der linke Operand, == der Operator und Y der rechte Operand.

    Linker Operand. Muss eines der folgende Schlüsselworte sein:

        class       Überprüfung ob diese Klasse existiert. Es sind nur die

                    "==" and "!=" Operatoren erlaubt. In diesem Fall haben die Operatoren

        sibCount    Überprüfung der Geamtanzahl der Geschwister im aktuellen Menü.

        id          Überprüfung der page id.

		target		Überprüfung der Target-Angabe

    Operator. Muss einer der folgenden sein:

        <           Kleiner als

        <=          Kleiner oder gleich als

        !=          Nicht gleich

        >=          Grössr oder gleich als

        >           Grösser als

    Rechter Operand. Die Art dieses Operanden hängt von dem, für den linken Operanden

                     verwendeten Schlüsselwort ab.

        class       einer der "menu-*" Klassennamen wie sie im Abschnitt "Ausgabe"

                    Geschwister in diesem Menü zu überprüfen

        sibCount    Eine positive Integerzahl

		target		Ein String, der eine mögliche Targetangabe darstellt

Folgende Beispiele ergeben "wahr" und der Ausdruck {exp} wird ausgeführt, wenn zutrifft:

    [if(class==menu-expand){exp}]   hat ein Untermenü

    [if(class==menu-first){exp}]    ist der erste Eintrag in einem Menü

    [if(class!=menu-first){exp}]    ist NICHT der erste Eintrag in einem Menü

    [if(sib==2){exp}]               ist der zweite Eintrag in einem Menü

    [if(sibCount>1){exp}]           ist in einem Menü mit mehr als einem Eintrag

    [if(sibCount!=2){exp}]          ist in einem Menü, das nicht genau 2 Einträge hat

                                    Geschwistermenüs

    [if(id==parent){exp}]           ist der übergeordnete Punkt der aktuellen id

	[if(target==_self){exp}]		im Target-Attribut ist der String '_self' enthalten

ausgeführt.

Zum Beispiel wird "foo" immer dann ausgeführt, wenn die if Überprüfung falsch ergibt, also:

Bei mehrfach Vergleichen wird der Ausdruck "exp" nur ausgeführt, wenn:

    Untermenüs

Bitte beachten:

Alle Überprüfungen werden in der Reihenfolge ausgeführt, in der sie notiert sind, denn:

* es findet keine Überprüfung auf evtl. Schleifen statt (alle Überprüfungen werden immer ausgeführt)

{

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

};