; 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ä .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: \__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. 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 : [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)