> Projekt: Software-Sanierung > Projekt-Management > Vorgaben > Hinweise zur Online-Hilfe

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
 


3. Design-und Implementationsspezifik

Anwendungsfall Verzeichnis ID-Bereich
Inhaltsverzeichnisse
Spezielle Informationen
Help_T /  Help_B 10 -
Detektoren Detektoren 1000 -
Motoren Motoren 2000 -
Allg. Einstellungen ... Allg_Ein 3000 -
Manuelle Justage Man_Just 4000 -
Automatische Justage Aut_Just 5000 -
HW-Breite messen HW_mess 6000 -
Topographie Topo 7000 -
Diff/Refl LineScan D_Line 8000 -
Diff/Refl AreaScan D_Area 9000 -
Diff/Refl LineScan, Darstellung D_Line_D 10000 -
Diff/Refl AreaScan, Darstellung D_Area_D 11000 -
Makros Makros 12000 -
4. Das Tool HelpScribble - allgemein und projektspezifisch

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:


 

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: