home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / utilities / utilst / wined / !WinEd / !Help < prev    next >
Text File  |  1995-08-03  |  53KB  |  1,387 lines
  1. WinEd
  2. =====
  3.  
  4. A shareware template editor for RISC OS 3.
  5.  
  6.  
  7. Author:
  8.  
  9. Tony Houghton
  10. 271 Upper Weston Lane
  11. Southampton
  12. SO19 9HY
  13. United Kingdom
  14.  
  15.  
  16. This manual describes release 2.10 of WinEd.
  17.  
  18.  
  19. Contents
  20. ========
  21.  
  22. 1 Introduction
  23. 1.1 About WinEd
  24. 1.2 Requirements
  25. 1.3 About shareware
  26. 1.4 Installation and registration
  27. 1.5 Upgrades
  28. 1.6 Distribution
  29. 1.7 Disclaimer
  30. 1.8 Units used
  31. 1.9 Mode independence
  32. 1.10 WinEd's dialogue boxes
  33. 1.11 Error boxes
  34. 1.12 Interactive help
  35.  
  36. 2 Designing templates with WinEd
  37. 2.1 Loading and creating templates
  38. 2.2 Keyboard control of the pointer
  39. 2.3 Sprite files and sprite areas
  40. 2.4 The icon bar menu
  41. 2.5 The Choices dialogue box
  42. 2.6 Browsers
  43. 2.7 Mouse operations in browsers
  44. 2.8 The browser menu
  45. 2.9 Selected window(s) submenu
  46. 2.10 Saving templates
  47. 2.11 Statistics windows
  48. 2.12 The browser tool bar
  49. 2.13 Preview windows
  50. 2.14 The preview menu
  51. 2.15 Editable windows
  52. 2.16 Mouse operations in editable windows
  53. 2.17 The editable window menu
  54. 2.18 Selected icon(s) submenu
  55. 2.19 The editable window tool pane
  56. 2.20 Edit window dialogue box
  57. 2.21 Button types
  58. 2.22 The colour picker
  59. 2.23 The monitor
  60. 2.24 Creating icons: the Icon Picker
  61. 2.25 Work area dialogue box
  62. 2.26 Edit icon/title dialogue box
  63. 2.27 Align dialogue box
  64. 2.28 Space out dialogue box
  65. 2.29 Resize icons dialogue box
  66. 2.30  Frame dialogue box
  67.  
  68. 3 Appendices
  69. 3.1 Hints & tips
  70. 3.2 Customising WinEd
  71. 3.3 Bug reports & suggestions
  72. 3.4 Acknowledgements
  73.  
  74.  
  75.  
  76.  
  77. 1 Introduction
  78. ==============
  79.  
  80. 1.1 About WinEd
  81. ---------------
  82. WinEd is a shareware template editor.  Its features are aimed at 
  83. designing templates for RISC OS 3 with a 3D look, but it can also be 
  84. used for 2D templates.  The most attractive features of WinEd are:
  85.  
  86.         • Main editing interfaces use dialogue boxes.
  87.         • Icons can be dragged between windows, including a 
  88.           customisable 'Picker' window containing the most 
  89.           commonly used icons.
  90.         • Multiple files can be loaded by one instantiation of 
  91.           WinEd.
  92.         • Conventions are based on Acorn's Style Guide.
  93.         • Statistics are available on the size etc of template 
  94.           files.
  95.         • Powerful features for positioning icons relative to 
  96.           each other.
  97.         • Optional rounding of coordinates in high resolution 
  98.           modes to ensure low resolution compatibility.
  99.         • Optional tool panes and keyboard short cuts enhance 
  100.           convenience.
  101.         • Fast loading and saving.
  102.  
  103. 1.2 Requirements
  104. ----------------
  105. WinEd requires RISC OS 3.1 or later, but will work on 1Mb systems.  No 
  106. modules are required except that because it is designed for a 3D look 
  107. you should use the NewLook suite supplied by Acorn if you have RISC OS 
  108. 3.1.  This includes the WindowUtils module, without which some 3D 
  109. applications may crash.
  110.  
  111. 1.3 About shareware
  112. -------------------
  113. WinEd is shareware, not public domain.  Shareware means that you are 
  114. legally obliged to register by sending a fee to the author if you 
  115. decide to continue using the software after an evaluation period.  
  116. Registration of WinEd is described below.
  117.  
  118. Please do not fail to register any shareware you use, not just WinEd.  
  119. Your support helps to preserve an excellent way of allowing users to 
  120. try before they buy and independent authors to distribute their 
  121. software conveniently.
  122.  
  123. 1.4 Installation and registration
  124. ---------------------------------
  125. WinEd can be run from any filing system, but the registration process 
  126. requires a writable medium.  To install WinEd drag it from the 
  127. directory you receive it on to the directory you want it to 'live' in.  
  128. To ensure your new copy is used in preference to the original open the 
  129. application directory with Shift-Double-click and double click the 
  130. !Boot file.  You only need to do this if you have just made a new copy 
  131. and intend to use it without rebooting the computer.
  132.  
  133. When you first install WinEd, you will most probably have an 
  134. unregistered version.  This will be made evident by the start-up 
  135. banner asking you to register, and the string "*** Unregistered ***" 
  136. in the User field of the Info dialogue box.  After registration a User 
  137. file is created: the banner will be removed and your name inserted in 
  138. the User field.
  139.  
  140. The first thing you must do to register WinEd is send £10.00 sterling 
  141. (cheques payable to A. Houghton) to:
  142.  
  143.         Tony Houghton
  144.         271 Upper Weston Lane
  145.         Southampton  SO19 9HY
  146.         UK
  147.  
  148. Please state your name exactly as you wish it to appear in the User 
  149. field, and the version number of WinEd you are currently using.  In 
  150. return I will send you your personal registration code and the latest 
  151. version of WinEd if you have an earlier version.  Overseas customers 
  152. need not pay extra for postage, but S.A.E's will be much appreciated.
  153.  
  154. When you have a registration code run WinEdReg.  This program takes 
  155. your user name and registration code and uses them to create the User 
  156. file within !WinEd.
  157.  
  158. 1.5 Upgrades
  159. ------------
  160. Your User file will be compatible with all future versions of WinEd.  
  161. These will be available from the PD library you originally got it 
  162. from, or APDL which I will always ensure has the latest version.  I 
  163. can not vouch for bulletin boards etc until I get a modem (one day).  
  164. APDL's address is 39 Knighton Park Road, Sydenham, London  SE26 5RN.  
  165. Alternatively you can get upgrades directly from me at the above 
  166. address; please state your registration code and include a preferably 
  167. padded SAE with an 800k disc.  If you require a new printed manual you 
  168. should send an A5 envelope.
  169.  
  170. 1.6 Distribution
  171. ----------------
  172. WinEd may be freely distributed provided all the files, including this 
  173. and other documentation, are left intact and unaltered, except for any 
  174. User file which must be removed.  Customised template files must be 
  175. replaced with the originals.  If you are doing more than giving a copy 
  176. to a friend (eg you run a BBS or PD library) please ensure you have 
  177. the latest version.
  178.  
  179. 1.7 Disclaimer
  180. --------------
  181. The author can accept no liability for any loss or damage caused by 
  182. installing or using WinEd.
  183.  
  184. 1.8 Units used
  185. --------------
  186. The units used and referred to throughout are OS units, except where 
  187. stated.  If a writable icon expecting a number is left blank, zero is 
  188. assumed.
  189.  
  190. Remember that work area coordinates have the origin at the top left 
  191. and anything below this is negative.
  192.  
  193. 1.9 Mode independence
  194. ---------------------
  195. WinEd has been designed so that you do not have to design your 
  196. templates in low resolution modes to ensure compatibility.  This is 
  197. done by providing an option to round all coordinates to the nearest 4 
  198. OS units (equivalent to one pixel in the lowest resolution desktop 
  199. modes), including the dashed outline in drags.
  200.  
  201. 1.10 WinEd's dialogue boxes
  202. ---------------------------
  203. Nearly all of WinEd's dialogue boxes are static ie a click outside 
  204. them does not close them.  This slightly improves convenience and 
  205. consistency.
  206.  
  207. Action buttons generally close the dialogue box they are in unless 
  208. clicked with Adjust instead of Select.  Cancel buttons always close 
  209. the dialogue box.
  210.  
  211. Pressing Return in any writable icon has the same effect as clicking 
  212. Select on the default action icon.  Use the up and down cursor keys or 
  213. (Shift-) Tab to move the caret between icons.
  214.  
  215. When clicked with Select down 'bumper' icons (arrows) decrease values 
  216. shown in adjacent fields, up bumpers increase the values.  Adjust 
  217. reverses this.
  218.  
  219. 1.11 Error boxes
  220. ----------------
  221. Error boxes are usually used when WinEd encounters a problem such as 
  222. lack of memory or missing resources.  Where possible, when WinEd is 
  223. being used to edit data, it tries to continue after such problems, but 
  224. you should save your data as soon as possible.  If WinEd can not 
  225. continue there will be a Cancel button instead of OK or Continue.
  226.  
  227. 1.12 Interactive help
  228. ---------------------
  229. WinEd supports interactive help, including its menus; you may find 
  230. this helpful at first.
  231.  
  232.  
  233.  
  234.  
  235. 2 Designing templates with WinEd
  236. ================================
  237.  
  238. 2.1 Loading and creating templates
  239. ----------------------------------
  240. WinEd can be loaded by double clicking it in a directory display or by 
  241. double clicking any template file.  Naturally t