;
     HELP - The Online Documentation System for ZCPR3

             W - Welcome to the HELP Command

    -- HELP Subsystem --        -- Using HELP --
    1 - HELP   Command       U - How to Use HELP
    2 - HELPCK Command       M - Moving Around in HELP
    3 - HELPPR Command       P - Help Command Prompts
                             E - HELP Error Messages
                             O - Printing Help Files

                 -- Writing HELP Files --
                H - How to Write HELP Files
                V - Accessing Video Attributes
                T - HELP File Tree Structure
                S - Sample HELP Files

:1

Command:  HELP 5.0

Syntax:
    HELP                <-- display HELP.HLP
or
    HELP filename.typ   <-- display HELP file
                            (i� 'typ� omitted� HL� i� used)

Function:

    HELР display� HEL� file� i� a� interactiv� wa� t� th� �
use� o� hi� consol� CRT��  I� i� als� abl� t� prin� selecte� �
screens or information sections on the printer.

Options:
    None


Comments:
    See text

Selected Error Messages:
    See appropriate information section

Examples of Use:

    HELP
         -- display HELP.HLP

    HELP myfile
         -- display myfile.HLP

    HELP myfile.txt
         -- display myfile.txt

:2

Command:  HELPCK 1.0

Syntax:

    HELPCK dir:ufn o    <-- default file type is HLP

Function:

    HELPC� i� use� t� chec� th� synta� o� � HEL� file��  I� �
analyze� th� file�� providin� � variet� o� statistic� an� �
reportin� o� structura� errors��  Thes� report� includ� � �
listin� o� th� option� i� th� fil� i� user-indexed� an� thi� �
listin� ca� b� manuall� checke� b� th� use� t� se� tha� al� �
option� ar� include� an� n� additional�� hidde� option� �
exist.

Options:
    P - Send report to Printer


Comments:

    None

Selected Error Messages:

    Messages as self-explanatory

Examples of Use:

    HELPCK myhelp
         -- report on myhelp.HLP

:3

Command:  HELPPR 1.0

Syntax:

    HELPPR afn1,afn2,... o...

Function:

    HELPPҠ i� use� t� prin� ou� � HELР file��  I� break� �
page� o� eac� informatio� sectio� an� ignore� for� feed� �
(use� t� separat� frames)�� s� th� dat� i� presente� i� � �
sequentia� fashion��  Thi� too� i� usefu� i� providin� �
printouts of HELP files in a reasonable format.


Options:

    H@head@   Heading Text which appears at the top of
                   each page
    I         Inspect Files (select) before printing
    L         Number each line
    Occ       Offset each line by cc spaces
    Snn       Skip to page nn before beginning print
    T         (If TIMELIB installed) turn off time display

Comments:

    HELPҠ i� preferre� ove� PRIN� fo� printin� HELР file� �
becaus� o� HELPPR'� knowledg� o� th� interna� structur� o� �
HELP files and its special way of formatting their printout.


Selected Error Messages:

    Error Messages are Self-explanatory

Examples of Use:

    HELPPR myfile1,myfile2 o5
         -- prin� myfile1.HL� an� myfile2.HL� offse� b�� � �
spaces on each line

    HELPPR myfile s5
         -- print myfile.HLP starting at the 5th page

:W

               Welcome to the HELP Command

    Welcom�  t� th� HEL� Command��   Th� HEL� Comman� i� �
designe� t� assis� you��  th�  ZCPR�  user��  i�  th� us� o� �
ZCPR��� i� genera�  an�  specifi�  ZCPR�� command�  i�  �
particular��   I�  i�  designe�  a�  a�  interactive��  on-�
lin� assistanc� system.

    HELР pull� i� file� name� <FILENAME>.HL� fro� dis� an� �
display�  thes� t� th� use� i� � page� mode��  Thes� file� �
ar� o� tw� basi� type� -- indexe� an� non-indexed.


    Indexe� file� ar� thos� HEL� file� whic� star� wit� a� �
index��  Thi� i� a�  exampl�  o�  a� indexe� file��   Whe� �
HELР load�  a�  indexe�  file��  i� display�  thi� inde� t� �
th� use� an� allow� hi� t� selec� entrie� fro�  it�� Th�  �
use� ma� selec� a� man� entrie� a� h� desire� i� an�� orde� �
h�  desire� b�  simpl� typin� th� lette� o� hi� selection�   �
Onc� th� use� ha� mad� hi� selection�� HEL� wil� loo� u� th� �
bod�� o� tex� h� selecte� an� displa� i� t� hi�  i� � page� �
mode��   Whe� th� use� ha� finishe� readin�  hi�  selection� �
HELР  the� return� hi� t� th� inde�� menu��   Typin� � �
Control-�  wil� retur� th� use� t� ZCPR3.

    Ther� ar� tw� type� o� indexe� HELР file� - user-�
indexe� an� HELP-indexed��  � user-indexe� HEL� fil� i� on� �
i� whic� th� write� o� th� HEL� fil� i� allowe� t� creat� �
th� imag� o� th� inde� o� hi� scree� i� th� for� whic� wil� �
b� displaye� t� th� use� o� th� HEL� file��  Thi� i� � user-�
indexe� HEL� file�


    �� HELP-indexe� HEL� fil� i� on� whic� contain� � lis� �
o� th� option� a� th� beginnin� o� it�� an� HEL� create� th� �
menu�� assignin� sequentia� letter� (A�� B� etc� t� th� men� �
options.

    Non-indexe�  file�  ar�  thos� HEL� file� whic� d� no� �
star�  wit�  a� index���   I� suc� cases���  HELР wil� �
immediatel�� displa� th� content� o�  th� fil� t� th� use� �
and��  whe� th� use� ha� finishe� lookin� a� it��  HEL� wil� �
retur� t� ZCPR3.


    HEL� i� menu-driven�� an� al� th� command� availabl� t� �
th� use� a� an� give� tim� ar� displaye� t� him�

    Th� versio� o� HEL� describe� i� thi� HLР fil� i� �
designe� t� wor� wit� th� ZCPR� syste� an� tak� advantag� o� �
som� o� it� specia� features.


                                            Richard Conn
:U

               How to Use the HELP Command

    The HELP Command is executed in one of three ways:

         (1) by just typing 'HELP'
         (2) by typing 'HELP FILENAME', where FILENAME
             is the name of a disk file named FILENAME.HLP
         (3) by typing 'HELP FILENAME.TYP', where
             FILENAME.TYP is the name of a file created in
             the format of a help file

    I� th� use� type� jus� 'HELP'�  h� wil� revie� th� fil� �
HELP.HLP� whic� shoul� contai� � brie� summar� o� ho� t� us� �
th� HEL� command��  Fo� al� othe� form� o� th� HEL� command� �
th� use� wil� se� th� specifie� hel� fil� information�  �
Generall�� speaking�� th� nam�  o� th� hel� fil� shoul� b� �
indicativ� o� it�  subject��  lik�  CPM.HL� shoul� contai� �
hel� informatio� o� ZCPR3.


              The HELP File Search Hierarchy

    Wheneve�  HEL� look� fo� � specifie� HEL� Fil� (eithe� �
fro� th�  HEL� Comman�  o�  fro�  a�  Informatio� Sectio� �
whic�  specifie�  �  Nod�  [se� later])��  HEL� wil� perfor� �
� searc� fo� th� indicate� file��   Thi� searc� goe� a� �
follows:

         1��  Unde� ZCPR3�� HEL� wil� follo� th� command-�
searc� path���  A� such�� HELР wil� searc� th� curren� �
director� (dis� an� user� first.

         2�  I� th� HL� fil� i� no� foun� unde� th� curren� �
directory� HEL� wil� searc� alon� th� ZCPR� pat� fo� it.


(Continued Next Frame)

HELP File Search Hierarchy, Continued

         3��  I� th� HL� fil� i� no� foun� alon� th� ZCPR� �
path�� the� HEL� wil� loo� i� th� director� name� "HELP� fo� �
th� indicate� file�  Thi� i� � majo� differenc� betwee� HEL� �
an� othe� ZCPR� utilities.

         4��  I� th� HL� fil� i� no� found� HEL� wil� prin� �
a� erro� message.


:M

          Moving Around within the HELP Command

    Onc� th� use� i� runnin� HELP�� h� i� give� � se� o� �
command� b�� whic� h� ca� displa� th� particula� item� o� �
informatio� h� i� intereste� in.

    Afte�  issuin� th� HEL� command�  th� use� wil� com� u� �
i� on� o� tw� mode� (dependin� o� th� typ� o� HELР fil� �
referenced)��  I� Indexe� Mode�� � Men��  o�  topic� i� �
displaye� t� th� use� an� h� ca�  selec�  th�  desire� topi�  �
b��  typin� th� characte� i� fron� o� th� topi� title��  i�  �
Non-Indexe� Mode��  n�  men�  i�  displaye�  an�  th� entir�  �
fil�  i�  viewe�  a�  on� Informatio� Section.


    A� Informatio� Sectio� i� � collectio� o� scree�  �
display� (on�  scree�  ful�  o� text�� calle�  Frames�   �
Typically�  a�  Informatio� Sectio� shoul� contai� � logica� �
groupin� o� relate� dat� o� �  particula� topic�  I� Indexe� �
Mode�� eac� Men� topi� refer� t� a� Informatio� Section�� B� �
selectin� � topic��  th� use� i� place� int� a� Informatio� �
Section��  I� Non-Indexe� Mode�� th� entir� HEL� fil� i� on� �
Informatio� Section.


                   Moving From the Menu

    A�  th� Men� o� � HEL� file��  th� use� ha� tw� basi� �
options��   Thes� option�  ar� t� selec� � Men�� topi� t� �
revie� o� t� exi� t�  ZCPR3�   I�  � Men� topi� i� selected� �
th� use� i� place� int� tha� Informatio� Section.

    ��  thir�  optio� a� th� Men� o� � HELР fil� i� �
sometime� available�� Thi�  optio�  i� t� mov� u� t� th�  �
previou�  HELР  Level��   Som� Informatio�  Section� ar� �
entir� HEL� file� i� thei� ow� right�  whic� ca� b� accesse� �
independentl�� o� th� HEL� fil� th� use� i� currentl��  in�   �
I� th� use� enter� on� o� thes� Informatio� Sections�� th� �
nam� o� th� curren� HEL�  fil� i� save� an� th� ne�� HEL� �
fil� i� loaded��   Whe� thi�  happens� th� use� i� place� a� �
th� nex� HELР Leve� (a� ascendin� number��  wher� th� �
origina� HEL� fil� i� a� HEL� Leve� 0��  � HEL� fil� calle� �
fro� thi� leve� i� a� HEL� Leve� 1�� etc.)��   Whe� th� use� �
i� a� � lowe� HEL� Leve� (use� i� NO� a� HEL� Leve� 0)��  h�  �
ha�  th� optio� t� mov� t� th� nex� highe� HEL� Level.

    Th� concep� o� movin� betwee� HEL� Level� i� derive� �
fro� th� concep� o� � Tre� dat� structur� fro� Compute� �
Science��  I� thi� concept� th� use� start�  a�  th� roo� o� �
th� tre� an� the� climb� u� an� dow� th�  tre�  t� variou� �
levels�  o� nodes�   Fro� eac� node�  th� use� ma� onl� mov� �
u� o� dow�  th� tre� -- h� can'� cros� ove� t� � nod� a� th� �
sam� leve�  withou� firs� movin� dow� th� tre� an� the� bac� �
up�   T� illustrate� conside� th� following:


    Node A      Node B                                        HELP Level
  _________   ____________                                         5
    \  Node C   /
    --------------                                                 4
          \  Node D            Node E
        ------------         ----------------                      3
              \       Node F       /        Node G
            ---------------------------   -----------              2
                        \         Node H    /        Node I
                      --------------------------    -------        1
                                  \         Node J    /
Root of Tree -->                 --------------------------         0


    I�  th� abov� example��  th� use� mus� alway� star� a� �
th� roo� o� th� tre� (Nod� J)��  Thi� i� analogou� t� HEL� �
Leve� 0� whic� i� wher� th� use� i� plac� whe� h� issue� th� �
HEL� Command�   T� ge� t� Nod� C� fo� example� th�  use� ha� �
t� clim� th� tre� fro� Nod� � t� Nod� � t� Nod� � t� Nod�  � �
t� Nod� C��   Thi� woul� b� lik� th� use� enterin� �� Node-�
Typ�  Informatio� Sections�� i� whic� differen� HELР file� �
ar� successivel� loaded.

    No� tha� th� use� i� a� Nod� C� let'� sa� tha� h� want� �
t� g� t� Nod� E��  Unde� th� HEL� System� ther� ar� tw� way� �
t� d� this:
         1��   Jum�  of�  o�  th� tre� an� the� clim� bac� �
u� t�  Nod�  E�� Here��  th� use� woul� jum� fro� Nod� à t� �
Nod� � an� the� g� t� Nod� �  t� Nod� � t� Nod� E��  Unde� �
HELP�� th� use� ca� d� thi� b� exitin� t� ZCPR3� an� the�  �
reissuin� th� HEL� Comman� o� b� issuin� th� Roo� Comman� �
(.)��  onc� a�  th�  roo�  o�  th� tree�  h� the� climb�  i�  �
agai�  b�  enterin�  th� appropriat� Informatio� Sections.

         2��   Clim� dow� th� tre� an� the� bac� up��   Th� �
use� woul� mov� fro� Nod� � t� Nod� � t� Nod� Ơ an� the� �
bac� u� t� Nod� E��  Th� HEL� use� ca� g� t� th� previou� �
leve� b� issuin� th� U� Leve� (^� command�  I� thi� example� �
h� woul� U� Leve� twic� an� the� g� bac� down.


           Moving Within An Information Section

    Onc� th� use� i� withi� � textua� Informatio� Section� �
h� ha� severa� capabilitie� fo� movin� withi� thi� sectio� �
an� ou� o� thi� section.

    First�  t� mov� ou� o� a� Informatio� Section� th� use� �
ca� retur� t� th�  men� (i� th� curren� HELР fil� i� �
Indexed� o� retur� t� ZCPR3�   Additionally�  i� th� use� i� �
no� o� th� roo� (HEL� Leve� 0)�� h� ca� retur� t� th� �
previou� HEL� Leve� (U� Level)��  I� th� use� i� no� i� a� �
Indexe� HELР file��  movin� forwar� beyon� th� En� o� �
Informatio� (EOI�� wil� retur�  hi� t�  ZCPR� i� h� i� a� �
HELР Leve� � o� retur� hi� t� th� previou� HELР Leve� i� �
not.


    T� mov� withi� a� Informatio� Section�� th� dat� i� �
arrange� sequentially��   Consequently�� th� use� ca� mov� �
Forwar� t� th� nex� Frame�� Backwar�  t� th� previou� Frame�  �
o� t� th� beginnin� o�  th�  Informatio� Section��  Th� use� �
canno� mov� backwar� beyon� th� beginnin� o� th� Informatio� �
Section�� an� � bel� i� sounded��   Also�  i� th� use� trie� �
t� mov� forwar� beyon� th� En� o� Informatio� (EOI)��  h� i� �
eithe� returne� t� th� Menu�� returne� t� ZCPR3� o� returne� �
t� th� previou� HEL� Leve� a� describe� above.

:P
                   HELP Command Prompts

    Th堠  followin�  ar�  th� basi� prompt� fo� use�  �
comman�  whic�  HEL� display� t� th� user.

^C=ZCPR3  ^=Level  .=Root  M=Menu  S=Start  L=Last  P=Print -
   \        \       \        \       \       \       \__Print Info/Frame
    \        \       \        \       \       \__Goto Last (Previous) Frame
     \        \       \        \       \__Goto Start of Info Section
      \        \       \        \__Goto Menu of HELP File
       \        \       \__Goto Root if NOT at Level 0
        \        \           (this is displayed only if NOT at Level 0)
         \        \__Goto Previous Level
          \            (this is displayed only if NOT at Level 0)
           \__Return to ZCPR3

 EO�   ^C=ZCPR3  ^=Leve�  .=Roo�  M=Men�  S=Star�  L=Las�  P=Prin� -
  \        \________\_______\________\_______\_______\_______\__Same as
   \                                                            Above
    \__User is at the End of Information (end of Information Section)

Type  ^C=ZCPR3 ^=Level .=Root or Enter Selection -
         \        \       \            \__Enter letter of desired
          \        \       \                Information Section
           \        \       \__Goto Root
            \        \           (this is displayed only if NOT at Level 0)
             \        \__Goto Previous Level
              \            (this is displayed only if NOT at Level 0)
               \__Return to ZCPR3

    Preceedin�  eac�  o�  th� abov� prompt� i� a� indicato� �
o�  th�  HEL� Leve� an� Fram� Numbe� th� use� i� currentl� �
at�   Thi� indicato� ma� tak� th� followin� forms:

<Nothing>
    \__The user is at the Menu of Level 0

fff:
\__Current Frame Number within Information Section
     (the user is at Level 0)

Level lll/
      \__Current Level Number (The user is at a Menu Frame)
           (this is displayed only if the user is NOT at Level 0)

Level lll/fff:
      \   \__Current Frame Number within Information Section
       \__Current Level Number
            (this is displayed only if the user is NOT at Level 0)


                   Summary of User Commands

    Cmd  Meaning
     ^   Go to Previous Level
     .   Go to Root Level
     M   Go to Menu of Current HELP File
     S   Go to Start of Information Section
     L   Go to Previous Frame
    CR   (Carriage Return or Space) Go to Next Frame
    ^C   (Control-C) Return to ZCPR3
     P   Print Current Screen Display (Frame) or Information Section

:O
                   Printing HELP Files

    Printin� HEL� File� ca� b� don� i� tw� basi� way� -- b� �
usin� th�
HELPP� Utilit� o� ZCPR� o� b�� usin� th� Prin� �
functio� containe� withi� th� HEL� Utilit� itself.

    Th� HELPPҠ Utilit�� i� use� t� prin� a� entir� Hel� �
File��  I� act� � lo� lik� th� PRIN� command�� an� i� ha� � �
variet�� o� options�� includin� th� abilit�� t� pla� fo� �
printe� outpu� an� t� suppor� pagin� an� othe� "appearance-�
enhancing� features.

    Th� Prin� Functio� withi� HELР i� use� fo� quic� �
printouts�  I� doe� no� pag� o� perfor� anythin� mor� exoti� �
tha� simpl�� printin� ou� wha� i� containe� i� � par� o� � �
Hel� File��  Whe� th� � optio� i� given�� th� curren� scree� �
i� printe� immedately�  Th� use� ma� als� issu� � ^� comman� �
(no� displaye� o� an� menu)�� i� whic� cas� th� entir� �
informatio� sectio� h� i� currentl� i� i� printed.


    Thi� Prin� Functio� i� provide� a� � convenienc� t� th� �
user�  I� allow� th� use� t� revie� th� Hel� File� and� whe� �
h� see� � particula� scree� displa� o� informatio� sectio� �
whic� h� value� enoug� t� wan� t� hav� aroun� fo� futur� �
referenc� i� hardcop� form� h� ca� simpl� tel� HEL� t� prin� �
it��  Thi� capabilit� i� intende� t� suppor� th� concep� o� �
establishin� HL� file� a� � convenien� an� flexibl� wa�� t� �
pas� documentatio� o� program� t� th� use� o� dis� whil� �
simultaneousl�� allowin� hi� t� easil� prin� i� ou� i� i� i� �
o� significan� interes� t� him.


    Fo� instance�� � HL� fil� whic� refer� t� � ne� progra� �
ma�� contai� a� Informatio� Sectio� o� on� Fram� whic� �
contain� � comman� summary��  Th� use� ca� simpl� prin� thi� �
withou� havin� th� prin� th� entir� HL� file.

    A� anothe� example� th� HEL� subsyste� ma� b� use� b� � �
homemake� t� kee� he� recipe� on��  Organize� usin� th� tre� �
structur堠 int� reasonabl� catagorie� (suc� a� roasts� �
desserts� etc)� whil� reviewin� th� recipe� sh� ma� fin� on� �
sh� wishe� t� tr� fo� th� evening'� mea� o� t� pas� o� t� � �
friend�  I� th� recip� cover� onl� on� screen� � Fram� Prin� �
i� ver� convenient.

:E
                   HELP Error Messages

    Th�  followin�  ar�  th�  erro� message� issue�  b�  �
HEL�  an�  thei� meanings:

File not Found
    The specified HELP File cannot be found.

AFN Not Allowed
    Th� specifie� HEL� Fil� i� ambiguou� (contain� th� �
characte� "*� o� "?")�  Thi� i� no� allowed.

<BELL>
    The user issued an invalid command.

EOF on HELP File
    I� searchin� fo� a� Informatio� Section�� HEL� ra� int� �
th� en� o� th� HEL�  File��   Th�  Indexe� HELР Fil� i� �
improperl� structure� (mor�  inde� entrie� tha� Informatio� �
Sections).

Node Level Limit
    Th� limi� o� th� nestin� o� th� HELР Level� i� �
exceeded�  HEL� limit� th� numbe� o� HEL� Level� tha� ca� b� �
traverse� t� 1� (default��  whic� ca� b� changed)��  an� a� �
attemp� wa� mad� t� ente� HEL� Leve� 1� (o� defaul� � 1).

Mem Full
    Th� selecte� HEL� Fil� i� to� larg� t� loa� int� th� �
availabl� memor� i�  th� user'� compute� system��   Th� HEL� �
Fil� shoul� b� reduce� i� size�� usin� HELРLevel� (Nod� �
references� i� th� Informatio� Section� i� �  goo� wa� t� d� �
this.

:H
                 How to Write HELP Files

    File�  use� b� th� HEL� progra� ar� eithe� simpl� CP/M-�
standar䠠  file� o�   ASCIɠ   tex�  o�  ASCIɠ�  file�  �
generate�  b��  th�  Wor�   Sta�   tex� editor/formatter�  �
Thes� files�� a� mentione� above�� ar� o� tw� basi� types� �
indexe�  an� non-indexed��  an� eac� typ� i� relate� t� th� �
othe� an� i�  o� th� sam� basi� format.

                    Grouping of Information

    Informatio� displaye� t� th� use� i� groupe� b�� th� �
inde�� i�  indexe� HEL�  file� an� ma� als� b� groupe� b� �
line� beginnin� wit� For� Fee� (^L�� characters��   Groupin� �
i� a� effectiv� wa� t� logicall� organiz�  informatio�  s� �
tha� meanin� wil� b� mor� clea� t� th� use� an� unit� o� �
informatio� wil� no� pas� betwee� scree� displays.


    Th� informatio� displaye� t� th� use� i� organize� int� �
logica젠 unit� calle� Informatio� Section� an䠠 scree� �
display� (on� scree� ful� o�  text� calle� Frames��  Usin� �
tex� editors�� th� use� ca� creat� hi� ow� HEL� file� an� �
organiz� hi� informatio� a� h� desire� fo� displa�� t� th� �
HEL� user.


                    Non-Indexed HELP Files

    Non-indexe� HELР file� ar� simpl� ASCIɠ file� whic� �
star� wit� � colo� (:� a� th� firs� characte� o� th� fil� �
an� consis� o� ASCI� tex� (wit� eac� lin� terminate� b�� � �
carriag� retur� an� lin� fee� characte� combination)��  Th� �
informatio�  i�  suc�  � hel� fil� consist� o� al� tex� �
afte�  th�  leadin� colo�  u� t� eithe� th� terminatin� end-�
of-fil� mar� (control-Z� o�  �  ne� lin� whic� start� wit� � �
colon.


                      Indexed HELP Files

    Indexe�  HELР  file� ar� simpl� ASCI� file� whic� d� �
no� star� wit�  � colo�  (:�  a� th� firs� characte� o� th� �
file��  A� indexe� HEL� fil� ma� b� HELP-indexe� o� user-�
indexed.

    Th� HELP-indexe� HEL�  fil� consist�  o� on� o� mor� �
norma� ASCIɠ tex� line� a� th� firs� line� o�  th� fil�  �
followe� b�� informatio� section� whic� begi� wit� � lin� �
whos�  firs� characte�  i�  �  colo�  an� en� wit� eithe� �
th� firs�  lin�  o�  th�  nex� informatio� sectio� o� th� �
en� o� th� file��  Thes� openin� line� (befor� th� firs� �
informatio� section� for� th� inde� entries�� an� HELРwil� �
labe� thes� line� wit� A�� B� etc� durin� th� displa� o� th� �
index.


    Th� user-indexe� HEL� fil� contain� � semicolo� (;� a� �
th� firs� characte� i� th� file��  Th� tex� whic� follows� �
startin� o� th� nex� line�� i� displaye� literall�� t� th� �
use� a� th� menu��  Eac� informatio� sectio� i� denote� b� � �
lin� startin� wit� � colo� (:)�� th� colo� i� followe� b� � �
serie� o� character� (space� ar� no� significan� betwee� �
them� whic� ar� th� inde� letters��  Whe� th� use� run� HEL� �
o� thi� fil� an� type� � selectio� letter�� HELРsearche� �
throug� th� file�� lookin� fo� a� informatio� sectio� whos� �
lin� contain� th� characte� type� b�� th� user��  I� th� �
characte� wa� � letter�� i� i� automaticall� capitalize� b� �
HELР (i� bot� th� use� inpu� an� th� informatio� sectio� �
lines).

    �� colo� (:� i� no� � vali� optio� letter�� sinc� thi� �
characte� ha� � specia� meanin� t� HEL� (se� later)��  I� � �
colo� i� encountere� i� a� informatio� sectio� headin� line� �
the scan for option characters stops for that line.


           Tree Structures within Indexed HELP Files

    Th� Indexe� HELР Fil� i� divide� int� Informatio� �
Sections��  wher� eac� Informatio� Sectio� start� wit� � �
colo� (:)��   Ther� ar� tw� basi� type� o� Informatio� �
Section:

         1���   Informatio Section� containin� textua� �
material�� thi� typ� o� Informatio� Sectio� simpl�� contain� �
readin� materia� whic� i� organize� int� Frames�� wher� � �
Fram� i� equa� t� on� scree� display.

         2��   Informatio� Section� whic� referenc� othe� �
HEL� files.


    I� HELP-indexe� HEL� files�� thi� typ� o� Informatio� �
Sectio� begin� wit� tw� colon� (::� instea� o� on�  a� i�  �
(1� above��  th� tw� colon� ar� immediatel� followe� b�� th� �
nam� o� th� HEL� fil� (th� HEL� fil� typ� ma� b� optionall� �
specified).

    I� user-indexe� HEL� files�� thi� typ� o� Informatio� �
Sectio� contain� th� inde� character� followe� � colo� (:� �
an� th� nam� o� th� HEL� fil� (th� fil� typ� i� optional).

    T� illustrate��  th� followin� outline� th� structur� o� th� �
tw� type� o� Informatio� Sections:


              HELP-Indexed HELP File Example

:Title for Type 1 Information Section
    <text>
: [next Information Section]

              Figure:  A Text (Type 1) Information Section


::HLPFILE                    <-- for HLPFILE.HLP
: [next Information Section]

::HLPFILE.TYP                <-- for HLPFILE.TYP
: [next Information Section]

        Figure:  Examples of Node (Type 2) Information Sections



              User-Indexed HELP File Example

;

    [ Menu ]

:x
    [ Information Displayed for Selection X ]
:a
    [ Information Displayed for Selection A ]
:1 b
    [ Information Displayed for Selections 1 or B ]
:f :HELPFILE   [ HELPFILE.HLP is invoked by Selection F ]
: z
    [ Information Displayed for Selection Z ]

:V

                Accessing Video Attributes

    Th� display� generate� b� HELР ar� screen-oriented�  �
Unde� ZCPR�� wit� � properly-installe� TCA� entr�� i� th� �
Environmen� Descriptor��� HELР� i� abl堠 t highligh� �
informatio� o� th� scree� an� creat� "flashy�� display� b� �
using the clear screen feature of the user's terminal.

    Us� o� th� clea� scree� featur� i� automatic��  Eac� �
frame is preceeded by a clear screen.

    Th� write� o� � HELР fil� ca� tur� o� an� of� �
highlightin� o� tex� anywher� i� th� HEL� fil� b�� embedde� �
the following commands into the text:

         ^A (binary 1) - turn on highlighting
         ^B (binary 2) - turn off highlighting


    I� i� recommende� tha� i� highlightin� i� turne� o� �
then it should be turned off in the same line.  Example:

         ^Athis is highlighted^B while this is not

generates:

         this is highlighted while this is not


    Thi� HEL� fil� i� a� exampl� o� on� whic� extensivel� �
uses highlighting.  This is also a user-indexed HELP file.


:T
                The Tree Structure of HELP

                  -- Basic HELP File --
 |Info Sect 1  |Info Sect 2    |Info Sect 3    |Info Sect 4 |
 | Text        | HELP File     | Text          | HELP File  |
                  /      \                        /    \
           -- SubHelp File 1 --           -- SubHelp File 2 --
       |Info Sect 1 |Info Sect 2 |     |Info Sect 1 |Info Sect2|
       | Text       | HELP File  |     | Text       | Text     |
                       /    \
               -- SubSubHelp File 1 --
       |Info Sect 1 |Info Sect 2 |Info Sect 3 |
       | Text       | HELP File  | HELP File  |
                       /  \         /    \
       -- Sub3Help File 1 --  -- Sub3Help File 2 --
       |Info Sect |            |Info Sect 1 |Info Sect 2|
       | Text     |            | Text       | HELP File |
                                               /    \
                                       -- Sub4Help File --
                               |Info Sect 1 |Info Sect 2|
                               | Text       | Text      |

    Th�  abov� diagra� i� mean� t� illustrat� ho�� tre� �
structure� ca�  b� implemente� unde� HELP��  � ne�  nod� o� �
th� tre� i� create� wheneve� � HEL� fil� i� reference� b�  �
a� Informatio�  Sectio� (a� oppose� t� simpl� havin� tex� i� �
th�  Informatio� Section)�   Eac�  nod�  become� th� bas� o� �
� ne� tree��  whic� itsel�  ma� contai� reference� t� othe� �
HEL� files.

    Fro�  th� previou� diagram��  SubHel� Leve�  � contain� �
tw� HELР files��   Thes� ca� b� entere� fro�  Informatio� �
Sectio� � an� Informatio� Sectio� � o� SubHel� Leve� 2�   B� �
simpl� enterin�  on� o� thes� tw� Informatio� Sections�  th� �
appropriat� HEL� fil�  i� loade� an� th� use� i� place� a� �
th� nex� level�   Fro� thes� HEL�  files� th�  use� ma� mov� �
withi� th� HEL� fil� itsel� o� mov� u� t� th�  previou� �
leve� (naturally�� th� use� alway� ha� th� optio� t� exi� t� �
ZCPR3).

:S

   Sample HELP Files Illustrating Use of Tree Structure

    Th�  followin�  Frame�  sho� th� sourc� t� thre�  HEL�  �
Files��  name� DEMO.HLP� DEMO2.HLP� an� DEMO3.HLP�  DEMO.HL� �
i� provide� th� Roo� Nod� t� � tre� whic� include� DEMO2.HL� �
an� DEMO3.HL� a� subnodes��   Additionally�� DEMO3.HL� ha� � �
subnod� whic� reference� DEMO.HLP��  s� w� hav� � recursiv� �
tre� structure.


                                DEMO.HLP
TEST 1 - OK                  <-- Menu
TEST 2 - SIMPLE NEST
TEST 3 - INVOLVED NEST
TEST 4 - OK
:TEST 1                      <-- First Info Section (Text)
THIS
IS
TEST
1
::DEMO2                      <-- 2nd Info Section (Node)
::DEMO3                      <-- 3rd Info Section (Node)
:TEST 4                      <-- 4th Info Section (Text)
TO BE, OR NOT TO BE, THAT IS THE QUESTION!
...
TO TAKE ARMS AGAINST A SEA OF TROUBLES AND BY OPPOSING END THEM.
TO DIE, TO SLEEP ... TO SLEEP, PERCHANCE TO DREAM.
AYE, THERE'S THE RUB!  FOR IN THAT SLEEP, WHAT DREAMS MAY COME!

                               DEMO2.HLP
:TEST 2                       <-- No Menu -- 1 Info Section
THIS
IS
TEST
2

                               DEMO3.HLP
TEST 3A                       <-- Menu
TEST 3B
TEST 3C
:TEST 3A                      <-- First Info Section (Text)
       THIS
       IS
       TEST
       3A
       the rain in Spain falls mainly in the plain

:TEST 3B                      <-- 2nd Info Section (Text)
       THIS
       IS
       TEST
       3B
::demo                        <-- 3rd Info Section (Node)