Leitfaden für Entwickler

Dieser Leitfaden richtet sich an Entwickler einer Top-logic-Anwendung die das Modul com.top_logic.help in ihr Projekt einbinden und die Funktionen zur Generierung und Anzeige einer Onlinehilfe nutzen wollen.

Vorbereitende Maßnahmen

Einbinden von com.top_logic.help

Um com.top_logic.help in Ihren Projekt zu nutzen müssen Sie die

anpassen. Beachten Sie die richtige Reihenfolge in multi-loader.properties und meta.xml. com.top_logic.help ist Anhängig von com.top_logic und com.top_logic.search.lucene und muss daher nach diesen Projekten in den Konfigurationsdateien eingebunden werden.

Einrichten der Eclipse IDE

com.top_logic.help benutzt zur Transformation aus Wikicode in HTML die Bilbiothek jamwiki-0.8.1.jar. Diese Bibliothek erwartet ihre Konfigurationsdateien unter WEB-INF/lib. Da die Bilbiothek unsere Multiloaderfunktionalität nicht kennt, muss com/top_logic/help/webapps/help/WEB-INF/lib explizit in den Classpath der Launchkonfiguration des Projekts aufgenommen werden.

Dies erreichen Sie, indem Sie in Eclipse unter Run->Run Configurations->${Ihr Projekt}->Classpath->User Entries->Advanced...->Add Folder com.top_logic.help/webapps/help/WEB-INF/lib hinzufügen.

Dieser Eintrag ist nur bei Anwendungen während der Entwicklung von Bedeutung. In einen deployten System wurden die Inhalte von WEB-INF/lib aus den einzelnen Projekten während des Deployments zusammenkopiert und jamwiki-0.8.1.jar residiert dann im "richtigen" WEB-INF/lib-Verzeichnis

Aufsetzen eines virtuellen Wikis

Konfigurieren der JAMWiki-Schnittstelle