home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / f / formtext / !FormText / !Help next >
Text File  |  1997-02-21  |  6KB  |  195 lines
  1.  
  2.  
  3.  
  4.                                   FORMTEXT
  5.     ________________________________________________________________________
  6.  
  7.  
  8.  
  9.     FormText
  10.     ————————
  11.  
  12.     Introduction
  13.     ————————————
  14.     FormText is a utility to reorganise a plain text file so that it has
  15.     regular page breaks, margins, headers, footers and a contents page.
  16.     Files processed in this way can be used as a manual, suitable for
  17.     printing on almost any printer.
  18.  
  19.     The reason for writing it was more to make something useful out of a
  20.     Toolbox tutorial than to provide a brilliant utility. Therefore, the
  21.     formatting code was wriiten for simplicity rather than efficiency.
  22.     Although all formatting is done in RAM it uses a rather slow multi-pass
  23.     process.
  24.  
  25.     This file has been processed by FormText, but without contents because
  26.     they would look silly with a manual this short.
  27.  
  28.     The author
  29.     ——————————
  30.     Tony Houghton
  31.     271 Upper Weston Lane
  32.     Southampton
  33.     SO19 9HY
  34.  
  35.     tonyh@tcp.co.uk         http://www.tcp.co.uk/~tonyh/
  36.  
  37.     Suggestions, presents etc welcome.
  38.  
  39.     Conditions
  40.     ——————————
  41.     The conditions by which FormText is used and distributed are best
  42.     described by the term freeware. This means that it may be freely used
  43.     and distributed, but the author retains copyright. The conditions I
  44.     impose are that the application is distributed without any of its files
  45.     altered, and it is not marketed as a commercial product.
  46.  
  47.     Subscribers to Archive magazine/disc have access to the source code, to
  48.     be used only for tutorial purposes.
  49.  
  50.     Installation
  51.     ————————————
  52.     If you have an OS earlier than RISC OS 3.6 you need the Toolbox modules
  53.     in the supplied copy of !System. Use !SysMerge to install the new modules,
  54.     the merger within RISC OS 3.5 and 3.6's !Boot is bugged.
  55.  
  56.     Version
  57.     ———————
  58.     This is version 1.05.
  59.  
  60.  
  61.  
  62.  
  63.                                     Page 1
  64.  
  65.  
  66.     
  67.  
  68.  
  69.                                   FORMTEXT
  70.     ________________________________________________________________________
  71.  
  72.  
  73.  
  74.  
  75.     Basic use
  76.     —————————
  77.     FormText appears on the icon bar when loaded. To format a file, drag it
  78.     to the FormText icon and a large dialogue box will appear. Fill in the
  79.     details you require and click Format.
  80.  
  81.     While the text is being formatted the Hourglass shows the percentage
  82.     done. This is a very rough guide, based only on how many stages of
  83.     processing the file has gone through so far. The time taken to complete
  84.     each stage can vary widely.
  85.  
  86.     When formatting is complete, the main dialogue box closes and is
  87.     replaced by a Save as dialogue box for you to save the formatted file.
  88.  
  89.     How to set up a text file for formatting
  90.     ————————————————————————————————————————
  91.     FormText splits text up into lines short enough to fit across the
  92.     configured page, so you should only use line-feeds (ie the Return key)
  93.     where you explicitly want them, such as at the end of paragraphs. To
  94.     enter your text you may find it easier to use the SoftWrap mode in Zap,
  95.     or a word processor like Impression that can save plain text without
  96.     line feeds.
  97.  
  98.     Tabs are allowed, these will be expanded with a field of 8 characters.
  99.  
  100.     A line beginning with a certain character is taken to be a heading;
  101.     headings can be underlined and shown in an automatically generated
  102.     table of contents. The 'heading flag' character, which is removed from
  103.     the output file, must have an ASCII value greater than 127; you enter
  104.     which character you want to use in FormText's main dialogue box.
  105.     Recommended characters are ¬ for Risc PC and ¤ for Archimedes, because
  106.     these are available on the keyboard but are rarely used. Do not
  107.     underline your headings, FormText can do this for you.
  108.  
  109.     Settings in the dialogue box
  110.     ————————————————————————————
  111.  
  112.     Page dimensions
  113.     ———————————————
  114.     'Total height' is the total number of lines per page on the printer.
  115.     'Top margin' lines will be left blank at the top of every page, below
  116.     this 'Header lines' are allowed for the header. Then 'Bottom margin'
  117.     lines are left blank above 'Footer lines' allocated to the footer. If a
  118.     header or footer is too long to fit in its space, including a blank
  119.     line, it will be truncated.
  120.  
  121.     The 'Total width' is self-explanatory; 'Left margin' spaces are
  122.     inserted at the start of every line, and room is left for 'Right
  123.     margin' spaces at the end of each line, but these are not actually
  124.     inserted.
  125.  
  126.  
  127.  
  128.  
  129.                                     Page 2
  130.  
  131.  
  132.     
  133.  
  134.  
  135.                                   FORMTEXT
  136.     ________________________________________________________________________
  137.  
  138.  
  139.  
  140.     For clarity:
  141.  
  142.             Total height =  Top margin + Header lines +
  143.                             text height (calculated) +
  144.                             Bottom margin + Footer lines
  145.             
  146.             Total width =   Left margin +
  147.                             text width (calculated) +
  148.                             Right margin
  149.  
  150.     Header & footer
  151.     ———————————————
  152.     Text from these fields is entered at the top and bottom of every page
  153.     respectively. Certain pairs of characters have special meanings:
  154.  
  155.     |M inserts a line feed.
  156.     %p inserts the current page number.
  157.  
  158.     To insert a % or |, use %% or || respectively.
  159.  
  160.     Contents
  161.     ————————
  162.     If the 'Generate contents' button is ticked a contents table is
  163.     generated (may be more than one page), consisting of every heading next
  164.     to its page number. The 'Title' is used as the header of contents
  165.     pages, there is no footer. Page numbers are right-aligned, as many of
  166.     'Leadering char' as necessary are inserted between the entry and its
  167.     page number to guide the eye.
  168.  
  169.     Save settings
  170.     —————————————
  171.     This button saves the settings currently entered in the dialogue box to
  172.     be used as the defaults next time you load FormText.
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.                                     Page 3
  195.