home *** CD-ROM | disk | FTP | other *** search
/ ftp.barnyard.co.uk / 2015.02.ftp.barnyard.co.uk.tar / ftp.barnyard.co.uk / robot-pd / 12400.ZIP / 12400B.DSK / manual08.txt < prev    next >
Text File  |  1998-04-30  |  9KB  |  322 lines
  1. ═
  2.                 ╩C H A P T E R   S E V E NΩ
  3.  
  4.  
  5. ╩7 The FORMAT UtilityΩ
  6.  
  7. ╩FormatΩ :╔FORMAT <selectors> <src file>Θ
  8.  
  9. The FORMAT program takes the given source file and formats
  10. it according to the  given  selector.  FORMAT  is  a  very
  11. powerful program which can be used to produce high quality
  12. documents.
  13.  
  14. FORMAT makes use of imbedded commands. These commands  are
  15. double letter words prefixed by a dot ("."). They tell the
  16. program to perform certain  operations  on  the  following
  17. text.
  18.  
  19. The invocation selectors accepted are:-
  20.  
  21. &A - Source file is true ASCII, causes FORMAT to  read  it
  22. as such.
  23. &W - Use WYSIWYG output.  Simulate  printer  typefaces  on
  24. screen.
  25. &P - Activate printer output
  26. &v - Deactivate VDU output.
  27. &L<file.path> - Load PCC Data File (See later).
  28.  
  29.  
  30. ╩7.1 FORMAT Dot CommandsΩ
  31.  
  32. ╩SyntaxΩ :.ch "<Heading>" <chapter number> {FF -}
  33.  
  34. FORMAT will automatically  underline  and  centre  chapter
  35. headings when it finds them. It will also make a  note  of
  36. the page number and produce a contents table at the end of
  37. the text. In order for these operations to be carried  out
  38. correctly, FORMAT must be  told  when  a  chapter  heading
  39. occurs.
  40.  
  41. The chapter number should  be  given  after  the  heading.
  42. Remember that  the  double  quote  character  (")  is  not
  43. displayed as such by EDTEXT or any other  program.  FORMAT
  44. will, however, honour the converted character.
  45.  
  46. If the word "FF" is appended to the line  instead  of  the
  47. "-", FORMAT will cause a Form Feed to be output before the
  48. chapter heading.
  49.  
  50. Setting the chapter number will cause  subsequent  section
  51. numbers   to   be   correctly   numbered.   FORMAT    will
  52. automatically insert the PCCs  to  cause  the  heading  to
  53. appear underlined.
  54.  
  55. The .ch command does not automatically isolate the chapter
  56. heading. If you wish a gap around  the  heading  when  not
  57. using the "FF" option, then you must make the gap  in  the
  58. source text eg;
  59.  
  60.                 ╔<....some...text...>Θ
  61.  
  62.                 ╔.ch etc.Θ
  63.  
  64.                 ╔<....more...text...>Θ
  65.  
  66.  
  67. ╩SyntaxΩ :.{ <paragraph>
  68.  
  69. Indicates  the  start  of  a  paragraph.  Text  within   a
  70. paragraph is affected by the current format settings. Text
  71. outside is left largely  unaltered.  the  {  command  also
  72. causes indentation, if a value has been specified with the
  73. .pi command.
  74.  
  75.  
  76. ╩SyntaxΩ :<paragraph> .}
  77.  
  78. Indicates the end of a paragraph. Text after this  command
  79. will not be altered  except  to  fit  the  current  margin
  80. settings.
  81.  
  82.  
  83. ╩SyntaxΩ :.nl
  84.  
  85. Format stores each word in a buffer which it  prints  when
  86. the buffer becomes full. This command causes the  contents
  87. of the buffer to be output followed by a  carriage  return
  88. and line feed.
  89.  
  90.  
  91. ╩SyntaxΩ :.el
  92.  
  93. Causes the contents of the buffer to be output followed by
  94. a carriage return and line feed. If the  buffer  is  empty
  95. then no action is taken.
  96.  
  97.  
  98. ╩SyntaxΩ :.pm {SKIP WAIT IGNORE}
  99.  
  100. Sets the paging mode. When FORMAT reaches  the  end  of  a
  101. sheet of paper it has  a  choice  of  ignoring  the  fact,
  102. skipping over the perforations or waiting for the user  to
  103. sort things out. The .pm command allows the  user  to  set
  104. the required option.
  105.  
  106.  
  107. ╩SyntaxΩ :.pn <page.number> {- TOP BOTTOM}
  108.  
  109. Sets the value for the next page number and  the  position
  110. it is to be printed at. The dash indicates  that  no  page
  111. numbers  are  required  from  now  on.  Page  numbers  are
  112. displayed in the form:-
  113.  
  114.            ╔< <number> >Θ  eg;  ╔< 5 >Θ
  115.  
  116. The number is also isolated by blank lines both above  and
  117. below.  These blank lines have the  affect  of  forcing  a
  118. "half skip" when the perforation setting is IGNORE.
  119.  
  120.  
  121. ╩SyntaxΩ :.sh <depth> "<heading>"
  122.  
  123. This command is provided for the same reason  as  the  .ch
  124. command. It operates  in  a  similar  way  except  that  a
  125. section depth value must be specified. For a first section
  126. this value is 1 ie;
  127.  
  128.                     ╔1.1 First SectionΘ
  129.  
  130. For a subsection the value is two ie;
  131.  
  132.                     ╔1.1.1 SubsectionΘ
  133.  
  134. Note that, like .ch, you must isolate section headings  in
  135. the source text if you want them to  be  isolated  in  the
  136. final document.
  137.  
  138.  
  139. ╩SyntaxΩ :.fl <length>
  140.  
  141. Allows the user to tell FORMAT of the  current  number  of
  142. lines╙╔Printable on a╙single sheetΘ note that  this  value
  143. is ╩notΩ the ╙form-length. FORMAT will  decide╙  the  true
  144. form-length by calculating the number of lines  "lost"  to
  145. page numbers and perforation gaps.
  146.  
  147.  
  148. ╩SyntaxΩ :.ls <value>
  149.  
  150. Sets the number of times  the  printer  moves  down  after
  151. printing a  line  of  text.  A  line  spacing  of  two  is
  152. recommended  if  the  document  is  to  be  submitted  for
  153. critical appraisal as it allows  comments  to  be  written
  154. between the lines.
  155.  
  156.  
  157. ╩SyntaxΩ :.ct "<text>"
  158.  
  159. Centres the given text within the current margin settings.
  160.  
  161. ╩SyntaxΩ :.rt "<text>"
  162.  
  163. Prints the given text against the right edge of the paper.
  164.  
  165.  
  166. ╩SyntaxΩ:.nc
  167.  
  168. Disables output of contents list.
  169.  
  170.  
  171. ╩SyntaxΩ :.lm [+]<value>
  172.  
  173. Allows the user to adjust the current setting for the left
  174. margin. The "+"  option  allows  the  user  to  specify  a
  175. relative offset-positive or negative.
  176.  
  177.  
  178. ╩SyntaxΩ :.rm [+]<value>
  179.  
  180. Allows the user to adjust the right margin. See above  for
  181. details.
  182.  
  183.  
  184. ╩SyntaxΩ :.ju {ON OFF}
  185.  
  186. Controls automatic text  justification.  The  ON  and  OFF
  187. options are fairly self explanatory.  Remember  that  text
  188. outside a paragraph is not justified anyway.
  189.  
  190.  
  191. ╩SyntaxΩ :.ff
  192.  
  193. Instructs FORMAT to terminate the current  page  and  skip
  194. forward to the start of the next sheet. The  page  numbers
  195. will, of course, still be printed correctly.
  196.  
  197.  
  198. ╩SyntaxΩ :.fw [+]<value>
  199.  
  200. Allows the user to set the width of paper between the  two
  201. margins. FORMAT will  automatically  centre  the  page  of
  202. text. The "+" option allows the user to specify a relative
  203. size change.
  204.  
  205.  
  206. ╩SyntaxΩ :.da "{<date expression> -}"
  207.  
  208. Causes FORMAT to evaluate the date expression-if given-and
  209. to insert the literal result into the text. The  resulting
  210. text will still be justified if applicable.
  211.  
  212. If `-' is given then the current  date  will  be  inserted
  213. into the text, eg; .da "-"
  214.  
  215.  
  216. ╩SyntaxΩ :.ti
  217.  
  218. Causes FORMAT to insert the current  time  into  the  text
  219. which will still be justified if applicable.
  220.  
  221.  
  222. ╩SyntaxΩ :.ip "<prompt message>"
  223.  
  224. Instructs FORMAT to fetch  a  section  of  text  from  the
  225. user-in response to the prompt-and incorporate the  result
  226. into the text. As with .da and  .ti  the  result  will  be
  227. justified if applicable.
  228.  
  229.  
  230. ╩SyntaxΩ :.in "<file path>" [FF]
  231.  
  232. Instructs FORMAT to break off reading the  current  source
  233. file. FORMAT will then attempt to read the contents of the
  234. given file. The given file can,  itself,  contain  further
  235. .ip commands, but such nesting is only  allowed  up  to  a
  236. maximum of ten suspended files.
  237.  
  238. Provided no more than ten files are suspended at  any  one
  239. time, there is no limit to the number of .ip commands  you
  240. can use. When the end of a file is  reached,  FORMAT  will
  241. return to the last suspended file at a point after the .ip
  242. command.
  243.  
  244. The "FF" directive instructs FORMAT to issue a  form  feed
  245. before continuing printing.
  246.  
  247.  
  248. ╩SyntaxΩ :.vc {START STOP}
  249.  
  250. Instructs FORMAT to buffer the text in between  the  START
  251. and STOP options. When the buffer is  full  (or  when  the
  252. STOP option  is  invoked)  the  text  will  be  vertically
  253. centred.
  254.  
  255.  
  256. ╩SyntaxΩ :.pi <value>
  257.  
  258. Allows the user to set the number of spaces used to indent
  259. a paragraph when the .{ command is invoked.
  260.  
  261.  
  262. ╩SyntaxΩ :.go
  263.  
  264. This command MUST be used to start text output.
  265.  
  266.  
  267. ╩SyntaxΩ :.pr <list<PCC code>>
  268.  
  269. Outputs the given list of  PCC  codes.  The  list  can  be
  270. terminated by any none valid PCC or by the end of a  line.
  271. This option should be used to send codes to the printer to
  272. initialise it before printing starts.
  273.  
  274.  
  275. ╩7.2 Default SettingsΩ
  276.  
  277. Format initialises to a standard document printing status.
  278. This status can be used  to  print  any  report  or  large
  279. document. It is recommended, however, that  users  set  up
  280. ALL initial conditions themselves.
  281.  
  282.          PAGE LENGTH                   : A4 / 70
  283.          PAGE WIDTH                    : 60
  284.          PERFORATION MODE              : SKIP
  285.          PAGE NUMBERS                  : TOP (1+)
  286.  
  287.  
  288. ╩7.3 PCC Data FilesΩ
  289.  
  290. These define the specific values to be sent to the printer
  291. when each PCC is encountered. The default setting  is  for
  292. NULL codes, ie; no codes are sent.  These  default  values
  293. will produce DRAFT output.
  294.  
  295. The code should be given in the following pattern:-
  296.  
  297. <list
  298.  <Letter>
  299.  <list
  300.   <numeric values>
  301.  >
  302. >
  303. -
  304.  
  305. An example could be:-
  306.  
  307. K
  308. 27
  309. 45
  310. 1
  311. -
  312.  
  313. Which would set up  the  underline  ON  option  for  EPSON
  314. printers.╒
  315. $     ╩C H A P T E R   S E V E NΩ
  316.  
  317.  
  318. ╩7 The FORMAT UtilityΩ
  319.  
  320. ╩FormatΩ :╔FORMAT <selectors> <src file>Θ
  321.  
  322. The F