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 / CPM / PROGRAMS / WSTAR / OUTLN11.LBR / OUTLN11.DQC / OUTLN.DOC
Text File  |  2000-06-30  |  6KB  |  148 lines
  1. ;;06-13-85
  2.                          OUTLN.DOC v1.1
  3.                             07/24/85
  4. Eric Gans
  5. French Dep't UCLA
  6. Los Angeles, CA 90024
  7.  
  8. Version 1.1 update:
  9. Added skip-line toggle, force blank spaces; corrected a couple of 
  10. messages. 
  11.  
  12.  
  13.     In  these  days of the "outline-processors"  KAMAS  and  the 
  14. public-domain  TOUR, a friend showed me an older program   called 
  15. OUTLINE that has no fancy command-structure but is all the easier 
  16. to use.   Instead of trying (and probably failing) to be its  own 
  17. word-processor,  it processes Wordstar source files of any length 
  18. that  you  create using commands that can be learned in about  30 
  19. seconds.   The result of the processing is an outline in Wordstar 
  20. DOC  mode  that can itself be edited directly.   A  great  little 
  21. program, but with a couple of drawbacks: 
  22.  
  23.      1.  Allows only four outline levels, with no "0"  level  for 
  24. ordinary text.
  25.      2.  Limited number of entries at each level (39 for level 1, 
  26. 26 for level 2, etc.)
  27.      2.   The  right  margin cannot be  more  than  80  (although 
  28. printers in compressed mode can handle 120).
  29.      3.   The file takes up 16K on disk and, although  not  slow, 
  30. could  be  a lot faster. (It uses so many PUSH's, POP's  and  DAD 
  31. SP's that it must have been written in Forth.)
  32.  
  33.  
  34.      OUTLN  is  a  Z80  version of  OUTLINE  with  the  following 
  35. improvements:
  36.  
  37.      1.  Allows 8 outline levels plus a "zero" level for straight 
  38. text.
  39.      2.  Allows right margins from 50-255
  40.      3.  Creates a BAK file from your source (if you use the same 
  41. name  for  source and destination); this can be disabled  with  a 
  42. switch.
  43.      4.   Occupies  only 13 sectors (1.5 K) and is quite fast (30 
  44. seconds for an 80K source file).
  45.  
  46. Format: outln sourcefile [destfile] [/switches]
  47.  
  48. If  no destfile given, the same name will be used and the  source 
  49. filename changed to fn.BAK.
  50.  
  51. Switches:
  52.  
  53. B = no BAK file. (Use only if destfile name not entered.)
  54.  
  55. L = don't skip extra lines between headings (default will skip  1 
  56. line  before  headings @2-@8 and 2 before @0 and @1;  with the  L 
  57. switch you skip one line before @0 and @1 and none otherwise)
  58.  
  59. Mnn  =  Set right margin to nn.  50 <= nn <=  255.   The  default 
  60. margin is 65, as in WS.
  61.  
  62. The  switches  can be entered together in any  order:  /bm100  or 
  63. /m100bl is acceptable 
  64.  
  65. Command structure:
  66.  
  67.      The outline levels (0-8) are entered following an "@".  They 
  68. may  appear at any point in the text, although it is  simpler  to 
  69. put  them in the left margin.  The outline remains in  the  order 
  70. entered and is indented and numbered according to the level:
  71.  
  72. @0 = text (flush left margin)
  73. @1 = roman caps I-CCLV = 255  
  74. @2 = Caps A-Z  The 27th @2 will produce A & will continue to wrap 
  75. around until 255 letters have been reached.
  76. @3 = Numbers 1-255
  77. @4 = l.c. a-z as in @2
  78. @5 = roman l.c. i-cclv  as in @1
  79. @6 = (Caps) (A)-(Z) as in @2
  80. @7 = (Numbers) (1)-(255) as in @3
  81. @8 = (l.c.) (a)-(z) as in @5
  82.  
  83. @l  or @L = skip line toggle.  Switches between skip-line and  no 
  84. skip modes (see "L" switch description) within the file, allowing 
  85. you to close up or spread out the outline at different points.
  86.  
  87. Spaces,  crlf's and "soft" hyphens will be compressed to a single 
  88. space when the outline is output.  To force spaces (in formatting 
  89. tables,  etc.),  use the underline character "_"  This will  only 
  90. work within the predefined margins. 
  91.  
  92. For  either "@" or "_" as a literal,  precede it by  @:  "@_@_@_" 
  93. will produce "___"
  94.  
  95. Thus:
  96. @1 OUTLN
  97. @2 ease of operation
  98. @3 small size
  99. @3 simple command structure
  100. @4 single format
  101. @4 follows text order
  102. @3 speed 
  103. @2 flexibility
  104. @3 allows direct entry using WS @l
  105. @3 allows files of any length  @l
  106. @3 margins 50-255
  107. @4 to format: 123     456
  108. @4 use:_______123_____456
  109. would appear (with the /l switch) as:
  110.  
  111.         I.  OUTLN 
  112.             A.  ease of operation 
  113.                 1.  small size 
  114.                 2.  simple command structure 
  115.                     a.  single format 
  116.                     b.  follows text order 
  117.                 3.  speed  
  118.             B.  flexibility 
  119.                 1.  allows direct entry using WS 
  120.  
  121.                 2.  allows files of any length 
  122.                 3.  margins 50-255 
  123.                     a.  to format: 123 456
  124.                     b.  use:       123     456
  125.  
  126. Notes:  
  127.  
  128. If  you want to edit the outline with WS,  you should  reset  the 
  129. right  margin  with ^OR if you used the "M" switch.   OUTLN  does 
  130. nothing about page breaks since WS creates its own and kills  any 
  131. others already in the file (i.e., converts 8ah to 0ah) on editing 
  132. or printing. 
  133.  
  134. Like  OUTLINE,  OUTLN give you total freedom in changing  levels.  
  135. You can mix them in any order, although of course the traditional 
  136. format  moves  downward  1 level at a time and  never  permits  a 
  137. single  entry  at any level (e.g.,  no "A" without  a  "B").   It 
  138. seemed  counterproductive to waste code on error checking when it 
  139. might just be useful in some application to jump from level 1  to 
  140. level 5 ... and in any case, the program is simple enough so that 
  141. you  will  have  no  difficulty  in  applying  these  constraints 
  142. yourself.
  143.  
  144.  
  145. The  enhancements  of  v1.1 were made at the suggestion  of  Dick 
  146. Sheresh  of Chula Vista CA.   If you have other  suggestions  for 
  147. additional features/corrections I will do my best to include them 
  148. in a future version.