home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / print / docmast.lzh / Docmaster / docmaster.doc < prev    next >
Encoding:
Text File  |  1992-02-16  |  6.7 KB  |  188 lines
  1.  
  2.             .DOCMaster V1.0 Documentation
  3.             ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  4.  
  5. (c) 1991 Peter Corlett
  6. This program was written with AMOS 1.3, and compiled with the AMOS
  7. compiler V1.00 (so you can't nick my requestors...)
  8.  
  9. Legal bit:
  10. ~~~~~~~~~~
  11. This program is not public domain, but freely distributable. You are not
  12. allowed to charge for this program, even to cover costs, without gaining
  13. permission from me.
  14.  
  15. No warranty is given for any damage or loss, directly, indirectly, caused
  16. by this program. Problems are your problem, not mine.
  17.  
  18. There are also no warranties as to the quality of this .DOC file. If it is
  19. any better than useless, then I will be surprised.
  20.  
  21.  
  22. Introduction:
  23. ~~~~~~~~~~~~~
  24.    This program was written, as I seemed to have tons of .DOC files that I
  25. couldn't print out without wasting loads of paper, and also, having an ugly
  26. printout. A few initial versions were written which did the job, but were
  27. very hard to customise, as they were 'hard-wired'. Now I have redesigned the
  28. front end, and cleaned the code up, and this is the result.
  29.  
  30.  
  31. Use:
  32. ~~~~
  33.    This program was written to be easy to use, and I have come up with an
  34. Intuition 2.0 like frontend, which works well with text input.
  35.    To edit some text, click on the textbox where you want the cursor to go,
  36. just like intuition. You can use cursor left/right to go through the text.
  37. Backspace and Delete work as you would expect. Cursor up/down moves between
  38.  the fields (I didn't know about TAB/SHIFT-TAB at the time of writing this.)
  39. Escape types '|['.
  40.    Some boxes require some control codes, and so the method of entry I
  41. chose is the method used on the Acorn machines for their strings. The
  42. character | precedes control codes like so:
  43.  
  44. |@ = 0    |A = 1    |B = 2    to    |Z = 26
  45. |[ = 27    |\ = 28    |] = 29    |^ = 30    |_ = 31
  46. ( |[=ESCape )
  47.  
  48. A few special ones are used as well:
  49.  
  50. || = |
  51. |? = 127 (Backspace)
  52. |! = 128 + code of next char eg |!|? = 255
  53.  
  54. If you can't understand this, go and see your local Beeb/Electron expert.
  55.  
  56.  
  57. The gadgets:
  58. ~~~~~~~~~~~~
  59.     Firstly, those that define the printer effects etc
  60.  
  61. Printer name    Type the device name of the printer. This will usually be
  62.         PRT:, PAR:, SER:, NIL:. If you want to print to a file
  63.         (why?) then click on the 'Printer Name' itself, and you
  64.         will get a filerequestor.
  65.  
  66. Reset        This is the control code for a printer reset.
  67.  
  68. Newline        This is the control sequence for a carriage return. This
  69.         is likely to be |J
  70.  
  71. On page        This is the control codes to affect the text printed. This
  72.         should contain ALL the codes needed, such as NLQ, line
  73.         spacing, condensed, etc. A disable paper out would go here
  74.         as well (but be careful with it.)
  75.  
  76. After page    This is what to print after the page. Usually a |L to
  77.         formfeed. If you disables the paper out, then enable it
  78.         here (preferably ASAP)
  79.  
  80.     Next, there are the formatting controls. These are used to produce
  81.     multi-column text, and to force pages to a fixed length.
  82.  
  83. Column width    This is how wide you want your columns of text to be. This
  84.         is typically 79 or 80
  85.  
  86. No. colums    How many columns do you want?
  87.  
  88. Column space    This is how much of a gap is put between the columns. 0 is
  89.         for no gap (ie possible bleeding between columns.) 1 or
  90.         2 is about right for this (depends on file and page
  91.         layout.)
  92.  
  93. Row height    This is how high you want your rows to be. 66 is the likely
  94.         value for already processed textfiles, eg those 'printed'
  95.         from a wordprocessor.
  96.  
  97. No. rows    How many rows do you want?
  98.  
  99. Row space    This is how much of a gap is put between the rows. 0 is
  100.         for no gap (ie possible bleeding between rows.) 2 to 4
  101.         is about right for this (depends on file and page layout.)
  102.  
  103. TAB value    This says where the TAB stops are placed. 0 means ignore
  104.         it, 1 means do a space, anything else causes a TAB to
  105.         multiples of that number. Usually files are written with a
  106.         TAB of 8.
  107.  
  108.     Now we just need to know what to print.
  109.  
  110. File to print    Either enter the name in the box, or click on the 'File to
  111.         print' box, and you will get a filerequestor.
  112.  
  113.     Finally, we have boxes that cause things to happen.
  114.  
  115. Undo        Cancels everything changed.
  116.  
  117. Use        Fixes text. It will tidy up the numbers, and clean up the
  118.         control code strings. It stops Undo as well.
  119.  
  120. PRINT FILE    Prints the file. An image of the page will appear. If you
  121.         want to print it press 'Y' and it will print. It will let
  122.         you print as many copies as you wish, by repeatedly
  123.         pressing 'Y'. 'N' will go onto the next page. 'A' will
  124.         cancel the print altogether.
  125.  
  126. Load settings    As the control codes can get complicated, you can load and
  127. Save settings    save them. The datafiles are put into S:, with the .PRT
  128.         extension.
  129.  
  130. About        Backslapping, copyright, distribution etc.
  131.  
  132. Quit        If you don't want to exit, then this is the best gadget
  133.         to avoid. there is no check if you don't want to, either.
  134.  
  135.  
  136. Comments:
  137. ~~~~~~~~~
  138.    This is just a taster of this program. Because I didn't make any
  139. backups, I don't have the source to this program, so the next version
  140. (which will probably NOT be freely distributable) is going to be really
  141. nice (I know, because I have an almost working copy.)
  142.  
  143.    It seems to me that you should print to PAR:/SER: rather than to PRT:,
  144. as I have found that some of the useful effects can not be performed using
  145. the ANSI codes (or maybe the EpsonX driver is dud.) There seems to be some
  146. interesting things that the printer.device can do to the codes, that can
  147. ruin a printout. Of course, if you need to print international characters,
  148. then you might have to use PRT:.
  149.  
  150.   Most docs come formatted to 80 columns, so there is usually no problem
  151. there. If your file is not formatted at all, ie it is just one line with
  152. a CR at the end of the paragraph, then you are in trouble. Maybe next
  153. version.
  154.  
  155.   Source code files don't always need the full 80 columns. (Especially
  156. 680x0 code.) A good value to use is 3 columns, 52 wide, with a gap of 2.
  157. This gives exactly 160 wide.
  158.  
  159.  
  160. Contact:
  161. ~~~~~~~~
  162.    Bug reports (I know there are a few, but I can't find them,) flames,
  163. comments, suggestions, money, disks (floppy or hard...) to this address:
  164.  
  165.         Peter Corlett
  166.         Derwent College
  167.         University of York
  168.         Heslington
  169.         York YO1 5DD
  170.         ENGLAND
  171.  
  172.   You can also email me, I am 'pnc-a@minster.york.ac.uk'
  173.  
  174. Ideas for improvements:
  175. ~~~~~~~~~~~~~~~~~~~~~~~
  176.     [Comments about the newish in development version in brackets]
  177. * Debug it. [Rewrite will introduce NEW bugs]
  178. * Print whole directory, eg for ARP docs.
  179. * Powerpacker decrunch?
  180. * Even more control over the printing, eg reformatting the files more.
  181. * Support for ANSI codes. At the moment, the ESC is ignored, and the code
  182.   such as [23m is printed out! If $9B is used as the CSI, then it will be
  183.   interpreted by PRT:, and will muck up the formatting! To PAR: it will
  184.   come out as a weird character (probably o-umlaut.)
  185. * A page header handler. [Done]
  186. * Special effects menu, saving typing the codes. [Done]
  187. * More? Write to the address.
  188.