Es gibt die Möglichkeit, bei Elementen Stichwörter zu hinterlegen, die dann in Form eines Stichwortverzeichnisses ausgegeben werden können.
Pflege
Print-Element
Bei den Einstellungen für das Print-Element ist es möglich, die Stichwörter für dieses Element zu aktivieren oder zu deaktivieren und zu hinterlegen.
Ansicht Stichwortverzeichnis
Wie beschrieben, kann die Ansicht "Stichwortverzeichnis" verwendet werden, um ein Stichwortverzeichnis auf Basis der gepflegten Daten beim Print-Element zu generieren.
Dabei kann auch eingestellt werden, welcher Kontext für die Generierung beachtet werden soll. "Aktueller Inhalt" sammelt beim Generieren die Einträge, welche für das aktuelle Inhaltselement gepflegt sind und baut darauf ein Stichwortverzeichnis auf. Das kann nützlich sein, wenn man ein oder mehrere Stichwortverzeichnisse für zum Beispiel Kapitel darstellen möchte. "Gesamtes Dokument" hingegen, kann dazu benutzt werden, um ein Stichwortverzeichnis über das gesamte Dokument zu erzeugen. Also zum Beispiel ein Katalog-Stichwortverzeichnis. Diese Art von Stichwortverzeichnis funktioniert nur dann, wenn auch das Dokument generiert wird und nicht nur ein Inhalt.
Für das gesamte Stichwortverzeichnis, die Gruppenüberschriften und für die Einträge ist es möglich Darstellungsvarianten zu hinterlegen. Für eine überschriftartige Darstellung der Gruppenüberschriften kann zum Beispiel die Variante "Überschrift" gewählt werden.
Erweiterbarkeit
Das Stichwortverzeichnis ist in zwei Bereiche getrennt. Das Sammeln der Einträge über PrintDocument/Keyword und das Darstellen der Einträge über View/Keyword. Die Darstellung über View/Keyword ist dabei nicht erweiterbar, aber das Sammel über PrintDocument/Keyword hingegen über diese Events.
| Event | Beschreibung |
|---|---|
PrintDocument\Keyword\Lib\Event\OnPopulateKeywords | Sammelt \Brandbox\PrintCore\PrintDocument\Toc\Lib\Struct\TocElement[] in Event\OnPopulateToc::$element anhand eines Kontextes. Weitere Informationen zum Kontext weiter unten. |
PrintDocument\Keyword\Lib\Event\OnGroupKeywords | Sammelt die Varianten, welche bei den Print-Elementen im Feld Varianten auswählbar ist. Diese Varianten gelten für alle Elemente und machen keine Unterscheidung, welcher View verwendet wurde. |
PrintDocument\Keyword\Lib\Event\OnSortKeywords |
Kontext
Die Eventstruktur in PrintDocument/Keyword arbeitet über einen Kontext. Dieses dient für die verschiedenen Eventimplementationen als Entscheidung, ob diese reagieren und welche Keywords gesammelt werden sollen. Für Erweiterungen kann hier ein eigener Kontext (und dann ein eigener View) auf Basis von ContextKeywordAbstract abgeleitet werden oder bei den Kontexten aus der Produktimplementation eingegriffen werden.
Die Produktimplementation arbeitet mit ContextDocument für das Sammeln aller Einträge des mitgegebenen $documents und ContextPage sammelt alle Einträge der mitgegebenen $page. Die Ansicht View/Keyword entscheidet dann über den gepflegten Kontext bei den Elementeinstellungen, mit welchem ContextAbstract \Brandbox\PrintCore\PrintDocument\Keyword\Manager::get aufgerufen wird, um eine Stichwort-Struktur zurückzubekommen.