;                      LBRHELP Version 2.3 --- Hauptmenu                      

  Um Hilfe zu einem bestimmten Programm zu erhalten, ist der Anfangsbuchstabe
  des Programmes einzugeben. Danach wechselt LBRHLP zum Untermenue aller Pro-
  gramme, die mit dem Buchstaben beginnen. Von da aus lassen sich die einzel-
  nen Hilfeseiten aufrufen. Grundlage des HELP-Systems sind die Biblotheksda-
  teien A.LBR bis Z.LBR in einem Verzeichnis mit dem Name HELP:.

   Zusaetzliche Informationen: 

   1....Einfuehrung in das HELP-System
   2....LBRHLP Syntax
   3....Aufbau der HELP-Files
   4....HELP.COM, HELPC.COM, HILFE.COM, LBRHLP.COM
   5..
   6..
   7..
   8..
   9..
   0....Menu in HELPFILES.LBR (deutsche HLP-Files)
:1
 Einfuehrung: 

HELP ist ein interaktives 'online'-Dokumentationssystem. Im Gegensatz zu den 
ueblichen .DOC oder READ.ME Files koennen mit HELP gezielt Informationen zu 
einzelnen Themen gelesen werden, ohne sich durch das ganze File durchkaempfen 
zu muessen. Ausserdem kann der angezeigte Bildschirminhalt/Abschnitt ausge-
druckt werden.

Die meisten HELP-Files enthalten dafuer einen Index, mit dem sich aber auch
leicht jedes ASCII- oder WordStar-Textfile mit einem Index nachruesten laesst.
Alle HELP-Files im ASCII Format lassen sich wie ueblich mit 'type' ausdrucken.
Mit WordStar erstellte HELP-Files muessen entweder von den Steuerzeichen be-
freit (z.B. mit UNIKON) oder mit WordStar selbst ausgedruckt werden.

Auch HELP-Files ohne Index lassen sich mit HELP lesen, wenn das erste Zeichen 
des Textes ein ':' ist und der Dateiname *.H?P ist. Vorteil gegenueber 'type': 
Die Textausgabe haelt nach jeder Seite an und bestimmte Stellen koennen belie-
big oft gelesen werden.

HELP.COM wurde weiterentwickelt als HELPC und LBRHLP, wodurch sich ein sehr
effektives und uebersichtliches HELP-System auf Festplatten aufbauen laesst.
 HELPC 

HELPC ersetzt das Standard-HELP des Z-Systems. Es arbeitet mit gecrunchten und 
unkomprimierten Dateien. Die Anwendung gecrunchter HELP-Files ist jedoch stark 
von der Groesse des zur Verfuegung stehenden TPA-Bereiches eingeschraenkt.
Die Bildschirmdruck-Option ist gesperrt, wenn das WHEEL-Byte "off" ist. Die
Druckfunktion arbeitet in der Version 1.5 ohnehin nur korrekt, wenn der
Druckertest deaktiviert ist.

HELPC V1.5 hat eine verbesserte Dateisuch-Routine, welche Dateien ueberspringt,
die das Programm nicht bearbeiten kann.


 HILFE 

Wer das HELP-Kommando auch unter CP/M anwenden moechte, hat die Moeglichkeit 
auf eine aeltere Version von HELP zurueckzugreifen. HILFE.COM entspricht der 
HELP-Version 1.8 und benoetigt kein ZCPR-System, bietet jedoch auch nicht die 
Leistungen von HELP53, HELPC15 und LBRHLP23. Alle Steuerzeichen zur Invers-
darstellung (^A und ^B) sind fuer HILFE.COM zu entfernen.

 LBRHLP 

Letzte Entwicklungsstufe des HELP-Systems ist LBRHLP V2.3, bei dem die HELP-
Files in Bibliotheksdateien (*.LBR) zusammengefasst werden koennen. LBRHLP
existiert in zwei Versionen: LHQ behandelt gesqueezte und LHC gecrunchte
Dateien, beide koennen aber auch unkomprimierte Dateien lesen. Der Zugriff
auf HELP-Files ausserhalb der Bibliotheken ist weiterhin moeglich.

Mit der Version 2.3 wurde es moeglich, innerhalb der LBR's zu wechseln und
damit ein sehr flexibles und gut strukturiertes HELP-System anzulegen. Als
Anfangs- oder Hauptmenue dient eine Datei, die das Verzweigen zu den Unter-
Menues gestaltet und allgemeine Hinweise enthaelt. Diese HELP.HLP kann dafuer
als Beispiel dienen. Sie geht davon aus, dass es fuer jeden Buchstaben ein
LBR-File gibt. Das Untermenue ist darin als HLP-Datei mit dem gleichen Buch-
staben gespeichert.

 Anmerkungen: 

Ich meine, das HELP-System mit LBRHLP23 bietet gegenueber den ueblichen
Programmbeschreibungen so viele Vorteile, dass es jeder in Zukunft intensiv
nutzen sollte. Zum Teil wusste man ja schon gar nicht mehr, welches READ.ME
zu welchem Programm gehoert...

Die Informationen in diesem HELP-File stammen aus dem Original HELP.HLP, aus 
HILFE.HLP, HELPC15.FOR, LBRHLP22.HLP, RELEASE.N-Z sowie eigenen Erfahrungen.
Es kann kein Anspruch auf Vollstaendigkeit erhoben werden. Fuer Anregungen,
Verbesserungen und weitere Informationen stehe ich gern zur Verfuegung.

Deutsche HELP-Files sind noch relativ wenig verbreitet, bekannt sind z.B.
HILFE.HLP, QL41.HLP, ZEX50.HLP und LIBRARY.HLP vom Z-System. Fuer meine
Programme gebe ich in letzter Zeit die Beschreibungen ebenfalls als HELP-File
dazu: HCBASIC.HLP, DEP3.HLP, POWER.HLP. Vielleicht findet sich ja jemand,
der Zeit und Lust hat, weitere zu uebersetzen?

		Mario Leubner
		Chemnitztalstrasse 25
		D-09236 MARKERSDORF			(c) 29.05.97
:2
 Syntax:       LBRHLP {-{dir:}library} {{dir:}hlpfile}

 1. LBRHLP //			... online Hilfeseite
 2. LBRHLP			... Standardhelpfile (Hauptmenue)
 3. LBRHLP filename		... filename.h?p
 4. LBRHLP :filename		... filename.h?p als Einzeldatei
 5. LBRHLP -lib filename	... filename.h?p aus lib.lbr

Hinweise:

Ist in der Kommandozeile keine Bibliotheksdatei angegeben (wie bei 2. und 3.),
wird nach der Datei in der Standardbibliothek gesucht. Ist keine Standardbi-
bliothek installiert, dann wird eine normale Datei benutzt.

-> Ohne Standardbibliothek kann LBRHLP also wie das HELP-Kommando verwendet
   werden, das Hauptmenu (z.B. MENU.HLP) sollte sich dann als Einzeldatei
   im Alternativ-Verzeichnis befinden.

Die Dateisuche beginnt fuer jede Datei im aktuellen bzw. angegebenen
Verzeichnis, danach wird das Alternativ-Verzeichnis gelesen.
 Kommandos unter LBRHLP: 

	CR  -  zum naechsten Bild
      Space -  gleiche Wirkung wie "CR"
	L   -  zum vorhergehenden Bild
	S   -  zum Beginn des Abschnitts
	M   -  zum Menu des aktuellen HELP-Files
	,   -  zum vorhergehenden Level
	^   -  gleiche Wirkung wie ","
	.   -  zum ROOT-Level
	P   -  aktuelle Bildseite drucken
	^P  -  aktuellen Abschnitt drucken
	ESC -  LBRHLP beenden
	^C  -  gleiche Wirkung wie "ESC"
:3
 Wie werden HELP-Files geschrieben? 

Files fuer das HELP-System koennen mit jedem Texteditor oder auch mit WordStar
geschrieben werden. Um die Informationen uebersichtlicher darzustellen, kann
man Steuerzeichen in den Text einbauen. Moeglich sind:

	^A	Beginn  Standout-Modus 
	^B	Ende  Standout-Modus 
	^L	FormFeed (Seitenvorschub)

WordStar hat hierfuer das Kommando ^P, gefolgt vom jeweiligen Steuerzeichen, 
also z.B. ^P^L. Der Standout-Modus wird terminalabhaengig als Revers- oder 
Dim-Video dargestellt. FormFeed fuellt den Rest der Bildschirmseite mit 
Blanks, so wie hier ..
 Help-Files 

Der Benutzer hat verschiedene Moeglichkeiten, seine HELP-Files zu erstellen:


 1. HELP-Files ohne Index 

Diese Files muessen immer mit einem Doppelpunkt als erstes Zeichen beginnen! 
Das Verfahren bietet sich vor allem fuer kurze Informationen (ein bis zwei 
Bildschirmseiten) an, wenn ein Index ueberfluessig ist. Diese Dateien werden
fortlaufend angezeigt.

 2. HELP-Files mit automatischem Index 

Hier stehen die Einzelpunkte des Inhaltsverzeichnisses (ohne ':') am Anfang 
des Textfiles. Bei der Anzeige des Index ergaenzt LBRHLP jede Ueberschrift 
mit einem Kennbuchstaben. Es sind so viele Ueberschriften moeglich, wie das 
ASCII-Alphabet Zeichen zulaesst. Es sollten aber nach Moeglichkeit nur maximal 
19 Ueberschriften (Kapitel A. bis S.) verwendet werden, damit die Indexseite 
auf eine Bildschirmseite passt. Zu jeder Ueberschrift muss ein entsprechendes 
Kapitel im Text vorhanden sein. Die Ueberschriften koennten z.B. wie folgt 
aussehen:

Einfuehrung in mein Superprogramm
Wie wird es gestartet?
Wie verlasse ich es wieder moeglichst schnell!

Das entsprechende Kapitel wird im Text mit einem Doppelpunkt in der ersten 
Textspalte eingeleitet, danach kann die Ueberschrift des Kapitels folgen, also 
z.B. ':Einfuehrung in mein Superprogramm'. Danach kommt der Text! Die 
Ueberschrift wird bei der Anzeige des Kapitels als erste Bildschirmzeile mit 
ausgegeben.

 3. HELP-Files mit eigenem Index 

Das Textfile beginnt mit einem Semikolon. Dieses Zeichen leitet die Index-
Seite ein. Die Indexseite wird beginnend mit dem Zeichen, das dem Semikolon 
folgt bis zum ersten Doppelpunkt am Zeilenanfang angezeigt. LBRHLP.COM fuegt 
keine Kennbuchstaben hinzu, der Autor kann und muss das "Titelbild" selbst 
gestalten und den einzelnen Menuepunkten Kommandotasten zuordnen. (Diese Art 
wurde auch bei dem vorliegenden HELP.HLP angwandt.) Die Indexseite sollte
auch hier nicht laenger als eine Bildschirmseite sein, da sonst die Menue-
Kommandoeingabe in der ersten Titelseite noch nicht moeglich ist! Fuer den 
Index koennen Ziffern und Buchstaben verwendet werden. Das Titelbild koennte 
z.B. so aussehen:

	1 - Einfuehrung		2 - Start	3 - Anmerkungen

Im Text wird das Kapitel Einfuehrung dann mit ':1' eingeleitet. Diese Zeile 
wird nicht mit angezeigt! Eine Ueberschrift muss also im Gegensatz zum 
automatischen Index in eine zusaetzliche Zeile geschrieben werden.

 Untermenuetechnik: 

Es ist moeglich, aus dem aktuellen in ein anderes HELP-File (Untermenue) zu 
wechseln. Wenn z.B. ein Menuepunkt '9 - HELP2.HLP' lautet, dann ist im Text 
ein "Kapitel" mit ':9:HELP2' oder ':9:HELP2.HLP' einzuleiten. Diese Schreib-
weise veranlasst LBRHLP das HELP-File HELP2.H?P nachzuladen und als Untermenue
(Level) zu verwalten. Bei der Anwendung des automatischen Indexist die 
Schreibweise '::HELP2' um mit dem folgenden Menuepunkt in das Untermenue zu
gelangen. Soll in ein anderes LBR-File gewechselt werden, dann ist vorher
noch der LBR-Name mit fuehrendem Minuszeichen zu schreiben.

 Beispiele:    :1:TEST     wechselt zu TEST.H?P, befindet man sich in einem
                           LBR-File, dann wird TEST.H?P von dort geladen.
               :2:-M MENU  wechselt zu MENU.H?P in M.LBR

 Hinweis:  Ein Kapitel kann entweder Text enthalten oder in ein Untermenue 
           wechseln. Weitere Zeilen nach dem Unterprogrammaufruf ignoriert
           LBRHLP.
:4
                                - HILFE.COM - 

   Groesse      CRC   Version  Autor der letzten Ausgabe  Datum      Disk
   5k (39rec)   D0CB  1.8      ?                          ?          ?
   ------------------------------------------------------------------------
                                 - HELP.COM - 

   Groesse      CRC   Version  Autor der letzten Ausgabe  Datum      Disk
   4k (26rec)   CB91  5.3      R. Conn.                   05/84      Z3COM4
   ------------------------------------------------------------------------
                                - HELPC.COM - 

   Groesse      CRC   Version  Autor der letzten Ausgabe  Datum      Disk
   5k (34rec)   5794  1.5      Howard Goldstein           16.09.91   ?
   ------------------------------------------------------------------------
                                - LBRHLP.COM - 

   Groesse      CRC   Version  Autor der letzten Ausgabe  Datum      Name
   6k (41rec)   79FA  2.3      Mario Leubner              06.06.97  LHC.COM
   5k (38rec)   8DE5  2.3      Mario Leubner              06.06.97  LHQ.COM
:56789
                          Menuepunkt nicht definiert!
:0:-HLPFILES MENU
:A:-A A
:B:-B B
:C:-C C
:D:-D D
:E:-E E
:F:-F F
:G:-G G
:H:-H H
:J:-J J
:K:-K K
:L:-L L
:M:-M M
:N:-N N
:O:-O O
:P:-P P
:Q:-Q Q
:R:-R R
:S:-S S
:T:-T T
:U:-U U
:V:-V V
:W:-W W
:X:-X X
:Y:-Y Y
:Z:-Z Z
