home *** CD-ROM | disk | FTP | other *** search
/ APDL Public Domain 1 / APDL_PD1A.iso / program / convtmplt / !ConvTmplt / !Help < prev    next >
Encoding:
Text File  |  1993-06-08  |  7.8 KB  |  199 lines
  1. | Help for ConvertTemplates "6.00 (08-Jun-1993)"
  2. |
  3.  
  4. This program is a general purpose Wimp Template file filter.  It is for Wimp
  5. programmers who wish to either:
  6.         1. Anti-alias all their text icons
  7.         2. Convert Interface validation strings to RO3.10 ones
  8.         3. See which icons are beyond a windows' extent
  9.    +++  4. Sort window order (ie window "frank" before window "Zappa")
  10.         5. Insert "secret messages" into Template files :-)
  11.  
  12. I wrote it because I'm a convert to anti-aliased text icons, and although I
  13. do like Simon Huntington's Interface module - it's a pain having to
  14. distribute it with every program.
  15.  
  16. The current things it can do:
  17.         Turn text icons into anti-aliased text icons
  18.         Make sure anti-aliased text colours are correct
  19.         Translates Interface (RO3.00) "B" validation strings to the
  20.                 equivalent RO3.10 "R" validation strings
  21.         Set window extent to bbox of its' icons + workarea
  22.  
  23. Possible things it could easily do
  24.         Delete zero-width/height icons
  25.         Make sure icons are always wide enough for their contents
  26.  
  27. There are two programs, the nice Wimp front end and the back end itself. 
  28. The latter is provided in source format, so change to suit yourself,
  29. although you'd need a new front end :-(  The back end uses my CAssembler
  30. module to handle a dynamic wimp heap, so it should handle any sized template
  31. with ease.
  32.  
  33.  
  34. The Wimp Program:
  35.  
  36.  
  37. Drag a template file to the icon bar icon.  A stander xfer_send dbox
  38. appears.  Just drag the icon to a filer window.  Easy.
  39.  
  40. Note that because the front end is separate from the back end, everything
  41. has to be in physical files, so no RAMTransfer's here, I'm afraid.
  42.  
  43. New to v3.00 is the ability to pre-process the input Template file.  This
  44. has proved necessary with template files containing icons that are
  45. indirected non-text and non-sprite, ie illegal.  The Wimp v3.16 *sometimes*
  46. barfs on these critters and so this master of bodgedom can be used to remove
  47. the vermin.
  48.  
  49. Just place the supplied `DIndNoTNoS' file onto the Run$Path (usually this
  50. means put it into the $.Library directory) and turn the filtering on.  See
  51. separate docs for more information on this little doodad.
  52.  
  53.  
  54. Autoload
  55.  
  56. The option to Misc.Autoload file is very useful.  When selected the processed
  57. Template file will automatically load (into) FormEd.  Now why didn't I think
  58. of doing this before??  There is a *slight* problem in that you need to delay
  59. actually auto-loading the file until it has been generated and I can't see
  60. a simple solution to this, so I just wait 4 Null Reasons before broadcasting
  61. the DataOpen :-(
  62.  
  63.  
  64.  
  65. Command line parameters:
  66.  
  67. In the Boot file an alias `ConvTmplt' is set up for CLI use.  Its' usage is
  68. as follows:
  69.  
  70. ConvTmplt
  71.  <in>                   name of input templates file
  72.  <out>                  name of output file
  73.  [-Hourglass]           hourglass usage (on)
  74.  [-Title]               title font -> anti-aliased      (on)
  75.  [-TFont <name>]        font name for title bar         (Homerton.Medium)
  76.  [-TSize <points>]      point size of title bar font    (12)
  77.  [-Icon]                text font -> anti-aliased       (on)
  78.  [-IFont <name>]        name of icon font               (Homerton.Medium)
  79.  [-ISize <points>]      size of icon font               (13)
  80.  [-CheckColours]        add "F" validation string if
  81.                         change to anti-aliased          (on)
  82.  [-BValidation]         see below                       (on)
  83.  [-Extent]              set window extent to bbox of 
  84.                         all icons (see below)           (off)
  85.  [-IndSize <n>]         reserve <n> bytes for indirected
  86.                         data buffer (if wimp < 287)     (32768)
  87.  [-Sort]                sort window order               (on)
  88.  [-Debug]               error messages include line no  (off)
  89.  
  90.  
  91. The BValidation switch toggles the following conversions:
  92.  
  93.   "B0"/"Z0"  -> "R5", bbox extended by 4 os units
  94.   "B1"/"Z1"  -> "R3", bbox extended by 8 os units
  95.   "B2"/"Z2"  -> "R6", bbox extended by 16 os units
  96.   "B3"/"Z3"  -> "R2", bbox extended by 8 os units
  97.   "B4"/"Z4"  -> "R2", bbox extended by 4 os units
  98.   "B5"/"Z5"  -> "R7", bbox extended by 16 os units
  99.   "B6"/"Z6"  -> "R7", bbox extended by 8 os units
  100.   "B7"/"Z7"  -> "R1", bbox extended by 2/4 os units horiz/vertically
  101.   "B8"/"Z8"  -> "R1", bbox extended by 4 os units
  102.  
  103. any other "B" validation string fails.  Note that extra parameters (ie the
  104. comma separated list) are automatically stripped.  Also, the icon is forced
  105. to have a border, and the window is set to be automatically drawn by the
  106. Wimp.
  107.  
  108. Because all extra parameters are stripped, you lose the colour
  109. specifications, but as these are invariably unused, this doesn't matter so
  110. much.
  111.  
  112.  
  113. Anti-Aliased fonts
  114.  
  115. Text / text and sprite icons can be converted to use anti-aliased fonts. 
  116. However, there is some difficult with this in the COLOURS department. 
  117. Because of the way anti-aliased text is implemented, the font colours
  118. default to black on white.  This is OK for writable fields, but for comments
  119. which are on a grey (1) background they don't look QUITE as good as they
  120. could.
  121.  
  122. The way you specify anti-aliased font colours is to use an "F" field in the
  123. validation string.  Thus the algorithm to anti-alias an icon is:
  124.         fore <-- icon.fore
  125.         if icon is filled then
  126.                 back <-- icon.back
  127.         else
  128.                 back <-- window.workback
  129.         set text to anti-aliased
  130.         if fore<>7 or back<>0
  131.                 if indirected
  132.                         if validation string exists && no F field
  133.                                 append "F"<back><fore>
  134.                         else
  135.                                 create  "F"<back><fore>
  136.                 else
  137.                         force icon to be indirected
  138.                         create  "F"<back><fore>
  139.  
  140. As you can see, you may need to force an icon to be indirected.
  141.  
  142. Note you can't `slab' anti-aliased icons.  Well, you can, but it always
  143. slabs to the background colour of the font!
  144.  
  145.  
  146. Extent
  147.  
  148.  
  149. With this switch you can find all `hidden' icons.  It sets the windows'
  150. extent to the bbox of all its' icons, opens the window full size.  This
  151. option is useful for sneaking looks at other peoples' template files!
  152.  
  153. From v3.00 this optional also forces any `large' window to be bounded
  154. and possess scroll bars, a title bar, and a quit icon.  This ensures
  155. that loading `background' windows does not necessitate a reset!
  156.  
  157.  
  158. Updates
  159. =======
  160.  
  161. 17-Nov-1992     v1.00   semi-working version (oops)
  162. 19-Nov-1992     v2.00   Handles long file names now!!
  163.                         can convert BValidation without Anti-Aliasing
  164. 31-Dec-1992     v3.00   Better memory management for wimp > 2.87
  165.                         More meaningfull error messages
  166.                         "B4", "B8" validation strings
  167.                         Only opens a font once, so can do Large files
  168.                         Filter program option on front end
  169.                         Autoload on front end
  170. 18-Jan-1993     v3.01   "B5","B6","B7" added + "z0"-"z7" processed
  171. 27-Jan-1993     v4.00   Dynamic font handling on dboxes
  172.                         Should now add scroll bars in old-style templates
  173. 07-Feb-1993     v5.00   If drag application finds its' template file
  174.                         hi-rez. sprites
  175. 09-Mar-1993     v5.01   Anti-aliased menus in hi-rez.
  176. 08-Jun-1993     v6.00   Sort, Font menu uses local names
  177.                         can change fonts to use in ConvTmplt's menus
  178.                         font menu is anti-aliased if other menus are
  179.                         sprites23, !sprites23
  180.                         
  181.  
  182. FreeWare
  183. ========
  184.  
  185. This program is released as FreeWare,  That means it comes WITHOUT ANY
  186. WARRANTY.  You can use it, sell it, delete it.  Who cares.  I don't.  If you
  187. want more stuff added, then just write - or better yet do it yerself and
  188. send it in.
  189.  
  190. Any comments / bug reports most welcome.
  191.  
  192. Cy Booker
  193. 86 Church View
  194. Main Road
  195. Crockenhill
  196. Swanley
  197. Kent.  BR8 8JW
  198. U.K.
  199.