Lade...
 

Online Hilfe

Online Hilfe

Die Online-Dokumentation des ClassiX®-Systems basiert auf Tiki Wiki.
Es gibt Online-Hilfe zu :

  • den AppsWarehouse® Modulen, also zu allen ClassiX® Anwendungen. Der in den Modulen verwendete InstantView®-Code enthält Verweise auf Dokumentationsfiles und Topics.
    Kundenspezifische Dokumentationen stehen nur über eine lokale Tiki Wiki Installation zur Verfügung.
  • dem InstantView® Sprachumfang: die Dokumentation zum gerade bearbeiteten InstantView®-Befehl kann über das Monitor-Window und/oder aus dem Eclipse-Editor heraus erreicht werden
  • den Klassen und Funktionen des CyberEnterprise® Unternehmensmodells: die Objekte zur Visualisierung der Metadaten des ClassiX®-Systems besitzen Funktionen, die zur entsprechenden Dokumentation verzweigen

Neben der allgemein gebräuchlichen Pfadangabe für das ClassiX® System (CX_ROOTDIR), kann speziell für die Online Hilfe der Pfad CX_HELPROOT definiert werden. Diese Pfadangaben können auch wieder spezialisiert werden für die Dokumentation der Anwendung (CX_APPSWH_HELP), der Skriptsprache InstantView® (CX_IV_HELP) und des Unternehmensmodells CyberEnterprise®(CX_CE_HELP), dies ist aber seit der Verwendung des Tiki Wiki nicht mehr sinnvoll.

 

Online-Dokumentation

Die Umgebungsvariable CX_HELPROOT enthält den Basispfad der ClassiX Online-Dokumentation (Infothek) und wurde mit der Einführung des Tiki Wiki aufgeteilt in CX_HELPROOT_APPSWH (Anwenderdokumention) und CX_HELPROOT_INSTANTVIEW (Entwicklerdokumentation).

Mit Basispfad ist das sprachübergreifende Verzeichnis der Dokumentation gemeint, also das Verzeichnis in dem sich die Unterverzeichnisse "de" und "en" befinden. Unterhalb dieses Pfades sind die einzelnen Verzeichnisse für die AppsWarehouse Dokumentation zu finden (Im Unterverzeichnis "CX_LANG/AppsWH"), der CyberEnterprise Dokumentation ("CX_LANG/CyberEnterprise"), von InstantView ("CX_LANG/InstantView") und die Dokumentation der ClassiX® Fehlermeldungen ("CX_LANG/Error").

Zu beachten ist, dass ClassiX® einige besondere Zeichenketten in dieser Umgebungsvariable ersetzt, um an den tatsächlichen Ort der Dokumentation zu gelangen: Wenn "CX_LANG" sich am Ende des Inhalts von CX_HELPROOT befindet, oder ein Backslash direkt auf "CX_LANG" folgt, dann wird "CX_LANG" durch die aktuelle Sprache ersetzt (also z. B. durch "de"). Wenn "CX_ROOTDIR" am Anfang von CX_HELPROOT steht, dann wird der String durch den Inhalt der Umgebungsvariablen CX_ROOTDIR ersetzt. 

Spez. Online-Dokumentation der Anwendung (AppsWarehouse® Module)

Für jedes Modul kann ein Dokumentationsfile angegeben werden. Abgeleitete Module erben das Dokumentationsfile des Basismoduls. Zum Modul gehörende Windowobjekte beziehen sich mit einer Topic-Angabe auf das HTML-File des Moduls oder definieren explizit ein anderes HTML-File (mit oder ohne Topic-Angabe).

Ist dem Filenamen keine Pfadangabe vorangestellt, so wird das HTML-File wie folgt gesucht:

  1. Wenn Environmentvariable CX_APPSWH_HELP=p1;p2;... definiert ist, werden die dort angegeben Pfade in dieser Reihenfolge durchsucht. In den Pfadangaben p1, p2, ... kann als Teildirectory CX_LANG angegeben werden: CX_LANG wird entsprechend der aktuell eingestellten Sprache durch einen 2-stelligen Sprach-Identifikator substituiert.
    Die Möglichkeit, mehrere Pfade anzugeben, erleichtert die Aufteilung der Dokumentation in allgemein gültige und kundenspezifische Anteile,

    z.B. CX_APPSWH_HELP=%CX_HELPROOT_LOCAL%\CX_LANG\AppsWH\PROJEKT;%CX_HELPROOT%\CX_LANG\AppsWH

    Hinweis:
    Mit Einführung des Tiki Wiki sollte diese Variable nicht mehr verwendet werden.
  2. Wenn Environmentvariable CX_APPSWH_HELP nicht definiert ist, jedoch Environmentvariable CX_HELPROOT / CX_HELP_ROOT_APPSWH, so wird das HTML-File in
    CX_HELPROOT_APPSWH\L0L1\APPSWH gesucht.  L0L1 steht für den 2-stelligen Identifikator der aktuellen Sprache.
  3. Wenn weder CX_APPSWH_HELP noch CX_HELPROOT / CX_HELPROOT_APPSWH definiert sind, wird in
    CX_ROOTDIR\DOC\L0L1\APPSWH gesucht. Auch hier L0L1 steht für den 2-stelligen Identifikator der aktuellen Sprache.

Welche Information erscheint, wenn für das Windowobjekt O, das gerade den Fokus besitzt, die Taste F1 gedrückt wird, hängt von O, seinen Parent-Objekten und seinem Modul ab:

Windowobjekt O Parent von O Modul gezeigter Text
- - - nichts
- - HELP("A.htm") Anfang von 'A.htm'
- HELP(topic1) HELP("A.htm" 'topic1' in 'A.htm'
HELP(topic2) HELP(topic1) HELP("A.htm" 'topic2' in 'A.htm'
HELP("B.htm~topic3" HELP(topic1) HELP("A.htm" 'topic3' in 'A.htm'

Die folgende Abbildung zeigt nochmals, in welcher Reihenfolge die Hilfs-Information gesucht wird (roter Pfeil):

html.gif

 

Spez. InstantView®-Dokumentation

Das ClassiX®-System hält eine feste Zuordnung zwischen Sprachkonstrukten und HTML-Files, in denen die entsprechende Dokumentation zu finden ist.
Wo sich diese Files befinden, wird mit folgenden Environmentvariablen gesteuert:

  1. Wenn Environmentvariable CX_IV_HELP=p1;p2;... definiert ist, werden die dort angegeben Pfade in dieser Reihenfolge durchsucht. In den Pfadangaben p1, p2, ... kann als Teildirectory CX_LANG angegeben werden: CX_LANG wird entsprechend der aktuell eingestellten Sprache durch einen 2-stelligen Identifikator substituiert.

    Die Möglichkeit, mehrere Pfade anzugeben, soll es InstantView®-Entwicklern erlauben, eine persönliche Version der Dokumentation, um eigene Bemerkungen und Randglossen erweitert, in einem separatem Directory zu unterhalten. 

    Hinweis:
    Mit Einführung des Tiki Wiki sollte diese Variable nicht mehr verwendet werden.
  2. Wenn Environmentvariable CX_IV_HELP nicht definiert ist, jedoch Environmentvariable CX_HELPROOT / CX_HELPROOT_INSTANTVIEW, so wird das HTML-File in
    CX_HELPROOT_INSTANTVIEW\L0L1\InstantView gesucht.  L0L1 steht für den 2-stelligen Identifikator der aktuellen Sprache.
  3. Wenn weder CX_IV_HELP noch CX_HELPROOT / CX_HELPROOT_INSTANTVIEW definiert sind, wird in
    CX_ROOTDIR\DOC\L0L1\InstantView gesucht. Auch hier L0L1 steht für den 2-stelligen Identifikator der aktuellen Sprache.

Beim Editieren mit Eclipse kann man mit Strg und Hyperlinking die InstantView®-Dokumentation zu dem Sprachkonstrukt aufrufen, auf dem sich der Cursor befindet.

Aus den Kommandozeilen des Monitor-Windows ruft F1 die Dokumentation zu dem dort markierten Befehl auf.

Spez. CyberEnterprise®-Dokumentation

Die Metaklassen verweisen indirekt auf den Namen eines Files, das die Dokumentation der entsprechenden Modell-Klasse enthält.
Analog gilt das auch für die im MDI eingetragenen Funktionen.

Die Dokumentation kann man aus dem ClassiX®-System heraus aufrufen:

  auf InstantView®-Ebene repräsentiert durch Hilfe aufrufen
Klasse deren Metaklasse (Objekt CX_META_CLASS) CX_META_CLASS::DisplayHelp()
Methode einer Klasse MDI-Eintrag als Objekt der Klasse CX_VESSEL CX_VESSEL::DisplayHelp()

Wo sich diese Files befinden, wird mit folgenden Environmentvariablen gesteuert:

  1. Wenn Environmentvariable CX_CE_HELP=p1;p2;... definiert ist, werden die dort angegeben Pfade in dieser Reihenfolge durchsucht. In den Pfadangaben p1, p2, ... kann als Teildirectory CX_LANG angegeben werden: CX_LANG wird entsprechend der aktuell eingestellten Sprache durch einen 2-stelligen Identifikator substituiert.

    Die Möglichkeit, mehrere Pfade anzugeben, soll es Entwicklern erlauben, eine persönliche Version der Dokumentation, um eigene Bemerkungen und Randglossen erweitert, in einem separatem Directory zu unterhalten. 

    Hinweis:
    Mit Einführung des Tiki Wiki sollte diese Variable nicht mehr verwendet werden.
  2. Wenn Environmentvariable CX_CE_HELP nicht definiert ist, jedoch Environmentvariable CX_HELPROOT / CX_HELPROOT_INSTANTVIEW, so wird das HTML-File in
    CX_HELPROOT_INSTANTVIEW\L0L1\CyberEnterprise gesucht.  L0L1 steht für den 2-stelligen Identifikator der aktuellen Sprache.
  3. Wenn weder CX_CE_HELP noch CX_HELPROOT / CX_HELPROOT_INSTANTVIEW definiert sind, wird in
    CX_ROOTDIR\DOC\L0L1\CyberEnterprise gesucht. Auch hier L0L1 steht für den 2-stelligen Identifikator der aktuellen Sprache.

InstantView