home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / utilities / utilsm / megaboard / Docs / Guide next >
Encoding:
Text File  |  1995-03-03  |  11.8 KB  |  296 lines

  1.                          ****************************
  2.                          *--------------------------*
  3.                          *- MegaBoard Version 1.54 -*
  4.                          *--------------------------*
  5.                          ****************************
  6.  
  7. Please note this program is SHAREWARE, please refer to the end of this file
  8. for details.
  9. ---------------------------------------------
  10. - Upgrading from versions earlier than 1.50 -
  11. ---------------------------------------------
  12. In this version of MegaBoard the special icon interface has been completely
  13. rewritten (for exact details see the ProgInfo file), therefore special icons
  14. written for earlier versions will no longer work. This drastic change was
  15. necessary because of the unpredictable memory requirements of BASIC
  16. libraries. I appologise to any authors of special icons for this
  17. inconvenience.
  18. Saved configurations that do not contain special icons can still be used with
  19. this version.
  20.  
  21. ----------------
  22. - Introduction -
  23. ----------------
  24. MegaBoard is a versatile desktop Backdrop utility designed as a replacement
  25. for the Pinboard Module supplied with Risc OS 3.
  26.  
  27. -----------------------
  28. - System Requirements -
  29. -----------------------
  30. MegaBoard requires Risc OS 3.5 or greater in order to operate correctly. At
  31. the time of writing this was only available on the RiscPC. Should a version
  32. be released for other models MegaBoard should run correctly on these
  33. machines as well.
  34.  
  35. ---------------
  36. - Terminology -
  37. ---------------
  38. "MegaBoard" refers to this Program.
  39. "Pinboard"  refers to the Risc OS 3 utility.
  40.  
  41. ---------------
  42. - Starting up -
  43. ---------------
  44. MegaBoard can be Loaded by double clicking on the icon !MegaBoard in the
  45. directory viewer.
  46. When MegaBoard is first loaded it is necessary for it to reinitialise the
  47. Filer. This will cause all open Filer Windows to be closed. Installing
  48. MegaBoard into the boot sequence (see below) avoids this Problem.
  49.  
  50. -------
  51. - Use -
  52. -------
  53.  
  54. Filer icons
  55. -----------
  56. Placing Filer icons on MegaBoard:
  57. An icon is placed on MegaBoard by dragging it from a Filer window and
  58. dropping it on MegaBoard.
  59.  
  60. Moving:
  61. An icon dragged and dropped onto another part of MegaBoard will be moved
  62. to that position unless it is locked.
  63.  
  64. Positioning and Grid lock:
  65. Normally filer icons are positioned at the exact position they were dropped
  66. on th MegaBoard. However if the Grid lock option is on then any icons
  67. placed or moved on MegaBoard will be positioned at the closest grid
  68. point. The Grid lock option is toggled by choosing the Grid lock menu item
  69. on MegaBoard menu.
  70. Note: Grid lock only applies to Filer icons placed or moved when it is
  71.       activated. Activating Grid lock has no effect on existing icons unless
  72.       they are moved.
  73.  
  74. Double-clicking:
  75. Double-clicking Select on an icon placed in the manner described above has
  76. the same effect as it would in a Filer window. Double-clicking Adjust is
  77. identical unless the 'Adjust Removes' option is set in the main menu, in
  78. which case the icon is also removed from MegaBoard.
  79.  
  80. Dragging:
  81. Icons dragged from MegaBoard and dropped on other applications (including the
  82. Filer) are also treated in the same way as icons dragged from a Filer window
  83. with the exception of dragging with Shift copying not moving the selected
  84. items.
  85. Dragging with Adjust additionally removes the items from MegaBoard if the
  86. 'Adjust Removes' option is set in the main menu.
  87.  
  88. Selecting:
  89. Filer icons can be selected in several ways:
  90. 1. Clicking Select on an unselected icon selects it and deselects all others.
  91.    Clicking Select on a selected icon has no effect.
  92. 2. Clicking Adjust on an unselected icon selects it.
  93. 3. Clicking Adjust on a selected icon deselects it.
  94. 4. Dragging Select on MegaBoard produces a bounding box within which all
  95.    icons are selected.
  96. 5. Dragging Adjust on MegaBoard produces a bounding box within which all
  97.    unselected icons are selected and selected icons are deselected.
  98. 6. Clicking Menu over an icon when none are selected selects that icon and
  99.    opens the main menu.
  100.  
  101. Information:
  102. Information on a Filer icon can be obtained by choosing the 'Info' option
  103. from the 'File' Submenu.
  104.  
  105. Removing:
  106. Filer icons that are no longer required can be removed from MegaBoard by
  107. selecting them and choosing the 'Remove' option from the 'File' submenu.
  108.  
  109. Opening the parent directory:
  110. The parent directory of a file or directory can be opened by choosing the
  111. 'Open Directory' option from the 'File' submenu.
  112.  
  113. Locking:
  114. An icon can be locked to MegaBoard to prevent it from being moved. Locking istoggled by choosing the 'Lock' option in the 'File' submenu. Locked icons can
  115. still be dragged, but dropping the onto MegaBoard will not move them.
  116.  
  117. Window icons
  118. ------------
  119. Iconising application windows:
  120. Clicking on a window's close icon with Shift will cause it to be reduced to a
  121. MegaBoard icon. An exception is filer windows, these will only be handled in
  122. the same way if the 'Iconize dirs' option is set in the MegaBoard menu,
  123. otherwise the icon of the parent directory is placed on MegaBoard as a Filer
  124. icon (see above).
  125.  
  126. Removing:
  127. Window icons cannot be removed using the MegaBoard menu. Double clicking
  128. Adjust or Select on a window icon brings the window to the front and removes
  129. the icon.
  130.  
  131. Accessing menus of iconised windos:
  132. Iconised windows may have menus associated with them, if this is the case
  133. then clicking Menu while pressing Shift opens this menu.
  134.  
  135. Backdrops
  136. ---------
  137. To create a backdrop execute the following steps:
  138. 1. Choose the 'Make' option from the backrop submenu. This opens the backdrop
  139.    setup dialogue box.
  140. 2. Drag the file (sprite or draw file) containing the backdrop to the
  141.    appropriately marked icon.
  142. 3. Select the desired horizontal and vertical positioning icons or the tiled
  143.    icon.
  144. 4. Click on 'OK'.
  145.  
  146. To remove an icon choose the 'Remove' option from the Backdrop submenu.
  147. To change the clour of the backgound choose the 'Colour' option from the
  148. Backdrop submenu. The colour can then be chosen using a standard colour
  149. selector.
  150.  
  151. Special icons
  152. -------------
  153. Special icons are icons which can perform a variety of additional functions,
  154. and can be defined by users with a knowledge of ARM code programming.
  155. Unfortunately at the time of release the documentation for programming
  156. special icons had not been finished, however the source codes of the three
  157. special icons provided is included. Should anyone have any questions on the
  158. technical details of writing special icons they are welcome to contact me at
  159. one of the addresses below.
  160.  
  161. Placing:
  162. Special icons are placed on MegaBoard by choosing their menu items from
  163. the Special icon submenu.
  164.  
  165. Locking:
  166. Special icons can be locked in the same way as filer icons, but contrary to
  167. filer icons they cannot be dragged at all when they are locked.
  168.  
  169. This version of MegaBoard includes the following special icons:
  170.  
  171. Pointer:
  172. Displays the current position of the mouse pointer in screen coordinates.
  173.  
  174. Time:
  175. Displays the current time in the format defined in its Format parameter (see
  176. below for how to edit parameters). The Format parameter is a standard time
  177. and date format string as described on page 327 of the RISC OS 3 User Guide. 
  178. If the format string contained a syntax error the icon will not display the
  179. time, but the word "ERROR" instead.
  180.  
  181. Gobbler:
  182. Deletes files dragged onto it.
  183.  
  184. Parameters:
  185. Some special icons (e.g. Time) can be configured by the user. This is
  186. accomplished by editing its parameters in the following manner:
  187. A special icon has parameters associated with it if its menu item has a
  188. submenu arrow. This submenu contains a menu item for each parameter, each of
  189. these menu items has a submenu of its own, which contains a single writeable
  190. menu item. Initially this contains the default value for the parameter. If
  191. you wish to change this edit the value displayed and choose it with Adjust
  192. (NOT Select as this will close the menu tree).
  193. Use the same procedure to change the value of any other parameters you wish
  194. to alter and subsequently place the icon by Choosing its menu item.
  195.  
  196. The Overview Window
  197. -------------------
  198. Opening:
  199. The overview window is opened by choosing the 'Overview' option from the
  200. MegaBoard Menu.
  201.  
  202. Function:
  203. Displayed on the overview window are is a "map" of the MegaBoard. The white
  204. rectangle around the centre represents the visible area i.e. the screen
  205. excluding the icon bar. the surrounding light grey represents the area
  206. invisible to the user.
  207.  
  208. Icons:
  209. Icons are represented on the overview menu by small colour coded rectangles,
  210. the following is a table of icon types and their colour codes:
  211.  
  212.   Red......File
  213.   Blue.....Directory
  214.   Green....Application
  215.   Magenta..Iconized window
  216.   Black....Special icon
  217.  
  218. Dragging icons on the on overview window:
  219. Dragging an overview window icon and dropping it back onto the overview
  220. window has the same effect as dragging it would on the MegaBoard i.e. the
  221. icon is moved to the postition it is dropped on. Dragging an overview window
  222. icon to adifferent window has no effect.
  223. Unless the 'Move locked' radio icon on the overview window is selected an
  224. attempt to drag a locked icon will have no effect.
  225. If the 'Move locked' radio icon is selected, icons can be dragged and moved
  226. regardless of whether or not they are locked. However this only applies to
  227. the icons' representations on the overview window, restriction to dragging
  228. locked icons on the MegaBoard remain.
  229.  
  230. --------------------
  231. - Copyright notice -
  232. --------------------
  233. Except for the addition of special icons this application may NOT be altered.
  234. Nor may it be distributed for profit without my approval, this includes
  235. distribution as an 'extra' with commercial products, however should you wish
  236. to do so you are welcome to contact me do discuss details. A small charge to
  237. cover copying and media is acceptable.
  238.  
  239. This program is shareware, if you find it useful please register as a user.
  240. Registered users will be entitled to receive free upgrades (see below) and
  241. improved support. The cost of registration is 30 Deutschmarks or 10 UK pounds
  242. including a disc with the latest version of MegaBoard.
  243. Please make all payments in cash only. Users outside the UK or Germany may
  244. send local currency in, it should be equivalent to 30 Deutschmarks. (No coins
  245. please. Should the amount sent exceed DM 30, you will receive upgrades free
  246. of P&P equivalent to the excess amount.)
  247.  
  248. Send registrations, comments, bug reports etc. to:
  249.  
  250. Sham Gardner
  251. Vorderstr 19
  252. 76189 Karlsruhe
  253. GERMANY
  254.  
  255. or EMail: un9l@rz.uni-karlsruhe.de
  256.  
  257. Upgrades
  258. --------
  259. Registered users can receive upgrades as follows:
  260.  
  261. From within Germany: Send a disc and a stamped-addressed jiffy bag to the
  262.                      above address.
  263. From outside Germany: Send a disc and the equivalent of 3 Deutschmarks (e.g.
  264.                       1 Pound) to cover P&P to the above address.
  265. Or by EMail from anywhere in the world: Send a short mail to the above
  266.                                         address and I will reply with a
  267.                                         uuencoded archive containing the
  268.                                         latest version of MegaBoard (no P&P
  269.                                         for EMail).
  270.  
  271. -------------------
  272. - Version history -
  273. -------------------
  274.  
  275. 1.00 - First release version
  276.  
  277. 1.01 - Minor bug fixed that occasionally caused icons to disappear.
  278.        Option added to prevent double clicks with Adjust from removing icons.
  279.  
  280. 1.50 - Special icon interface rewritten to require special icons to be
  281.        written in ARM code. Avoiding the unpredictable memory requirements of
  282.        BASIC librarys.
  283.        The three special icons provided with MegaBoard rewritten in ARM code
  284.        to adjust to this requirement.
  285.  
  286. 1.51 - Minor bugs fixed and several little features added.
  287.  
  288. 1.52 - Overview window and option to place directories instead of iconizing
  289.        filer windows added. Iconized windows reopenen by their tasks are now
  290.        automatically removed.
  291.  
  292. 1.53 - Selections of objects dragged from filer windows no longer all appear
  293.        in the same spot
  294.  
  295. 1.54 - Bug in special icon placing removed
  296.