Login
Neu hier? Registrieren.
Wayfinder-Parameter I
Obwohl nur ein Parameter (&startItem) absolut unerlässlich ist, hat Wayfinder eine große Menge optionaler Parameter, die Sie für ihre besonderen Bedürfnisse zu erforderlichen Parametern machen können.
Parameter können auf zwei verschiedene Weisen gesetzt werden: (1) Sie können sie inline im Snippet-Aufruf angeben (üblich für die meisten Snippets), oder (2) Sie können alle Ihre Einstellungen und Templates in eine einzige Konfigurations-Datei schreiben (wie weiter unten dokumentiert) und sie durch einen einzigen Parameter im Snippet-Aufruf anwenden.
Parameter die bestimmen, welche Dokumente gelistet werden
| Parameter | Beschreibung | Typ | Erlaubte Werte | Standard | Kommentar |
|---|---|---|---|---|---|
| &startId | Dies ist der einzige Parameter, der stets erforderlich ist (er kann inline im Snippet-Aufruf gesetzt werden oder in einer Konfigurations-Datei; aber einer der beiden Wege ist erforderlich). Dieser Parameter gibt die ID des Dokuments an, dessen Nachkommen im von Wayfinder erzeugten Output aufgelistet werden. | ganze Zahl | 0, oder eine positive ganze Zahl, die der ID eines Dokuments im MODx Dokumentenbaum entspricht. | Die ID des aktuellen Dokuments (d.h. derjenigen Seite, in der der Wayfinder Aufruf steht). | |
| &level | Dieser Parameter sagt Wayfinder die maximale Anzahl von Hierarchie-Ebenen, die es in seinen Output aufnehmen soll. Der Wert 0 (null) lässt die Anzahl unbegrenzt. | ganze Zahl | 0, oder eine positive ganze Zahl. | 1 | |
| &limit | Dieser Parameter sagt Wayfinder die maximale Anzahl von Items, die es in eine Liste oder Unterliste aufnehmen kann. Der Wert 0 (null), oder das Fehlen dieses Parameters, lässt die Anzahl unbegrenzt. | ganze Zahl | 0, oder eine positive ganze Zahl. | 0 | |
| &displayStart | Normalerweise listet Wayfinder nur die Nachkommen des in &startId angegebenen Dokuments. Wenn Sie jedoch diesen Parameter auf TRUE setzen, und wenn &startId auf einen von null verschiedenen Wert gesetzt wird, dann benutzt Wayfinder das Template, das im Parameter &startItemTpl angegeben wurde, um Information über das Start-Dokument anzuzeigen. Dies ist besonders nützlich, wenn mit Wayfinder ein zusätzliches Menü erzeugt werden soll, dessen Kopf oder Titel-Block Informationen über das Start-Dokument anzeigen soll. | logischer Wert | TRUE, FALSE | FALSE |
|
| &ignoreHidden | Normalerweise nimmt Wayfinder solche Dokumente nicht in das Listing auf, deren "show in menu"-Checkbox nicht angekreuzt ist. Setzt man jedoch diesen Parameter auf TRUE, so wird dieses Verhalten überschrieben, und Wayfinder schließt diese Dokumente doch in seine Listen ein. | logischer Wert | TRUE, FALSE | FALSE | |
| &hideSubMenus | Normalerweise listet Wayfinder alle Ebenen aller Nachkommen des Start-Dokuments auf. Setzt man diesen Parameter jedoch auf TRUE, kann man dieses Verhalten so ändern, dass Wayfinder nur die unmittelbaren Kinder (sofern vorhanden) der gerade angezeigten Seite auflistet. Das hat den Effekt, dass man beim Durchklicken durch die Menü-Hierarchie immer nur den Pfad von ganz oben bis zur aktuellen Ebene und einer weiteren Ebene angezeigt bekommt. | logischer Wert | TRUE, FALSE | FALSE | |
| &includeDocs | In der Voreinstellung listet Wayfinder keine Dokumente von denen MODx denkt, dass sie für den momentanen Nutzer unsichtbar sein sollten. Das betrifft Dokumente, für die der Nutzer nicht autorisiert ist, deren "show in menu"-Box nicht angekreuzt ist, die unveröffentlicht sind, usw. Gibt es jedoch gewisse Dokumente, die Sie trotz dieser Einschränkungen gelistet haben wollen, so können Sie sie in diesem Parameter angeben, und Wayfinder nimmt sie in seinen Output auf. | Durch Kommas getrennte Liste. | Die IDs derjenigen Dokumente, die Sie eingeschlossen haben wollen, durch Komma getrennt.Wayfinder Aufruf | (leer) |
|
| &excludeDocs | In der Voreinstellung listet Wayfinder alle Dokumente auf, von denen MODx denkt, dass sie für den momentanen Nutzer sichtbar sein sollten. Gibt es jedoch gewisse Dokumente, die Sie unter keinen Umständen gelistet haben wollen, können sie sie in diesem Parameter angeben, und Wayfinder schließt sie vom Output aus. | Durch Kommas getrennte Liste. | Positive ganze Zahlen: die IDs derjenigen Dokumente, die ausgeschlossen werden sollen. | (leer) | Dieser Parameter wurde in Wayfinder 2.0 hinzugefügt. |
Parameter, die die Reihenfolge der Dokumente in der Liste festlegen
| Parameter
|
Beschreibung
|
Typ
|
Erlaubte Werte
|
Standard
|
Kommentar
|
|---|---|---|---|---|---|
| &sortBy | In der Voreinstellung sortiert Wayfinder Listen und Unterlisten nach dem Wert des menuindex-Felds des Dokuments. Mit diesem Parameter können Sie jedoch aus einer ganzen Menge von anderen Feldern wählen, nach denen sortiert werden soll. Beachten Sie, dass alle Listen und Unterlisten (alle Ebenen) nach dem Feld sortiert werden, das Sie hier wählen. | Einer der folgenden vordefinierten Begriffe. |
|
menuindex | |
| &sortOrder | In der Voreinstellung sortiert Wayfinder Listen und Unterlisten in aufsteigender Ordnung. Mit diesem Parameter können Sie auf absteigende Ordnung wechseln. Beachten Sie, dass in jedem Fall die Sortierreihenfolge im Output für alle Listen und Unterlisten (auf allen Ebenen) die gleiche ist. | Einer der folgenden vordefinierten Begriffe. |
|
ASC |
Parameter, die die Werte bestimmter Platzhalter bestimmen
| Parameter
|
Beschreibung
|
Typ
|
Erlaubte Werte
|
Standard
|
Kommentare
|
|---|---|---|---|---|---|
| &textOfLinks | In der Voreinstellung benutzt Wayfinder das menutitle-Feld
jedes Dokuments als sichtbaren Namen für jeden HTML-Link, den es
ausgibt. Mit diesem Parameter können Sie ein anderes Feld als Quelle
für diesen Text bestimmen. Wenn Sie Ihre eigenen Templates erstellen,
wird das Feld, das Sie mit diesem Parameter festlegen, zum Wert des
Platzhalters [+wf.linktext+]. |
Einer der folgenden vordefinierten Begriffe. |
|
menutitle | |
| &titleOfLinks | In der Voreinstellung benutzt Wayfinder das pagetitle-Feld jedes Dokuments als Wert für das title-Attribut
eines jeden HTML-Links, den es ausgibt. Mit diesem Parameter können Sie
ein anderes Feld als Quelle für diesen Text bestimmen. Wenn Sie Ihre
eigenen Templates erstellen, wird das Feld, das Sie mit diesem
Parameter festlegen, zum Wert des Platzhalters [+wf.title+]. |
Einer der folgenden vordefinierten Begriffe. |
|
pagetitle | |
| &useWeblinkUrl | Wird dieser Parameter auf "True" gesetzt wird im Wayfinder-Output der im Weblink-Dokument definierte Link generiert, nicht der Link auf das Weblink-Dokument selbst (was bei Klick nur auf den definierten Link weiterleitet). | logischer Wert | TRUE, FALSE | FALSE | |
| &fullLink | Beim Wert TRUE wird der vollständige URL ausgegeben statt eines relativen Pfads. | logischer Wert | TRUE, FALSE | FALSE | |
| &rowIdPrefix | Wenn
Sie benutzerdefinierte Templates schreiben und für jede Zeile einen
eindeutigen Bezeichner brauchen, ist dies Ihr Parameter. Der Wert, den
Sie diesem Parameter geben, wird der ID eines jeden Dokuments, das
Wayfinder auflistet, vorangestellt und dann in den [+wf.id+]-Platzhalter gesetzt. Dieser Platzhater kann dann in jedem zeilenbezogenen Template benutzt werden. |
Zeichenkette | eine beliebige Zeichenkette ohne Leerzeichen, Satzzeichen und nicht nur aus Zahlen bestehend | (leer) | |
| &showSubDocCount | Wenn dieser Parameter auf TRUE gesetzt ist, füllt Wayfinder für jedes Dokument den Plathalter [+wf.subitemcount+]
mit der Anzahl der unmittelbaren Kinder dieses Dokuments. Dieser
Platzhalter kann in jedem benutzerdefinierten zeilenbezogenen Template
verwendet werden. |
logischer Wert | TRUE, FALSE | FALSE |
Einige Utility-Parameter
| Parameter | Beschreibung | Typ | Erlaubte Werte | Standard |
|---|---|---|---|---|
| &removeNewLines | In der Voreinstellung schließt Wayfinder alle Zeilenumbrüche in den Output ein, die in dem Template, das den Output erzeugt, vorkommen. Setzt man jedoch diesen Parameter auf TRUE, so lässt Wayfinder diese Zeilenumbrüche weg und liefert den Output in einer langen, nicht umgebrochenen Zeile. | logischer Wert | TRUE, FALSE | FALSE |
| &ph | In der Voreinstellung setzt Wayfinder seinen Output an der Stelle des Templates der aktuellen Seite ein, von der er aufgerufen wurde. D.h. der Snippet-Aufruf wird durch den Output des Snippet ersetzt. Das ist das normale Verhalten von Snippets. Wenn Sie aber diesen Parameter in den Wayfinder Aufruf aufnehmen, können Sie Wayfinder den Namen eines (von Ihnen festgelegten) Platzhalters nennen, an dessen Stelle er den Output ausgeben soll. Dies erlaubt es, den Aufruf von Wayfinder an eine Stelle im Template der Seite zu platzieren, die Ausgabe jedoch an andere(r) Stelle(n). | Zeichenkette | eine beliebige Zeichenkette
|
(leer) |
| &debug | Wenn Sie diesen Parameter auf TRUE setzen, fügt Wayfinder dem normalen Output ein langes, ausführliches Listing aller internen Einstellungen, Werte, Templates usw. an, die zur Erzeugung des Outputs benutzt wurden. | logischer Wert | TRUE, FALSE | FALSE |
| &config |
|
Zeichenkette | der Anfangsteil eines Konfigurations Dateinamens. | default |
| &cssTpl | Wenn
Ihr Wayfinder-Output ein CSS-Stylesheet erfordert, können Sie auf
folgende Weise sicherstellen, dass das CSS erreichbar ist:
<link rel="stylesheet" href="URL-der CSS-Datei" />. |
Zeichenkette | der Name eines Chunk, der den URL einer CSS-Datei enthält. | (leer) |
| &jsTpl | Wenn
Ihr Wayfinder-Output JavaScript erfordert, können Sie auf folgende
Weise sicherstellen, dass das JavaScript erreichbar ist:
<script type="text/javascript" src="URL-der JavaScript-Datei"> </script>. |
Zeichenkette | der Name eines Chunk, der den URL einer JavaScript Datei enthält. | (leer) |