Das HELP-System für ZCPR3

von Mario Leubner

Zu vielen Programmen vom Z-System existieren HELP-Dateien. Aber auch für zahlreiche CP/M-Programme existieren Dokumentationen, die sich leicht in HLP-Dateien umwandeln lassen. Eine recht umfangreiche HLP-Sammlung wurde zu den Z-HELP's auf 3 Disketten zusammengefaßt. Wenn eine Festplatte zur Verfügung steht, kann man sich damit ein HELP-System aufbauen. Die HLP-Dateien befinden sich in Libraries und sind meist gecruncht als *.HZP. Nun kann man alle Dateien auspacken und erhält 571 Einzeldateien, was nicht gerade zur Übersichtlichkeit beiträgt. In den Libraries sind stets HLP-Files zu Programmen, die mit dem selben Buchstaben beginnen - also A.LBR enthält ABORT.HZP, AC.HZP, ACMD.HZP... Damit gibt es 26 Libraries, die jeweils eine unterschiedliche Anzahl an HELP-Files zusammenfaßt. Eine Ausnahme bildet Y.LBR: Da es keine Programme gibt, die mit Y beginnen, sind dort die HELP-Files zu SYSLIB, VLIB, Z3LIB usw. untergebracht.

Zur Arbeit mit den HELP-Dateien existieren verschiedene Programme, wie z. B. HELP.COM, HELPC.COM und LBRHLP.COM. Das erste kann nur unkomprimierte Einzeldateien verarbeiten, HELPC kann gecrunchte Dateien lesen. Es existieren auch Versionen für gesqueezte Dateien, aber diese Methode ist nicht so leistungsfähig wie das Crunchen. Die besten Erfahrungen habe ich mit LBRHLP gemacht. In diesem Paket gibt es je ein Programm für gecrunchte und gesqueezte Dateien. Der Vorteil von LBRHLP besteht darin, daß die LBR's nicht ausgepackt werden müssen. Man behält die Übersicht auf der Festplatte und kann trotzdem auf alle Dateien schnell zugreifen. Zum Verwalten der Libraries existieren genügend Programme, so daß eine Aktualisierung/Erweiterung der LBR's problemlos möglich ist.

Die Version 2.2 von LBRHLP hatte aber auch noch ein paar kleine Schwächen, weshalb ich eine Überarbeitung vorgenommen habe. Bisher mußte man wissen, wo sich welche HELP-Datei befindet und dies beim Programmaufruf angeben also beispielsweise

A0>LBRHLP -A AC

oder man hatte ein ALIAS, was bei der Eingabe eines einzelnen Buchstaben daraus ein HELP-Kommando machte, wie

A=B=C=...=Z LBRHLP -$0 $0

Die jetzt vorliegende Version 2.3 kann

 

  • direkt auf Einzeldateien zugreifen, wenn dies installiert ist,
  • LBR's wechseln und zeigt an, wo sich die HLP-Datei befindet und
  • verschiedene Informationen auf ein Blatt ausdrucken.

Damit kann ein Hauptmenü geschrieben werden, das bei Eingabe des Kommandos HELP (ohne zusätzlichen Parameter) erscheint. Die Gestaltung des Hauptmenüs bleibt jedem selbst überlassen. Bei Betätigung einer Buchstabentaste verzweige ich in das Untermenü der entsprechenden LBR's, die Methode über das ALIAS funktioniert aber ebenfalls. Für häufig benötigte Programme kann man Querverweise direkt einbauen. Auch Menüs zu bestimmten Themen sind denkbar. Der Phantasie sind also keine Grenzen mehr gesetzt, wenn man die Verschachtelungstiefe von maximal 15 einhält.

Auf der Beilagendiskette befindet sich unter anderem die Datei HELP.HLP, in der einige deutsche HELP's aus HLPFILES.LBR direkt erreicht werden können. Dieses Hauptmenü soll nur als Anregung dienen und kann beliebig ausgebaut werden.

Die Dateien in HLPFILES.LBR sind auch nicht alle so vorgefunden worden, einige einhalten den Hinweis ,,HELP-Index von...``, das heißt es war eigentlich eine normale DOK-Datei. Um daraus eine HELP-Datei zu machen, gibt es verschiedene Möglichkeiten:

 

  1. Datei muß mit einem Doppelpunkt beginnen. Das eignet sich vor allem für kurze Beschreibungen, welche dann fortlaufend angezeigt werden.
  2. Datei beginnt mit einem Inhaltsverzeichnis, jeder Abschnitt mit einem Doppelpunkt. LBRHLP numeriert dann die Zeilen des Inhaltsverzeichnisses automatisch durch.
  3. Datei beginnt mit einem Semikolon, diesem folgt die Titelseite. Jeder Abschnitt beginnt mit einem Doppelpunkt gefolgt von der Taste, welche zu dem Abschnitt führen soll.

    Die meisten HLP's sind im letzten Format. Eine vorhandene Beschreibung läßt sich meist ziemlich gut in dieses Format umwandeln, wenn man das Inhaltsverzeichnis als Titelseite nimmt. Dann ist jedem Abschnitt noch die Taste zuzuordnen und der Abschnitt entsprechend zu markieren. Etwas Feinarbeit mit Inversdarstellung und Bildaufteilung kann die Lesbarkeit weiter erhöhen. Wem dies zu schnell ging, der sollte am Besten HELP.HLP mal starten. Dort ist das Ganze etwas ausführlicher beschrieben. Wer mit englischen Beschreibungen keine Probleme hat, kann auch die HELP-Datei aus LBRHLP23.LBR durchlesen. Übrigens sind die meisten HELP-Dateien vom Z-System ebenfalls in englisch...

    Ich hoffe, mein verbessertes LBRHLP kommt bei allen Z-System- Usern gut an. Alle Programmierer rufe ich auf, für größere Programme die Dokumentationen gleich als HLP zu schreiben. Für meine Programme (DEP3, HCBASIC, ...) ist das ja bereits geschehen. Interessant ist sicherlich auch die HLP-Datei zum Linker LINK131 (siehe SYSGEN), welche ich von einer SCP-3-Diskette entnommen und für HELP aufbereitet habe.