ftp.barnyard.co.uk

home *** CD-ROM | disk | FTP | other *** search

/ ftp.barnyard.co.uk / 2015.02.ftp.barnyard.co.uk.tar / ftp.barnyard.co.uk / cpm / walnut-creek-CDROM / ZSYS / SIMTEL20 / ZCPR3 / HELPSYS.HLP < prev next >

Wrap

Text File | 2000-06-30 | 29KB | 793 lines

; 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)