<we:listdir />
Erzeugt eine Liste aller Dokumente und Unterverzeichnisse im aktuellen Verzeichnis oder in dem Verzeichnis, dessen ID als Wert des Attributs "id" angegeben wurde:
Von Dokumenten können die ID, der Pfad und das eine Feld ausgegeben werden, welches mit dem Attribut "field" definiert wird. Unterverzeichnisse werden nur aufgelistet, wenn sie eine Index-Datei enthalten. Auch von Unterverzeichnissen können die ID, der Pfad sowie das in "field" definierte Feld der Index-Datei ausgegeben werden. Alternativ kann bei Unterverzeichnissen auch ein in "dirfield" definierte Feld ausgegeben werden. Ist das Feld "field" bzw. "dirfield" nicht befüllt, wird an seiner Stelle der Datei-/Verzeichnisname ausgegeben.
Sortierung: Unterverzeichnisse werden immer vor den Dokumenten ausgegeben, in sich werden Untervrzeichnisse und Dokumente per Default nach dem Dateinamen sortiert. Mit dem Attribut "order" kann zusätzlich ein Feld zur Sortierung definiert werden: Dieses kann, muss aber nicht mit "field" übereinstimen. Dabei gilt jedoch: Stimmt "order" nicht mit "field" (bzw. "dirfield") überein, kann sein Inhalt nicht ausgegeben werden.
Innerhalb des Start- und Endtags können folgende we:Tags verwendet werden:
| Tag | Bedeutung |
|---|---|
| <we:field name="we_id"/> | Zeigt die ID des webEdition-Dokuments/Unterverzeichnisses an. |
| <we:field name="we_path"/> | Zeigt den Pfad des webEdition-Dokuments/Unterverzeichnisses an. |
| <we:field name="we_text"/> | Zeigt den Inhalt des beim Attribut "field" (bzw. "dirfield") angegebenen Feldes an. Ist das entsprechende Feld auf dem Dokument/der Index-Datei leer oder nicht vorhanden, wird stattdessen der Dateiname ausgegeben. |
| <we:a>Linktext</we:a> | Erzeugt einen Link auf das Dokument. |
| <we:ifSelf type="listview"></we:ifSelf> | Wird nur ausgeführt, wenn es sich um dasselbe webEdition-Dokument handelt. |
| <we:ifNotSelf type="listview"></we:ifNotSelf> | Wird nur ausgeführt, wenn es sich nicht um dasselbe webEdition-Dokument handelt. Hinweis: Attribut "type" ist deprecated. |
| <we:ifDir></we:ifDir> | Wird nur ausgeführt, wenn das aktuelle Element ein Unterverzeichnis ist.*) |
| <we:ifNotDir></we:ifNotDir> | Wird nur ausgeführt, wenn das aktuelle Element kein Unterverzeichnis ist.*) |
Beachte, dass Du für diese Tags keine Attribute anzugeben brauchst und sich die Funktionalität von den gleichnamigen we:Tags unterscheidet, wenn sie innerhalb der <we:listdir>-Tags stehen.
*) Hinweis: Verzeichnisse werden nur mit ausgegeben, wenn sie ein Index-Dokument enthalten.
| ab Version | 1.3.0.0 |
| Endtag erforderlich | nein |
| Pflichtattribute |
Attribute
Bei diesem Attribut gibst Du als Wert die ID des Verzeichnisses an, dessen Dateien aufgelistet werden sollen. Ist das Attribut nicht gesetzt, werden die Dateien des aktuellen Verzeichnisses aufgelistet.
| ab Version | 1.3.0.0 |
| Typ | string |
| Standardwert | - |
Bei diesem Attribut gibst Du als Wert kommasepariert die Index-Dateien an.
| ab Version | 1.3.0.0 |
| Typ | string |
| Standardwert | - |
Bei diesem Attribut gibst Du als Wert den Namen eines Feldes an, welches sich in den aufzulistenden webEition-Dokumenten befindet und dessen Inhalt angezeigt werden soll. Ist das Feld leer oder gibt es das Feld nicht, wird der Dateiname angezeigt. Bei Verzeichnissen wird überprüft, ob es darin eine über das Attribut "index" definierte Index-Datei gibt und wenn ja, wird ein Link auf diese angezeigt.
| ab Version | 1.3.0.0 |
| Typ | string |
| Standardwert | - |
Bei diesem Attribut gibst Du als Wert den Namen eines Feldes an, welches bei Verzeichnissen angezeigt werden soll. Ist das Feld leer oder gibt es das Feld nicht, wird der Wert des Attributs "field" bzw. der Dateiname benutzt.
| ab Version | 1.3.0.0 |
| Typ | string |
| Standardwert | - |
Setzt Du dieses Attribut auf "true", dann wird bei der Listview die Eigenschaft "durchsuchbar" der Dokumente oder Objekte (-> Reiter Eigenschaften) beachtet. Es werden dann nur die Dokumente und Objekte gezeigt, die auf durchsuchbar gestellt sind. Wenn das Attribut auf "false" gesetzt wird, wird die Eigenschaft "durchsuchbar" nicht beachtet.
| ab Version | 3.1.0.0 |
| Typ | boolean |
| mögliche Werte | true, false |
| Standardwert | true |
Bei diesem Attribut gibst Du den Namen des Feldes an, nach dem die Auflistung sortiert werden soll.
| ab Version | 1.3.0.0 |
| Typ | string |
| Standardwert | - |
Wenn Du den Wert dieses Attributs auf "true" setzt, dann wird die Sortierreihenfolge der Auflistung umgekehrt. Wenn Du den Wert dieses Attributs nicht setzt, dann wird die Sortierreihenfolge beibehalten.
| ab Version | 1.3.0.0 |
| Typ | string |
| mögliche Werte | true |
| Standardwert | - |
Bestimmt wie / wohin die Ausgabe erfolgt. Dabei wird der Code, der sonst auf der Seite ausgegeben würde, in exakt derselben Weise an die auszuwählende Variable übergeben. Dies ist eine praktische Alternative zu <we:setVar>, bitte vergleiche und entnimm weitere Details zu den einzelnen möglichen Werten dort.
Ab webEdition 6.1.0.2: post, get
Ab webEdition 9.0.8: local: Erlaubt den Wert einer lokalen Variable zuzuordnen und dann im Tag attribut="$name" zu nutzen.
| ab Version | 6.1.0.0 |
| Typ | string |
| mögliche Werte | screen, request, post, get, global, local, session, top, self, sessionfield |
| Standardwert | screen |
Name der Variable, in die die Ausgabe erfolgt.
Ab webEdition 6.3.7 können auch Arrays mit folgender Syntax geschrieben werden werden:
<we:xxxx to="global" nameto="meinArray[abc]"/>oder<we:xxxx to="global" nameto="meinArray[]"/>oder<we:xxxx to="global" nameto="meinArray[][def]"/>.
Wichtig ist hierbei, dass innerhalb der eckigen Klammern keine Hochkommata oder Anführungszeichen genutzt werden!
| ab Version | 6.1.0.0 |
| Typ | string |
| Standardwert | - |
Syntax
<we:listdir id="" index="" field="" dirfield="" searchable="true|false" order="" desc="true" to="screen|request|post|get|global|local|session|top|self|sessionfield" nameto=""/>
Hilf mit!
Hast Du eine Ergänzung für die Tag-Referenz, dann werde bitte aktiv.
Entweder über einen Eintrag unter qa.webedition.org oder
einfach formlos per E-Mail an
websites@webedition.org.
Fehler oder Erweiterungswünsche zu webEdition selbst bitte über qa.webedition.org melden.