Hinweise zur Online-Hilfe

Dokumentversion: 1.1 (12.03. 2001)
Autor:           Erstautor: U.Sacklowski, Fortschreibung durch projekt98
Zustand:   in Bearbeitung

Diese Dokumentation ist bei Bedarf/Erkenntnis durch die Projektmitglieder fortzuschreiben (mit Autorenhinweis).

Inhalt

1. Einführung
2. Inhalt und Struktur der Online-Hilfe aus Benutzersicht
3. Design-und Implementationsspezifik
4. Das Tool HelpScribble - allgemein und projektspezifisch
5. Online-Hilfe auf den Laborrechnern
 

1. Einführung

Neben den Benutzer-Leitfäden, die in der Physik in gedruckter Form u.a. an den Meßplätzen verfügbar sein werden, wird den Benutzern noch eine Online-Hilfe bereitgestellt. Unsere Orientierung hierbei zielt auf einen geringen Umfang.

Gründe:

- Aufwand für die Erstellung der Online-Hilfe und ihre spätere Pflege gering halten,
- freie Plattenkapazität auf den Meßplatzrechnern ist nur wenig verfügbar,
- die gedruckten Benutzer-Leifäden sind eigentlich ausreichend.

Aus diesem Grund werden wir weder ein Online-Tutorial, noch eine kontextsensitive Online-Hilfe implementieren, sondern nur ein Online-Manual von geringem Umfang (nachfolgend Online-Hilfe genannt).

Das XCTL-Steuerprogramm verfügt gegenwärtig über (fast) keine Online-Hilfe. Eine solche ist nun je Anwendungsfall zu entwerfen und zu implementieren.
 

2. Inhalt und Struktur der Online-Hilfe aus Benutzersicht
 

• Die Online-Hilfe erlaubt nur eine Navigation über das Inhaltsverzeichnis. Index (bzw. Such-Funktion) werden nicht unterstützt.
• Angeboten werden
• die wichtigsten Dialog- und Meß-Fenster mit ihren Funktionen und Werten,
• ein 'Sammelsurium' weiterer Informationen. (Ausgangsmenge hierbei sind die Informationen, die in der bisherigen Online-Hilfe unter 'Suchen' bereitgestellt werden.)
• Ein Navigieren zu den Dialog- und Meß-Fenstern kann alternativ erfolgen über
• die Funktionshierarchie des Hauptfensters,
• eine alphabetisch geordnetete Menge der Dialog- und Meß-Fenster.
• Die Online-Hilfe gibt es in rein textueller Form oder in textueller Form, ergänzt um die Bilder der Dialog- und Meß-Fenster. Bis auf diese Bilder sind beide Dokumente identisch!
• Die Online-Hilfe bezieht sich bei den Oberflächenobjekten (Dialogboxen, Meßfenster) nur auf die deutsche Version.

Deutsche oder englische Dialog- und Meß-Fenster?

3. Design-und Implementationsspezifik

• Text- und 'Bild'-Version werden in getrennten Verzeichnissen geführt, - Help_T für die Textversion, Help_B für die 'Bild'-Version.
• Die jeweilige Struktur erfolgt entsprechend den Anwendungsfällen und ist zweistufig hierarchisch. Unter den Inhaltsseiten liegen die Seiten zu den Anwendungsfällen.
• Die Inhaltsseiten insgesamt und jeder Anwendungsfall werden in einem eigenen Verzeichnis mit eigenem HelpScribble-Projekt abgelegt.
• Jedes Oberflächen-Objekt ergibt ein eigenes Thema mit eigener Topic-ID.
• Tabelle.: Anwendungsfall,  Verzeichnis,   Topic-ID - Bereich (aus HelpScribble):

• Details:
• Verzeichnisnamen max. achtstellig wegen Windows 3.11
• Topic-ID's sind unter Help_T und Help_B identisch (für die gleichen Themen)
• Die in den Verzeichnissen stehenden HelpScribble-Dateien sind identisch mit dem Verzeichnisnamen.

Beispiel: Motoren
     Motoren.hsc          HelpSribble-Projektfile
     Motoren.GID        HelpSribble-Indexfile
     Motoren.hlp           Windows-Helpfile für Motoren
• Die in Help_B verwendeten Bilder liegen in einem eigenen Verzeichnis 'Bilder' unter Help_B.

Bilder sind im bmp-Format abzulegen (.bmp fordert HelpSribble ???). Dieses 'voluminöse' Format wird von HelpScribble bei der Erstellung des Window-Helpfiles auf etwa 20% reduziert.
• Die beiden Online-Versionen werden in unserem CVS-System unter Help_T und Help_B verfügbar sein.

Die vorliegenden Anfangsrealisierungen zeigen
• die Gesamtstruktur,

Beispiele für
• ein Dialogfenster 'Common Settings for Drives',
• ein Meß-Fenster 'AreaScan-Window' mit einer PopUp-Funktion 'Setup Measurement', die zum Dialogfenster 'Measurement Setup for AreaSan's' führt und
• die Hilfe für die 'Speziellen Informationen'.
• Für den Test der gesamten Online-Hilfe genügt der Aufruf von Help_T.hlp oder Help_B.hlp.

Die Implementation von Windows-Online-Hilfen verlangt eine spezielle Syntax. Um davon zu abstrahieren, werden spezielle Tools für die Implementation von Windows-Online-Hilfen angeboten, - so auch HelpScribble.

HelpScribble unterstützt darüber hinaus bequeme Textformatierungen, einen schnellen Korrektur- make-Zyklus, vielfältige Link-Möglichkeiten u.v.a.

Für uns relevante Dateitypen sind das .hsc-File (HelpSribble-Projektfile), das .GID-File (Index-File, - obwohl wir die Index-Funktion nicht nutzten, wird es (wohl) standardmäßig angelegt) und das .hlp-File, welches schließlich aufgerufen wird, - bei uns in m_main.cpp unter DoCommandsFrame.

HelpScribble ist auf unserem Lehrstuhl-PC 'ahorn' verfügbar.

Wollen Sie dort arbeiten, müssen Sie zugelassen werden und unter e:\user ein Verzeichnis erhalten (z.B. e:\user\meier) - verantw. Uli Sacklowski.

Spezielle Hinweise zu Ablauf und Arbeit mit HelpScribble:

• Übernahme von Help_T oder Help_B aus dem CVS-System.
• HelpScribble starten
• Projekt öffnen
• Projekt, Options ...

Help Compiler:  16 Bit,   d:\bc\bin\hc31.exe
Output: abhängig vom Projekt, z.B.
Output:   e:\user\meier\help_b     für das Projekt im Help_B-Verzeichnis oder
Output:   e:\user\meier\help_b\motoren     für das Projekt im Motoren-Verzeichnis   usw.
Bitmap Path:   e:\user\meier\help_b\Bilder
• Einzelne Themen (Topics) bearbeiten, hinzufügen, löschen:

TopicBar (über View,  TopicBar herauszubekommen): auswählen,   +  hinzufügen,   -   löschen
• Textgestaltung:

Über TextBar.
• Links:

Help ToolBar:
Link zu Topic im gleichen Projekt:  Text markieren,  Ziel über 'Title' im Help ToolBar auswählen,  Symbol 'Link' im Help ToolBar
Link zu Topic in einem anderen Projekt:  Text markieren,   Symbol 'Special link' im Help ToolBar ,  danach in der
         Insert link - Dialogbox:
                   Link:  Other HelpScribble help file
                   File:   voller Pfad des .hlp-Files
                   Topic:  Nummer des Topics   (z.B. 9010)
                   OK
Insert bitmap:   Einfügestelle auswählen,   Symbol 'Insert bitmap' im Help ToolBar , anschließend vollen Pfad des Bildes eingeben
• Zwischendurch immer mal Projekt,  Save   und  Project,  Make,  um das Zwischenergebnis zu bewundern.
• Zurückspielen von Help_T oder Help_B in das CVS-System.
• Falls Erfolgserlebnis, dieses lauthals kundtun!!    :-)

5. Online-Hilfe auf den Laborrechnern

Für die Abarbeitung des XCTL-Steuerprogrammes müssen alle .hlp-Files des Help_T- oder des Help_B-Verzeichnisbaumes in einem Verzeichnis liegen. Sie sollten evtl. im Steuerprogramm-Verzeichnis in einem eigenen Verzeichnis 'help' zusammengefaßt werden. (Den Aufruf in m_main in DoCommandsFrame entsprechend ändern.)

Help_T oder Help_B wird in Abhängigkeit vom verfügbaren Plattenplatz installiert.

Grobe Abschätzung des erforderlichen Speicherbedarfs:

• Help_T  etwa 100 KB
• Help_B  etwa  2MB