ftp.barnyard.co.uk/2015.02.ftp.barnyard.co.uk.tar/ftp.barnyard.co.uk/cpm/walnut-creek-CDROM/CPM/ZCPR2/HELP2.HLP

Text File | 2000-06-30 | 24KB | 549 lines

Welcome to the HELP Command
How to Use the HELP Command
Moving Around within the HELP Command
HELP Command Prompts
Printing HELP Files
HELP Error Messages
How to Write HELP Files
An Explanation of the Tree Structure of the HELP Command
Sample HELP Files Illustrating Use of Tree Structure
:HELP: Welcome to the HELP Command

     Welcomσ  t∩ thσ HEL╨ Commandí   Thσ HEL╨ CommanΣ i≤ designeΣ ì
t∩ assis⌠ you¼á  thσ  CP/═  user¼  iε  thσ usσ oµ CP/═ iε genera∞  ì
anΣ  specifiπ  CP/═ 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∩ CP/M.

     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∩ CP/M.


     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≤ ì
special features.


                                             Richard Conn
:HELP: 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∞ receivσ ß lis⌠á oµ ì
thσ availablσ HEL╨ File≤ anΣ m∙ elec⌠ t∩ reaΣ thσ basiπá HELP.HL╨ ì
file«  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ε CP/M.


                 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≥á ZCPR2¼á HEL╨á caε bσ se⌠ u≡ t∩á follo≈á thσ ì
externa∞ path«á  A≤ such¼á HEL╨ wil∞ searcΦ thσ curren⌠ director∙ ì
(disδá anΣá user⌐á first«á  Iµ i⌠ i≤ no⌠ se⌠á u≡á t∩á searcΦá thσ ì
external path, it will search along its internal path.

          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∞ searcΦ alonτ it≤ interna∞ patΦ fo≥ thσ file«  Thi≤ ì
i≤ ß majo≥ differencσ betweeε HEL╨ anΣ othe≥ ZCPR▓ utilities«  T∩ ì
configurσá HEL╨á witΦ GENINS¼á yo⌡ shoulΣ firs⌠ tel∞ GENIN╙á tha⌠ ì
HEL╨ doe≤ no⌠ usσ externa∞ paths¼á definσ thσ interna∞ path¼á anΣ ì
theε tel∞ GENIN╙ tha⌠ HEL╨ use≤ externa∞ path≤ anΣ wherσ thσ patΦ ì
begins.

          4«á  Iµá thσ HL╨ filσ i≤ no⌠ found¼á HEL╨á wil∞á eithe≥ ì
displa∙á thσ name≤ oµ thσ HL╨ file≤ alonτ thσ patΦ anΣ prin⌠á it≤ ì
interna∞ documentatioε o≥ finΣ thσ filσ HELP.HL╨ anΣ prin⌠ that.


:HELP: 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σá lette≥á 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∩  CP/M«á   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¼ ß HEL╨ filσ calleΣ froφ thi≤ leve∞ ì
i≤á a⌠ HEL╨ Leve∞ 2¼á 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╨ Leve∞ (froφ  HEL╨ Leve∞ ▒ t∩ HEL╨á Leve∞ ì
0¼ fo≥ example).

     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∩ CP/═ 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∩ CP/M«á   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∩  ì
CP/═ 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≤ typicall∙ ì
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«á  Naturally¼á thσá use≥ ì
canno⌠á movσá backwarΣá beyonΣ thσ beginninτ oµá thσá Informatioε ì
Section«á   Also¼á  iµ thσ use≥ trie≤ t∩ movσ forwarΣ beyonΣá thσ ì
EnΣá oµá Informatioε (EOI)¼á  hσ i≤ eithe≥ returneΣ t∩ thσá Menu¼ ì
returneΣá t∩á CP/M¼á o≥ returneΣ t∩ thσ previou≤á HEL╨á Leve∞á a≤ ì
describeΣ above.

:HELP: HELP Command Prompts
     Thσá  followinτá  arσ  thσ basiπ prompt≤ fo≥á use≥á  commanΣ  ì
whicΦ  HEL╨ display≤ t∩ thσ use≥ anΣ thei≥ meanings.

^C=CP/M  ^=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 CP/M

  EO╔   ^C=CP/═  ^=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=CP/M ^=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 CP/M

     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 CP/M
      P   Print Current Screen Display (Frame) or Information Section

:HELP: Printing HELP Files
     Printinτá HEL╨á File≤á caε bσ donσ iε tw∩ basiπá way≤á -- b∙ ì
usinτá thσ PHEL╨ Utilit∙ oµ ZCPR▓ o≥ b∙ usinτ thσ Prin⌠á functioε ì
contained within the HELP Utility itself.

     Thσ PHEL╨ Utilit∙ i≤ useΣ t∩ prin⌠ aε entirσ Hel≡ File«á  I⌠ ì
act≤á ßá lo⌠ likσ thσ PRINT3¼á anΣ i⌠ ha≤ ß variet∙á oµá options¼ ì
includinτá thσ abilit∙ t∩ plaε fo≥ printe≥ outpu⌠ anΣ t∩á suppor⌠ ì
paging and other "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σ use≥ i≤ askeΣ t∩ se⌠ thσ to≡ oµá forφ ì
(givinτ hiφ timσ t∩ turε oε hi≤ printer⌐ anΣ theε specif∙ whethe≥ ì
hσá want≤á t∩á prin⌠ thσ curren⌠ Framσ (Screeεá Display⌐á o≥á thσ ì
entirσá informatioεá sectioεá whicΦ hσ i≤á currentl∙á in«á  Afte≥ ì
selectinτá onσ oµ thesσ tw∩ option≤ (thσ optioε t∩ abor⌠ i≤á als∩ ì
given)¼á thσá printou⌠á occur≤á (ma∙ bσ aborteΣ a⌠á an∙á timσá b∙ ì
strikinτ ß ^C)«á  Wheε finished¼ thσ use≥ i≤ returneΣ t∩ thσ las⌠ ì
frame he was viewing.

     Thi≤ ne≈ Prin⌠ Functioε (availablσ iε Version≤ 4.▒ anΣ late≥ ì
oµá HELP2⌐ i≤ provideΣ a≤ ß fundamenta∞ 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∞ HELP▓ 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∙ ì
print it out if it is of significant interest to 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τ ì
the print the entire HLP file.

     A≤á anothe≥á example¼á thσ HELP▓ 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.



:HELP: HELP Error Messages
     Thσá  followinτá  arσ  thσ  erro≥ message≤ issueΣ  b∙á  HEL╨  ì
anΣ  thei≥ meanings:

HELP FATAL ERROR -- File not Found
     The specified HELP File cannot be found.

HELP FATAL ERROR -- File Name Contains Wild Car
     Thσá specifieΣ HEL╨ Filσ contain≤ thσ characte≥ "*ó o≥á "?"«  ì
Thi≤ i≤ no⌠ alloweΣ sincσ i⌠ specifie≤ aε ambiguou≤ name.

HELP ERROR -- Invalid Response
     The user issued an invalid command.

HELP ERROR -- 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).


HELP ERROR -- Not Possible to Backup Before Start of Info
     Aεá  ╠á CommanΣá wa≤ issueΣ wheε thσ curren⌠ Framσá wa≤á thσ ì
beginninτ  oµ thσ curren⌠ Informatioε Section.

HELP ERROR -- Node Level Limit Reached -- Aborting
     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).

HELP ERROR -- Invalid File Name in Load
     Aε  Informatioε  Sectioε whicΦ i≤ tryinτ t∩ loaΣ ß nodσá (g∩  ì
t∩  nex⌠ HEL╨ Level⌐ contain≤ aε invaliΣ filσ name.

HELP ERROR -- No Higher Level to Return to
     Aεá attemp⌠ wa≤ madσ t∩ g∩ t∩ ß HEL╨ Leve∞ previou≤ t∩á HEL╨ ì
Leve∞ ░ (▐ CommanΣ issueΣ froφ HEL╨ Leve∞ 0).


HELP ERROR -- Not Enough Room for HELP File
     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.

:HELP: 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«   ì
Thi≤á typσ  oµ  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.

            Tree Structures within Indexed HELP Files

     A≤á mentioneΣ above¼á 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╗á 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).

     T∩ illustrate¼á  thσ followinτ outline≤ thσ structurσ oµ thσ ì
tw∩ type≤ oµ Informatioε Sections:

 :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


:HELP: 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     |

                   Figure:  Sample HELP File Structure

     Thσáá  abovσá diagraφá i≤á mean⌠á t∩á illustratσá ho≈áá treσ ì
structure≤á caε  bσ implementeΣ unde≥ Version≤ 1.┤ anΣ beyonΣá oµ ì
HELP«á  A≤á thσ use≥ caε see¼á ß 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≤ diagraφ (fee∞ freσ t∩ refe≥ bacδ t∩  it)¼  ì
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∩ ì
CP/M).

:HELP: 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)