AbHelp - HTML-Dateien

| ALPHA-VISION® AbHelp

# AbHelp - HTML-Dateien

Dieses Dokument beschreibt die für ALPHA VISION zusätzlich notwendigen Komentare zur

- Anbindung an die Applikation.
- Struckturierung des Help-Baums

HTML-Dateien für AbHelp können mit beliebigen Werkzeugen erstellt werden.

## Anbindung an die Applikation

Der Kommentar hat hat folgenden Syntax:

    (<!--AbHelp-Keywords:KEYWORD, SCHLUESSELWORT#Anker-->)

In der vorliegenden Version:

- Muß der Kommentar unmittelbar (d.h. ohne Leerzeichen oder Zeilenwechsel) nach dem einleitenden HTML-Tag beginnen
- Ist die Position der Kommentare inerhalb der HTML-Datei egal.
- Müssen Keywords in Grossbuchstaben geschrieben werden
- Können mehrere Keywords definiert werden
- Können Keywords auf einen Anker inerhalb des Dokuments verweisen;
- Müssen sich alle Schlüsselwörter innerhalb eines einzigen Kommentars befinden.

Beim Aufruf von AbHelp durch den "Usr_DisHiTi(Keyword)" -Job werden alle HTML-Dateien im Unterverzeichnis "help" des Programmverzeichnisses nach dem in der Kommandozeile übergebenen Schlüsselwort durchsucht. AbHelp bietet dann in einem zweigeteiltem Dialogfenster links den struckturierten Baum der Hilfedateien und rechts eine Liste aller Dateien an, in denen das angegebene Schlüsselwort als Keyword enthalten ist. Die gelisteten Namen sind die in den HTML-Dateien als "Titel" definierten. Über Mausklick können die Dateien direkt geöffnet werden, bei Keywords mit Anker, wird beim öffnen des Dokuments gleich auf die Ankerposition gesprungen. Definition (KEYWORD#Anker, )

## Struckturierung des Help-Baums

Der Kommentar definiert die Strucktur des Hilfe-Baums, er hat folgenden Syntax:

    (<!--AbHelp-ContentEntry:KapitelA\KapitelA.1\KapitelA.1.1)

In der vorliegenden Version:

- Muß der Kommentar unmittelbar nach dem einleitenden HTML-Tag beginnen
- Darf die HTML-Datei nur einen ContentEntry Kommentar haben
- Ist die Position der Kommentare inerhalb der HTML-Datei egal.
- Muß das Hilfeverzeichnis ein Unterverzeichnisse des Programmverzeichnis von AbHelp.exe sein
- Müssen alle Hilfedateien im Hilfeverzeichnis oder einem Unterverzeichnis davon liegen
- Dient das " \ "-Zeichen zur Trennung der Kapitelüberschriften.

Beispiel einer einfachen Struckturierung

    Kommentar in Datei "Verwaltung.html":
    <!--AbHelp-ContentEntry:Verwaltung\Verwaltung-->

    Kommentar in Datei "Bereich.html":
    <!--AbHelp-ContentEntry:Verwaltung\Bereich-->

    Kommentar in Datei "Abteilung_1.html":
    <!--AbHelp-ContentEntry:Verwaltung\Bereich\Abteilung_1-->

    Kommentar in Datei "Abteilung_2.html":
    <!--AbHelp-ContentEntry:Verwaltung\Bereich\Abteilung_2-->

hat folgende Baumstrucktur zu Folge:

    VERWALTUNG
         Verwaltung
         Bereich
      BEREICH
           Abteilung_1
           Abteilung_2

Es ist dabei volkommen unerheblich, in welchen Unterverzeichnissen der Hilfedatei die Dateien tatsächlich liegen