#docGroup
Das Systemobjekt #docGroup wird im Kontext von Dokumentengruppen verwendet und steuert die Generierung von Dokumenten. Es verweist auf den ("virtuellen") Wurzelknoten einer Dokumentengruppe. Über die Punkt-Notation stellt dieses Systemobjekt verschiedene Methoden bereit, über die beispielsweise ein Inhaltsverzeichnis generiert werden kann.
 |
In der Regel kann auf Systemobjekte nur lesend zugegriffen werden. Es gibt jedoch einige Methoden, die Systemobjekte auch modifizieren oder das Systemverhalten beeinflussen können. Hierunter fällt z.B. die Ausgabe der Elemente einer Dokumentengruppe während der Generierung (vgl. #docGroup.pageFirst). |
Nachfolgend sind die einzelnen Methodenaufrufe aufgeführt:
Aufruf | Bedeutung |
|---|---|
#docGroup.childs | Liefert eine Liste der Kind-Knoten der Dokumentengruppe zurück. Jedes Kind ist wieder vom gleichen Typ wie #docGroup. Die Liste der Kinder enthält zunächst Knoten vom Typ "Seitenreferenz", gefolgt von Knoten des Typs "Menüebene". |
#docGroup.depth | Liefert die Tiefe des Knotens in der Dokumentengruppe zurück (z.B. "0" für die oberste Ebene). Zum Vergleich: Knoten der Liste #docGroup.childs haben die Tiefe 1. |
#docGroup.isFolder | Ermittelt, ob der Knoten vom Typ "Menüebene" ist (Wert true) oder nicht (Wert false). |
#docGroup.isPageRef | Ermittelt, ob der Knoten vom Typ "Seitenreferenz" ist (Wert true) oder nicht (Wert false). |
#docGroup.index | Liefert den Index des Knotens in der "childs"-Liste des Vaterknotens zurück. |
#docGroup.parent | Liefert den Vaterknoten des Elements zurück. Handelt es sich bei docGroup bereits um den Wurzelknoten, wird null zurückgeliefert. |
#docGroup.selected | Liefert den Wert true zurück, wenn der Knoten selber oder ein Kindknoten gerade in die Ausgabe geschrieben wird. |
#docGroup.label | Liefert die Überschrift des Knotens zurück. Entspricht bei der Wurzel dem Namen der Dokumentengruppe, bei Menüebenen dem Menünamen und bei Seitenreferenzen dem Sitemap-Namen. |
#docGroup.chapter | Liefert die Kapitelnummer zurück, z.B. ein Text in der Form "2.3.1". |
#docGroup.section | Liefert die Kapitelnummer zurück, im Gegensatz zu #docGroup.chapter werden allerdings mit #docGroup.section nur Ordner in die Kapitelnummerierung einbezogen. |
#docGroup.root | Liefert das virtuelle Wurzelelement zurück (entspricht dem Wert von #docGroup). |
#docGroup.pageFirst | Der Wert sollte in der Startvorlage auf true gesetzt werden (über den Ausdruck $CMS_SET(...)$), wenn Seiten vor Ordnern ausgegeben werden sollen. Die Ausgabe innerhalb der Vorlage kann über den Ausdruck $CMS_VALUE(...)$ erfolgen. |
|
Weitere Informationen zur Arbeit mit Dokumentengruppen sowie Beispiele finden sich im Bereich Dokumentengruppen. |