home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / utilities / utilsm / mkdrawf / Doc / DrawfT < prev    next >
Encoding:
Text File  |  1995-05-05  |  6.6 KB  |  160 lines
  1. !Drawf
  2. ======
  3.  
  4. This is the manual for !Drawf, a Wimp front end for mkdrawf and decdrawf. If
  5. you don’t know what those are, you should not be reading this. On the other
  6. hand, you don’t need to be expert in the use of mkdrawf before reading this;
  7. if you come across an allusion to a feature you’ve never heard of, just
  8. ignore it or look it up in the mkdrawf manual.
  9.  
  10. Since the three programs are distributed together, their version numbers
  11. should always agree. This manual describes version number 2.35 of !Drawf; you
  12. can tell what version you have by consulting the Info item on !Drawf’s menu,
  13. producing something like:
  14.  
  15.  
  16.   << Sorry... no pictures in this version of the manual. >>
  17.  
  18.  
  19. but hopefully with a more recent version number.
  20.  
  21.  
  22. Legal rubbish
  23. -------------
  24.  
  25. This program has the same status as mkdrawf and decdrawf; see the main manual
  26. for a precise statement. Roughly, you are permitted to copy and distribute
  27. this stuff provided you don’t (1) make any changes or (2) charge for doing
  28. so. If you want to do (1) or (2), get in touch with me. Of course you can
  29. make changes to your own copy; but you must not (without my permission)
  30. distribute the changed version.
  31.  
  32.  
  33. A potted summary
  34. ----------------
  35.  
  36. Drag a text file to the !Drawf icon to get it converted to a drawfile by
  37. mkdrawf; drag a drawfile to the !Drawf icon to get it converted to a text
  38. file by decdrawf; the Options window (accessible from the menu) lets you
  39. specify where decdrawf puts some kinds of data and where mkdrawf gets certain
  40. other kinds of data from. Error messages get sent to a throwback window, if
  41. you have the Desktop Development Environment installed; into a normal
  42. text-editor window, if not.
  43.  
  44.  
  45. Basic use
  46. ---------
  47.  
  48. When you run !Drawf its icon should appear on your icon bar. The icon looks
  49. like this:
  50.  
  51.  
  52.   << Sorry. >>
  53.  
  54.  
  55. which is a rather feeble attempt to indicate that it turns text files into
  56. drawfiles and vice versa. Dragging a file to this icon will have one of three
  57. results: if the file is a text file, !Drawf will try to invoke mkdrawf on it,
  58. producing a drawfile; if the file is a drawfile, !Drawf will try to invoke
  59. decdrawf on it, producing a text file; otherwise, !Drawf doesn’t know what to
  60. do with it and therefore takes no notice.
  61.  
  62. Supposing the file to be of a kind !Drawf recognises, it should then pop up a
  63. window looking like this:
  64.  
  65.  
  66.   << You don’t really need the pictures anyway. >>
  67.  
  68.  
  69. (of course, the icon might show a drawfile instead of a text file). You
  70. should either enter a full pathname in the writable icon at the bottom of
  71. this window and click OK, or else enter just the leafname and drag the file
  72. icon somewhere. (The “somewhere” is allowed to be, for instance, a text
  73. editor window or !Draw’s iconbar icon.) The one thing you should not do is to
  74. drag the icon to the directory from which the file originally came; that
  75. would make the output overwrite the input, and you probably don’t want that.
  76.  
  77. There may well be a delay before the window appears, though; all the actual
  78. processing of the file is done before the window appears. Also, any error
  79. messages produced by mkdrawf or decdrawf should appear in a window (either a
  80. normal text editor window, or a throwback window, depending on whether you
  81. have the DDE installed) at about the same time as the save window appears.
  82.  
  83.  
  84. Setting options
  85. ---------------
  86.  
  87. From !Drawf’s menu
  88.  
  89.  
  90.   << This picture removed for legal reasons. >>
  91.  
  92.  
  93. you can get to the Options window
  94.  
  95.  
  96.   << Just kidding. >>
  97.  
  98.  
  99. in the obvious way.
  100.  
  101. The purpose of the buttons in the general section of the window is probably
  102. pretty clear: if Filer_Run output is selected, the drawfile or textfile
  103. produced will be run (so that it appears in a window) unless mkdrawf or
  104. decdrawf reported any problems while making it. If … even if errors is
  105. selected, it will be run even if there are errors; you are warned that this
  106. is often completely unhelpful, especially in the case of mkdrawf.
  107.  
  108.  
  109. It may well not be obvious to you what the rest is for. The full answers are
  110. in the mkdrawf manual, but briefly: You can recompile mkdrawf so that it can
  111. use “tagfiles”, which are a bit like RISC OS 3’s message files but simpler,
  112. and if you choose mkdrawf will open a particular tagfile when it first starts
  113. up; decdrawf usually represents sprites and JPEG image objects as great lumps
  114. of hexadecimal data, but you can tell it to write this stuff to another file
  115. instead.
  116.  
  117. When one of these is selected, you can edit the contents of its writable
  118. icon; alternatively, dragging the file icon at the right-hand side to a Filer
  119. window will fill in the pathname in much the same way as if you were saving
  120. something (except that nothing actually gets saved).
  121.  
  122. There are a few traps of which you should be aware...
  123.  
  124. 1. You need to set whatever options you want before dragging your file to the
  125. !Drawf icon. It’s no use dragging the file and then fiddling with the options
  126. window; by that time it’s already too late.
  127.  
  128. 2. !Drawf makes no attempt to check that the place to which you have dragged
  129. one of the icons is actually a Filer window. Unfortunately, if it isn’t then
  130. attempting to do anything which uses the option is likely to cause trouble.
  131. So don’t do that.
  132.  
  133. 3. RISC OS is in many ways a direct descendant of the operating system on the
  134. old BBC micro. One way in which this shows is in the absurd 256-character
  135. limit on command lines. This applies even when the command is being issued by
  136. another program. Furthermore, violating this limit causes my machine (I
  137. haven’t tried it on any others) to lock up completely until it’s reset. So,
  138. !Drawf checks whether the command line it constructs for running mkdrawf or
  139. decdrawf is too long. It is quite likely to be too long, if you are saving
  140. sprites or JPEG images to separate files. If you have the DDE, this ceases
  141. to be a problem and !Drawf doesn’t do the check. (But see the next section.)
  142.  
  143.  
  144. Using throwback and other DDE-ish things
  145. ----------------------------------------
  146.  
  147. In a few places this manual says “…if you have the DDE, such-and-such will
  148. happen”. This isn’t quite true: the program needs to be compiled with a later
  149. version of the C compiler than I have for the extended-command-line stuff (as
  150. mentioned in the previous paragraph) to work, so I’ve compiled it with the
  151. DDE stuff #ifdefed out. You can put it back in by recompiling (the makefile
  152. is set up so that you get the DDE stuff compiled in); if you’re in the
  153. unusual position of having the DDE but not release 4 or better of the C
  154. compiler, let me know and I’ll get a version of !Drawf compiled with the DDE
  155. stuff enabled. Alternatively, just wait for the next release of mkdrawf, in
  156. which everything will be compiled with a newer C compiler.
  157.  
  158.  
  159. That’s all, I think. I did say it wasn’t complicated.
  160.