Glossar

Download

1. Beschreibung des Moduls

Dieses Modul erweitert die Website um eine automatische Glossar-Funktionalität. Neben der Pflege von Glossareinträgen mit zusätzlichen Informationen wie Synonymen etc. enthält das Modul bereits die erforderlichen Methoden, um das Glossar in die Strukturabstraktion zu integrieren und die Glossareinträge inkl. Übersicht anzuzeigen.
 

2. Aufbau des Moduls

+ http://onion.net/glossary
  + http://onion.net/glossary/container
  + http://onion.net/glossary/language
  + http://onion.net/glossary/entry
 

3. Integration

Es handelt sich um ein vollwertiges Modul, was nachinstalliert werden kann.

Daher ist bereits ein Rendering vorhanden. Eine Vorschau auf dem Glossar-Container listet alle vorhandenen Einträge für die Standard-Sprache Deutsch auf.

Eine Integration in die bestehende Website kann projektspezifisch erfolgen.

Voraussetzungen

Für den korrekten Import wird vorausgesetzt, dass bereits das Modul "XSL Renderengine" importiert wurde. Außerdem wird beim Import davon ausgegangen, dass es unterhalb des Root-Elements im Editor einen Transformationsspeicher mit Namen "Transformations" und darunter eine onion.net-Datenquelle mit Namen "Onion" gibt. Unterhalb dieser wird dann die Transformationsgruppe angelegt, die das mitgelieferte Rendering für das Glossar enthält.

Automatische Auszeichnung im Fließtext

Hierzu kann das Glossary-Modul genutzt werden, was sich im "Common Modules"-Paket befindet.

Dies muss zunächst in der web.config der Renderengine wie folgt konfiguriert werden:
<module type="Onion.RenderEngine.CommonModules.GlossaryModule, Onion.RenderEngine.CommonModules" />

Nun sollte der Namensraum auch im Namensraum-Assistenten im Editor zu Verfügung stehen (evtl. durch Speichern der Editor web.config neu laden).

Bei Vorhandensein eines Glossars kann dann die mitgelieferte Methode content.applyGlossary() aufgerufen werden, die sich um die Auszeichnung der Glossar-Einträge im Fließtext kümmert. Die Methode befindet sich im Modul auf dem Datentyp "userdefined" und sollte auf einen Datentyp in der eigenen Struktur verschoben werden. In der Basis Website etwa auf "visitable".

Wichtig: Die Verlinkung auf einen Glossar-Eintrag erfordert u.U. noch die Integration in die eigene Website, um den Kontext der Seite nicht zu verlieren.