Work in progress
Modul com.top-logic.help
Das Modul com.top-logic.help wird im folgenden als Onlinehilfe bezeichnet. Dies kann missverständlich sein, da im Sprachgebrauch der Nutzer unter Onlinehilfe nur die GUI-Komponenten dieses Moduls verstanden werden. Im Glossar finden sich die hier benutzten Bezeichnungen für einzelnen Bestandteile der Onlinehilfe.
Anforderungen
Die Anforderungen an das Modul Onlinehilfe umfassen:
Schittstelle zu JAMWiki
com.top-logic.help soll aus einem JAMWiki Artikel importieren und in einer Top-Logic-Anwendung darstellen können.
Darstellung der Onlinehilfe
Einbindung in die GUI einer Top-Logic Anwendung
Technische Umsetzung
Leitfaden zur Benutzung
Pflege der Inhalte in JAMWiki
Konfigurieren der Anwendung
Import und Generieren der Onlinehilfe
Überblick der Konfiguration in der AdminHelpComponent
Glossar
- Onlinehilfe
- Bezeichung für com.top-logic.help
- Hilfefenster
- Eigenständiges Fenster in dem Inhaltsverzeichnis, Suche und Hilfeseiten dargestellt werden.
- Inhaltsverzeichnis
- Baumartig strukturierte Übersicht über Hilfeseiten.
- Hilfeseite
- Eine einzelne Seite, die einem Wikiartikel entspricht.
- Suche
- Suchindex
- Hilfeknoten
- Ein Knoten im Inhaltsverzeichnis.
- Ein Knoten hat eine eindeutige helpID und eine helpURL, die auf eine Hilfeseite verweist.
- helpID
- Identifikator eines Hilfeknotens.
- helpURL
- Verweis eines Hilfeknotens auf eine Hilfeseite