home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 September / Simtel20_Sept92.cdr / msdos / sysutl / stack.arc / MANUAL.PLN < prev    next >
Text File  |  1988-03-27  |  9KB  |  185 lines
  1.                         DOCUMENTATION DISPLAY SYSTEM
  2.  
  3.  
  4. Introduction - Get it Right
  5.  
  6.  
  7.          First of all if you're not reading this as a result of entering
  8.  
  9.                           MANUAL MANUAL
  10.  
  11. theε you'rσ missinτ thσ poin⌠ oµ thσ prograφ anΣ ╔ sugges⌠ tha⌠ yo⌡ exi⌠ anΣ ì
  12. restar⌠ b∙ enterinτ thσ abovσ command.
  13.  
  14.  
  15.          Havinτ go⌠ thσ preliminarie≤ ou⌠ oµ thσ roaΣ ¡ thσ purposσ oµ  thi≤ ì
  16. prograφ  i≤  t∩ providσ yo⌡ witΦ aε eas∙ mean≤ oµ givinτ thσ user≤  oµ  you≥ ì
  17. softwarσ áoε linσ documentation«  Mos⌠ oµ yo⌡ wil∞ havσ seeε  thσ á oε álinσ  ì
  18. documentatioε á provideΣ á witΦ somσ commercia∞ packages« á Typicall∙ áthesσ ì
  19. package≤ ádispla∙  ß tablσ oµ content≤  oε thσ  screen¼  le⌠ yo⌡ ácurso≥ át∩ ì
  20. thσ topiπ oµ  interes⌠ theε pres≤  returε  t∩ displa∙ details«  Thi≤ prograφ ì
  21. provide≤ yo⌡ witΦ aε eas∙ mean≤ oµ doinτ thi≤«
  22.  
  23.  
  24. Using Manual
  25.  
  26.          Syntax.  MANUAL  <filename>  [<lines per page>]
  27.  
  28. Where <filename> is the name of the documentation file to be processed.  An
  29.                  extension of '.DOC' is assumes and should not be entered.
  30.       <lines per page> is the length of the printer paper (66 = 11", 72 =
  31.                  12").  Default is 66.
  32.  
  33.          Ho≈ t∩ Use.é   MANUA╠  expect≤ ß fairl∙ plaiε inpu⌠ filσ endinτ witΦ ì
  34. ß á".DOCó extension« Thσ filσ shoulΣ includσ onl∙ norma∞ áASCI╔ ácharacters¼ ì
  35. eacΦ linσ shoulΣ finisΦ witΦ ß  carriagσ  returε-linσ feeΣ anΣ shoulΣ bσ án∩ ì
  36. longe≥ áthaε á7╕ characters«  Beinτ ß diσ harΣ WordSta≥ use≥ áI'vσ áse⌠ áthσ ì
  37. prograφ áu≡ t∩ handlσ WordSta≥ documen⌠ file≤ (i⌠ automaticall∙ áreset≤ áthσ ì
  38. to≡ bit⌐ anΣ i⌠ wil∞ recognisσ somσ Wordsta≥ command≤  bu⌠ i⌠ i≤ árelativel∙ ì
  39. simplσ t∩ modif∙ thσ prograφ t∩ accep⌠ outpu⌠ froφ you≥ worΣ processo≥ á(seσ ì
  40. below)«   
  41.  
  42.          Wheε á i⌠ ástart≤ á MANUA╠ álook≤ áfo≥ áaε áinde° áfilσ á¿ áá'.IDXº ì
  43. extension)«  Iµ  i⌠  can'⌠ finΣ onσ i⌠ read≤ thσ nominateΣ documen⌠ filσ anΣì
  44. create≤ áthσ inde° filσ (".IDX"⌐ anΣ ß modifieΣ documen⌠ filσ (".DOK")« á Iµ ì
  45. yo⌡ áchangσ thσ documentatioε filσ (tha⌠ i≤ yo⌡ edi⌠ thσ .DO├ áfile⌐ ásimpl∙ ì
  46. deletσ á thσ áinde° filσ anΣ MANUA╠ wil∞ creatσ ne≈ .ID╪ anΣ á.DO╦ áfilσ át∩ ì
  47. matcΦ thσ  modifieΣ documentation«  
  48.  
  49.          MANUA╠ átheε display≤ thσ  firs⌠ pagσ oµ thσ inde° anΣ wait≤ fo≥ áß ì
  50. commanΣ froφ thσ use≥ (thesσ command≤ arσ displayeΣ oε ß promp⌠ linσ a⌠ áthσ ì
  51. bottoφ oµ thσ screen)«  Thσ command≤ recogniseΣ are:
  52.  
  53. U╨ ª DOW╬ arrow≤ ¡ movσ thσ highligh⌠ ba≥ u≡ anΣ dowε onσ line.
  54.  
  55. PgU≡ ª PgDε ¡ displa∙ thσ nex⌠ o≥ previou≤ pagσ oµ thσ index.
  56.  
  57. HOM┼ ¡ ááwil∞ ácausσ thσ WHOL┼ oµ thσ manua∞ t∩ bσ printed«  MANUA╠ áexpect≤ ì
  58. ááááááááát∩ bσ ablσ t∩ prin⌠ 9╢ character≤ acros≤ ß pagσ (ie« 1▓ cpΘ oε aε ╕ ì
  59. áááááááááiε page).
  60.  
  61. EN─ ¡ áááwil∞ exi⌠ froφ thσ program.è
  62. ENTE╥ ¡ áwil∞ ádispla∙ ß screeε oµ tex⌠ froφ thσ documentatioε ástartinτ áa⌠ ì
  63. áááááááááthσ highlighteΣ line.
  64.  
  65.          Wheε áß áscreeε áoµ átex⌠ i≤ beinτ ádisplayeΣ áthσ ásamσ ákey≤ áarσ ì
  66. recogniseΣ excep⌠ fo≥ thσ arro≈ keys«  Howeve≥ thσ HOM┼ ke∙ wil∞ onl∙ áprin⌠ ì
  67. onσ ápagσ oµ documentation¼ startinτ witΦ thσ curren⌠ screen¼ anΣ áEN─ áwil∞ ì
  68. returε thσ use≥ t∩ tablσ oµ contents/index.
  69.  
  70.          Ho≈ áMANUA╠ Build≤ thσ Index.é  T∩ creatσ it≤ inde° á MANUA╠ á scan≤  ì
  71. thσ ádocumentatioε  filσ lookinτ fo≥ tex⌠ surroundeΣ b∙ Wordsta≥ prin⌠ ábolΣ  ì
  72. (^B⌐ ácommands« á  Thσ áencloseΣ átex⌠ i≤ assumeΣ t∩ bσ áß áheadinτ áanΣ ái≤ ì
  73. includeΣ  iε thσ inde° accordinτ t∩ thσ followinτ rules:
  74.  
  75. -        Iµ  thσ  tex⌠ i≤ centereΣ iε thσ pagσ (witΦ morσ thaε  ß  nominateΣ ì
  76. ááááááááánumbe≥ á oµ  leadinτ  blank≤ ¡ seσ below⌐ theε thσ tex⌠ i≤ átreateΣ  ì
  77. áááááááááa≤ á ß  majo≥ headinτ   anΣ   i≤  lef⌠  justifieΣ  iε  thσ á index«    ì
  78. áááááááááThσ   titlσ "DOCUMENTATIO╬ DISPLA┘ SYSTEMó i≤ ß majo≥ heading.
  79.  
  80. -        Iµ thσ tex⌠ start≤ iε thσ lef⌠ margiε theε i⌠ i≤ treateΣ a≤ ß grou≡ ì
  81. áááááááááheadinτ  anΣ i≤ placeΣ iε thσ inde° indenteΣ froφ  majo≥  headings« ì
  82. ááááááááá"Usinτ Manualó i≤ ß grou≡ heading.
  83.  
  84. -        Iµ  thσ  tex⌠  i≤ indenteΣ froφ thσ lef⌠ margiε  bu⌠  les≤  thaε  ßì
  85. ááááááááánominateΣ  numbe≥  oµ  leadinτ  blank≤ theε  i⌠  i≤  treateΣ  a≤  ß ì
  86. áááááááááparagrapΦ  headinτ anΣ i≤ placeΣ iε thσ inde° indenteΣ  froφ  grou≡ ì
  87. áááááááááheadings«  "Ho≈ T∩ Useó i≤ ß paragrapΦ heading.
  88.  
  89.  
  90.          Othe≥ Wordsta≥ Command≤ Recognised«  Iε additioε t∩ thσ ^┬  commanΣ ì
  91. MANUA╠  recognise≤  tw∩ othe≥ Wordsta≥ command≤ ^─ (prin⌠  double⌐  anΣ  .pß ì
  92. (pagσ  break⌐  whicΦ  arσ  actioneΣ iµ thσ use≥  request≤  ß  prin⌠  oµ  thσ ì
  93. documentation«  Ho≈ MANUA╠ handle≤ thesσ command≤ i≤ describeΣ below:
  94.  
  95. -        ^B«   Tex⌠  encloseΣ b∙ ^B'≤ i≤ includeΣ iε thσ  inde°  createΣ  a≤ ì
  96. ááááááááádescribeΣ abovσ anΣ doublσ strucδ iµ thσ documentatioε i≤ printed.
  97.  
  98. -        ^D«   Tex⌠ encloseΣ b∙ ^D'≤ i≤ no⌠ includeΣ iε thσ inde°  buil⌠  b∙ ì
  99. áááááááááMANUA╠ bu⌠ i≤ doublσ strucδ wheε thσ documentatioε i≤ printed.
  100.  
  101. -        .pß á (startinτ áiε thσ lef⌠ mos⌠ characte≥ positioε iε áthσ áline⌐ ì
  102. áááááááááCause≤ ß pagσ breaδ wheε thσ documentatioε i≤ printed.
  103.  
  104.  
  105. Modifying MANUAL
  106.  
  107.          MANUA╠  wa≤  writteε  iε  ß  bi⌠ oµ ß  rusΦ  s∩  thσ  codσ  i≤  no⌠ ì
  108. particularl∙ gooΣ bu⌠ i⌠ doe≤ work«  Iµ i⌠ prove≤ usefu∞ theε ╔ ma∙  rewritσ ì
  109. i⌠  anΣ ╔ woulΣ bσ interesteΣ iε an∙ suggestions«  Fo≥ thosσ oµ yo⌡ wh∩  arσ ì
  110. gamσ  I'vσ  includeΣ thσ Turb∩ Pasca∞ sourcσ code«  Beforσ yo⌡ looδ  a⌠  thσ ì
  111. codσ  anΣ  becomσ dismayeΣ therσ arσ somσ simplσ modification≤ tha⌠  caε  bσ ì
  112. madσ  t∩  tailo≥  i⌠  t∩ you≥ owε needs«   Thesσ  consis⌠  oµ  changinτ  thσ ì
  113. constant≤ a⌠ thσ star⌠ oµ thσ prograφ anΣ arσ describeΣ below:
  114.  
  115. pageline≤ ¡ Thi≤ i≤ thσ defaul⌠ numbe≥ oµ line≤ printeΣ oε ß page.
  116.  
  117. bold -   Thi≤ i≤ thσ characte≥ MANUA╠ use≤ t∩ distinguisΦ heading≤ anΣ coulΣ ì
  118. ááááááááábσ  changeΣ  t∩ anothe≥ singlσ bytσ commanΣ useΣ  b∙  anothe≥  worΣ ì
  119. áááááááááprocesso≥ (o≥ an∙ characte≥ yo⌡ choose¼ eg« /¼ "¼ ..).
  120.  
  121. double - Thσ  characte≥  useΣ t∩ enclosσ tex⌠ t∩ bσ printeΣ doublσ  bu⌠  no⌠ ìèáááááááááincludeΣ iε thσ index.
  122.  
  123. tab_posε ¡ áthσ ánominateΣ numbe≥ oµ space≤ discusseΣ above«  Iµ áß áheadinτ ì
  124. ááááááááástart≤ ámorσ thaε tab_posε space≤ froφ thσ lef⌠ margiε theε ái⌠ ái≤ ì
  125. *áááááááááconsidereΣ ß centereΣ heading¼ otherwisσ i⌠ i≤ ß paragrapΦ o≥ grou≡ì
  126. áááááááááheading.
  127.  
  128. striptop ¡ useΣ t∩ rese⌠ thσ to≡ bi⌠ iε WordSta≥ files«  Iµ yo⌡ wan⌠ t∩ áusσ ì
  129. áááááááááthσ IB═ extendeΣ characte≥ se⌠ theε yo⌡ shoulΣ se⌠ thi≤ constan⌠ t∩ ì
  130. ááááááááá255.
  131.  
  132. lightgrey¼ black¼ lightbluσ yello≈ ¡ thσ colour≤ useΣ iε thσ screeε display« ì
  133. áááááááááChangσ thσ value≤ (bu⌠ no⌠ thσ name≤ !⌐ t∩ ge⌠ differen⌠ colour≤ oε ì
  134. áááááááááthσ screen.
  135.  
  136.  
  137.  
  138. Copywrite and All That Jazz
  139.  
  140.  
  141.          N∩  copywritσ o≥ an∙ oµ tha⌠ jus⌠ freσ softwarσ bu⌠ ╔ d∩  asδ  tha⌠ ì
  142. yo⌡  givσ credi⌠ wherσ credi⌠ i≤ duσ anΣ leavσ m∙ namσ iε thσ  program«   Iµ ì
  143. yo⌡ finΣ thi≤ prograφ useful¼ havσ suggestion≤ o≥ improvement≤ t∩ thσ codσ ╔ ì
  144. woulΣ likσ t∩ know«  ╔ caε bσ contacteΣ oε (062⌐ 369216.
  145.  
  146.  
  147. Shane Bergl
  148.  
  149. September 1987
  150.  
  151.          ----------------end-of-author's-documentation---------------
  152.  
  153.                         Software Library Information:
  154.  
  155.                    This disk copy provided as a service of
  156.  
  157.                         The Public (Software) Library
  158.  
  159.          We are not the authors of this program, nor are we associated
  160.          with the author in any way other than as a distributor of the
  161.          program in accordance with the author's terms of distribution.
  162.  
  163.          Please direct shareware payments and specific questions about
  164.          this program to the author of the program, whose name appears
  165.          elsewhere in  this documentation. If you have trouble getting
  166.          in touch with the author,  we will do whatever we can to help
  167.          you with your questions. All programs have been tested and do
  168.          run.  To report problems,  please use the form that is in the
  169.          file PROBLEM.DOC on many of our disks or in other written for-
  170.          mat with screen printouts, if possible.  The P(s)L cannot de-
  171.          bug programs over the telephone.
  172.  
  173.          Disks in the P(s)L are updated monthly, so if you did not get
  174.          this disk  directly from the P(s)L,  you should be aware that
  175.          the files in this set may no  longer be the current versions.
  176.  
  177.          For a copy of the latest monthly software library newsletter
  178.          and a list of the 1,000+ disks in the library, call or write
  179.  
  180.                         The Public (Software) Library
  181.                               P.O.Box 35705 - F
  182.                            Houston, TX 77235-5705
  183.                       (713) 721-6104 or (713) 721-5205
  184.  
  185.