Hilfe-Seite (HTML) Generator
Beschreibung
Mit dieser App kann für ein Modul eine HTML Hilfe-Seite generiert werden, um diese in die AppsWarehouse® Tiki-Wiki Hilfe einzubinden.
Funktionalität
Hilfe-Seite (HTML) Generator
Die App kann z.B. im AppsWarehouse Browser nach Auswahl eines Moduls aufgerufen werden. Ist das Modul von einem anderen Modul abgeleitet, werden auch die anderen voneinander abgeleiteten Module in dieem Fenster aufgelistet und das Basis Modul automatisch im Feld "Selektiertes Modul" vorausgewählt.
Menüpunkt | Beschreibung |
---|---|
Bearbeiten | - |
: Hilfe Seite aufrufen | - |
: : AppsWarehouse Hilfe | Aufruf der im AppsWarehouse Tiki-Wiki eingebundenen Hilfe-Seite des ausgewählten Moduls. |
: : generierte Hilfedatei | Anzeige der neu generierten HTML Seite des ausgewählten Moduls. |
: CyberEnterprise Klassen | - |
: : Einfügen | Aufruf der App, um CyberEnterprise Klassen auszuwählen. Diese CyberEnterprise Klassen |
: : Entfernen | Die in der Liste der CyberEnterprise selektierten Klassen werden aus der Liste entfernt. |
: Verwandte Themen | - |
: : Einfügen | Aufruf der App, um Module als verwandte Themen auszuwählen. |
: : Entfernen | Die in der Liste der verwandten Themen selektierten Module werden aus der Liste entfernt. |
Feld | Beschreibung |
---|---|
Module | |
: Seitenkopf | |
: : Überschrift | Überschrift der neu zu generierenden Hilfe-Seite. |
: : Autor | Autor des Moduls (wird zur Zeit nicht ausgewertet). |
: : Beschreibung | Die hier eingebene Beschreibung wird als Beschreibung in die Hilfe-Seite übernommen. |
: Modulgruppe | |
: : Selektiertes Modul | Modul, für das die Hilfe-Seite generiert wird. |
: : davon abgeleitet | Liste der vom ausgewählten Modul abgeleiteten Module. Durch Doppel- oder Rechts-Klick mit der Maus auf einen Eintrag wird dieser als "selektiertes Modul" ausgewählt. |
: : abgeleitet von | Ausgabe des Modul, von welchem das selektierte Modul abgeleitet ist. Durch Doppel- oder Rechts-Klick mit der Maus wird dieses Basis-Modul als "selektiertes Modul" ausgewählt. |
: CyberEnterprise Klassen | |
: : Klassen |
Liste der Klassen, die auf der Hilfe-Seite in der technischen Dokumentation unter der Überschrift "Klassen" aufgeführt werden sollen. Es sollte die Klassen umfassen, die in der App verwendet werden. Mittels dieser Information kann durch Sperren von Klassen (neben dem Sperren der ein- und ausgehenden Nachrichten) die Nutzung der App eingeschränkt werden. Mittels der rechten Maustaste öffnet sich der Menüeintrag "CyberEnterprise Klassen". |
: Verwandte Themen | |
: : Module |
Liste der Module, die auf der Hilfe-Seite unter der Überschrift "Verwandte Themen" aufgeführt werden sollen. Mittels der rechten Maustaste öffnet sich der Menüeintrag "Verwandte Themen". |
Verzeichnisse | |
: Lesen | |
: : Basis Verzeichnis | Ausgabe des Basis-Verzeichnis des gestarteten Classix Systems. |
: : Module | Verzeichnis, aus welchem die Module ausgelesen wurden. |
: : Vorlagedateien | Verzeichnis für die zum Generieren notwendigen Vorlagedateien. |
: Schreiben | |
: : Hilfe Ausgabe | Verzeichnis, in welches die neu erstellte HTML Datei geschrieben wird. |
: : Dateiname | Name der zu generierenden Hilfe-Seite Datei. |
Knopf | Beschreibung |
---|---|
Zurück | - |
Hilfe generieren | Hilfe-Seite Datei im Format HTML generieren |
Hilfe anzeigen | Anzeige der neu generierten oder der bereits im Tiki-Wiki eingebundenen AppsWarehouse Hilfe. Siehe im Menü den Punkt "Hilfe Seite aufrufen". |
Verwandte Themen
Technische Dokumentation
Implementation
Klassen
_
Qualitätssicherung
_
Hilfe-Seite (HTML) Generator App
Modulname
appGeneratorHelpEdit.app
Security
Neben der Beschränkung der Zugriffsrechte über die Klasse und deren Datenfelder kann das Modul über einige der empfangenen Messages in seiner Nutzung beschränkt werden.
Message | Parameter | Funktion | Security |
---|---|---|---|
EDIT_APP_GENERATOR_HELP |
Message | Parameter | Funktion | Empfangs-Modul |
---|---|---|---|
SELECT_APPSWH_MODULE | Auswahl von Modulen für die Liste an verwandten Themen. | ||
SELECT_META_CLASS | Auswahl von CyberEnterprise Klassen für die Liste der in der App verwendeten Klassen. |