Mehrere Menüs

show_menu2, version 4.9x

Show_Menu2 ist ein Code-Snippet für das CMS WebsiteBaker. Seit WebsiteBaker 2.7 wird es mit dem CMS mitgeliefert.
Die frühere show_menu Funktion wird mit show_menu2 vollständig ersetzt und erweitert. 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.
---

• Installation
• Benutzung von Show_Menu2
• Häufige Fragen
• Funktion
• HTML Ausgabe
• Parameter
• Erweiterte Optionen
• Format Strings
• Bedingte Formatierung
• Formatter

INSTALLATION Nach oben

Da show_menu2 üblicherweise in WebsiteBaker vorhanden ist, entfällt jegliche Installation. Sollte es wider erwarten nicht vorhanden sein, können Sie es hier herunterladen.

BENUTZUNG VON SHOW_MENU2 Nach oben

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 mit mindestens 4 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(0, SM2_ROOT, SM2_START, SM2_TRIM);

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(0, SM2_ROOT, SM2_START, SM2_TRIM); ?>

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

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

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

Es gibt jede Menge Möglichkeiten, um die unterschiedlichsten Menüstrukturen zu erzeugen. Zahlreiche Beispiele dazu findet man auf der Demo-Website: http://www.websitebakers.de/sm2/

HÄUFIGE FRAGEN Nach oben

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 WebsiteBaker Addon Repository -> https://addon.websitebaker.org/

Q: Warum verschwindet das Menü nachdem ich in einer mehrsprachigen WebsiteBaker-Seite die Suchfunktion benutzt habe?
A: Im verwendeten Template fehlen die notwendigen Zeilen:

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

<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: https://help.websitebaker.org/de/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 Nach oben

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 Nach oben

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.

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 Nach oben

$aMenu

$aStart

$aMaxLevel

$aOptions

 A-1 -> B-1
     -> B-2  -> C-1
             -> C-2 (CURRENT)
                       -> D-1
                       -> D-2
             -> C-3
 A-2 -> B-3
     -> B-4

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

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

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

$aItemOpen

$aItemClose

$aMenuOpen

$aMenuClose

$aTopItemOpen

$aTopMenuOpen

ERWEITERTE OPTIONEN Nach oben

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.

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 Nach oben

Die folgenden Tags können in den Formatstrings für $aItemOpen und $aMenuOpen verwendet werden und sollen durch den entsprechenden Text ersetzt werden.

'<a href="[url]" target="[target]">'

'<a href="[url]" target="[target]" class="[class]">'

'<li class="[class]">'

'<ul class="[class]">'

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

BEDINGTE FORMATIERUNG Nach oben

Die Anweisung für eine bedingte Formatierung kann eine der folgenden Formen haben:

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

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
mittels || (boolsches oder - OR) oder && (boolsches und - AND) verknüpft werden.

Ein einzelner Vergleich besteht aus dem linken Operanden, dem Operator und dem rechten Operanden.
z.B. X == Y - hierbei ist X der linke Operand, == der Operator und Y der rechte Operand.

Wenn eine sonst-Klausel (else) hinzugefügt wird, so wird diese in allen anderen Fällen ausgeführt.

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)
• Überprüfungen werden nicht gruppiert (eine Klammerung von Überprüfungen wird nicht unterstützt)
• Sowohl || als auch && haben die gleiche Wertigkeit

FORMATTER Nach oben

Achtung: Dies ist ein fortgeschrittenes und äusserst selten benötigtes Feature!

Mit umfangreichen Kenntnissen in der PHP Programmierung ist es möglich den vordefinierten
Formatierer von show_menu2 mit einem eigenen zu ersetzen.
In der include.php von show_menu2 sieht man wie der Formatierer geschreiben werden muss.
Die API, die verwendet werden muss, sieht wie folgt aus:

(Anmerkung des Übersetzers: Kommentare sind nicht Übersetzt, wer sich so weit vorwagt, sollte damit keine Probleme haben ;-)

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

WebsiteBaker is released under the GNU General Public License