home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / utilities / utilsm / megaboard / Docs / Guide next >
Encoding:
Text File  |  1995-05-04  |  17.9 KB  |  460 lines

  1.                          ****************************
  2.                          *--------------------------*
  3.                          *- MegaBoard Version 1.67 -*
  4.                          *--------------------------*
  5.                          ****************************
  6.  
  7. Please note this program is SHAREWARE, please refer to the end of this file
  8. for details.
  9.  
  10. ---------------------------------------------
  11. - Upgrading from versions earlier than 1.50 -
  12. ---------------------------------------------
  13. In this version of MegaBoard the special icon interface has been completely
  14. rewritten (for exact details see the ProgInfo file), therefore special icons
  15. written for earlier versions will no longer work. This drastic change was
  16. necessary because of the unpredictable memory requirements of BASIC
  17. libraries. I apologise to any authors of special icons for this
  18. inconvenience.
  19. Saved configurations that do not contain special icons can still be used with
  20. this version.
  21.  
  22. ----------------
  23. - Introduction -
  24. ----------------
  25. MegaBoard is a desktop Backdrop utility designed as a replacement for the
  26. Pinboard Module supplied with Risc OS 3. It offers a number of extra features
  27. and enhancements.
  28.  
  29. -----------------------
  30. - System Requirements -
  31. -----------------------
  32. MegaBoard requires Risc OS 3.5 or greater in order to operate correctly. At
  33. the time of writing this was only available on the RiscPC. Should a version
  34. be released for other models MegaBoard should run correctly on these
  35. machines as well.
  36.  
  37. ---------------
  38. - Terminology -
  39. ---------------
  40. "MegaBoard" refers to this Program.
  41. "Pinboard"  refers to the Risc OS 3 utility.
  42.  
  43. ---------------
  44. - Starting up -
  45. ---------------
  46. MegaBoard can be Loaded by double clicking on the icon !MegaBoard in the
  47. directory viewer.
  48. When MegaBoard is first loaded it is necessary for it to reinitialise the
  49. Filer. This will cause all open Filer Windows to be closed. Installing
  50. MegaBoard into the boot sequence (see below) avoids this Problem.
  51.  
  52. -------
  53. - Use -
  54. -------
  55.  
  56. Filer icons
  57. -----------
  58. Placing Filer icons on MegaBoard:
  59. An icon is placed on MegaBoard by dragging it from a Filer window and
  60. dropping it on MegaBoard.
  61.  
  62. Moving:
  63. An icon dragged and dropped onto another part of MegaBoard will be moved
  64. to that position unless it is locked (see below).
  65.  
  66. Positioning and Grid lock:
  67. Normally filer icons are positioned at the exact position they were dropped
  68. on MegaBoard. However if the Grid lock option is on then any icons
  69. placed or moved on MegaBoard will be positioned at the closest grid
  70. point. The Grid lock option is toggled by choosing the Grid lock menu item
  71. on MegaBoard menu.
  72. Note: Grid lock only applies to Filer icons placed or moved when it is
  73.       activated. Activating Grid lock has no effect on existing icons unless
  74.       they are moved.
  75.       Grid lock has no effect on special or window icons
  76.  
  77. Double-clicking:
  78. Double-clicking Select on an icon placed in the manner described above has
  79. the same effect as it would in a Filer window. Double-clicking Adjust is
  80. identical unless the 'Adjust Removes' option is set in the main menu, in
  81. which case the icon is also removed from MegaBoard.
  82.  
  83. Dragging:
  84. Icons dragged from MegaBoard and dropped on other applications (including the
  85. Filer) are also treated in the same way as icons dragged from a Filer window
  86. with the exception of dragging with Shift copying not moving the selected
  87. items.
  88. Dragging with Adjust additionally removes the items from MegaBoard if the
  89. 'Adjust Removes' option is set in the main menu.
  90.  
  91. Selecting:
  92. Filer icons can be selected in several ways:
  93. 1. Clicking Select on an unselected icon selects it and deselects all others.
  94.    Clicking Select on a selected icon has no effect.
  95. 2. Clicking Adjust on an unselected icon selects it.
  96.    Clicking Adjust on a selected icon deselects it.
  97. 3. Dragging Select on MegaBoard produces a bounding box within which all
  98.    icons are selected.
  99. 4. Dragging Adjust on MegaBoard produces a bounding box within which all
  100.    unselected icons are selected and selected icons are deselected.
  101. 5. Clicking Menu over an icon when none are selected selects that icon and
  102.    opens the main menu.
  103.  
  104. Information:
  105. Information on a Filer icon can be obtained by choosing the 'Info' option
  106. from the 'File' Submenu.
  107.  
  108. Removing:
  109. Filer icons that are no longer required can be removed from MegaBoard by
  110. selecting them and choosing the 'Remove' option from the 'File' submenu.
  111.  
  112. Opening the parent directory:
  113. The parent directory of a file or directory can be opened by choosing the
  114. 'Open Directory' option from the 'File' submenu.
  115.  
  116. Locking:
  117. An icon can be locked to MegaBoard to prevent it from being moved. Locking is
  118. toggled by choosing the 'Lock' option in the 'File' submenu. Locked filer
  119. icons can still be dragged, but dropping them back onto MegaBoard will not
  120. move them.
  121.  
  122. Moving to the front or back:
  123. Should an icon be obscuring another it is possible to move it to the back of
  124. the heap by choosing the 'Back' option from the 'File' submenu. Similarly an
  125. icon can be moved to the front by choosing the 'Front' option from the same
  126. submenu.
  127.  
  128. Altered files:
  129. If a file whose icon is on MegaBoard, is deleted or renamed the icon will be
  130. automatically removed from MegaBoard. Similarly if the filetype is altered,
  131. the MegaBoard icon will be updated to reflect the change.
  132.  
  133. Window icons
  134. ------------
  135. iconising application windows:
  136. Clicking on a window's close icon with Shift will cause it to be reduced to a
  137. MegaBoard icon. An exception is filer windows, these will only be handled in
  138. the same way if the 'iconise dirs' option is set in the MegaBoard menu,
  139. otherwise the icon of the parent directory is placed on MegaBoard as a Filer
  140. icon (see above).
  141.  
  142. Removing:
  143. Window icons cannot be removed using the MegaBoard menu. Double clicking
  144. Adjust or Select on a window icon brings the window to the front and removes
  145. the icon. The icon will also be removed if the window's parent application
  146. closes or reopens the window.
  147.  
  148. Accessing menus of iconised windows:
  149. iconised windows may have menus associated with them, if this is the case
  150. then clicking Menu while pressing Shift opens this menu.
  151.  
  152. Note: Window icons cannot be locked.
  153.  
  154. Backdrops
  155. ---------
  156. To create a backdrop execute the following steps:
  157. 1. Choose the 'Make' option from the backdrop submenu. This opens the
  158.    backdrop setup dialogue box.
  159. 2. Drag the object (directory (see below), sprite, or draw file) containing
  160.    the backdrop to the appropriately marked icon.
  161. 3. Select the desired horizontal and vertical positioning icons or the tiled
  162.    icon.
  163. 4. Click on 'OK'.
  164.  
  165. To remove a backdrop choose the 'Remove' option from the Backdrop submenu.
  166. To change the colour of the background choose the 'Colour' option from the
  167. Backdrop submenu. The colour can then be chosen using a standard colour
  168. selector.
  169. If the 'Autoscale' option in the 'Backdrop' submenu is selected then the
  170. backdrop will be scaled to always occupy the same number of OS-units not
  171. pixels on the screen in the same way as icons. E.g. a backdrop in the
  172. standard 1600x600 mode will be scaled to the same size it would be if the
  173. resolution were 1600x1200. This sounds more complicated than it is the effect
  174. of the autoscale option is best understood by experimentation.
  175. When a backdrop is created, it is possible that part of the screen becomes
  176. corrupted and is then redrawn, this is normal and not a bug.
  177.  
  178. Cycled backdrops:
  179. It is possible to select a number of backdrop pictures that will be displayed
  180. successively each being visible for a user-defined time period before being
  181. replaced by the next. This is achieved by the following procedure:
  182.  
  183. - Create a directory to hold the backdrop pictures.
  184. - Copy the files into this directory (it is irrelevant whether these are draw
  185.   files or sprites or a mixture of both).
  186. - Create a script file, either by using the supplied !MakeScrpt application
  187.   or you can write it yourself:
  188.  
  189.   Write a text file containing a list of entries of the following format:
  190.  
  191.     Start_Backdrop
  192.       Horizontal position: <position>
  193.       Vertical position: <position>
  194.       Time: <Time the file should be displayed seconds>
  195.       Name: <Filename of the file>
  196.       Background colour red component: <percentage of colour saturation>
  197.       Background colour green component: <percentage of colour saturation>
  198.       Background colour blue component: <percentage of colour saturation>
  199.     End_Backdrop
  200.  
  201.   Where the horizontal position is one of the following words:
  202.   Centered
  203.   Scaled
  204.   Left
  205.   Right
  206.  
  207.   and the horizontal position one of the following:
  208.   Centered
  209.   Scaled
  210.   Top
  211.   Bottom
  212.  
  213.   The colour saturation percentages are floating point numbers between 0 and
  214.   100 e.g. "53.86%". The percent sign "%" is optional. If one or more of
  215.   these fields is blank then those colour components be preserved from the
  216.   previous backdrop.
  217.  
  218.   The filename should not be a complete path, but only a leafname i.e. if the
  219.   pathname was "adfs::harddisc4.$.fred.pic0" then the filename would be
  220.   "pic0". If this field is blank or the file does not exist in the directory
  221.   then the backdrop picture will be removed for the specified time.
  222.  
  223.   There should be one such entry for each file to be displayed.
  224.  
  225.   Save the file in the same directory as the pictures with the filename
  226.   "Script".
  227.  
  228. - Use the same procedure described above for creating normal backdrops, but
  229.   instead of a sprite or draw file, drag the directory to the icon in the
  230.   backdrop setup window. The settings of the positioning icons is irrelevant
  231.   in this case as the positioning of the pictures is determined by the script
  232.   file.
  233.  
  234. Special icons
  235. -------------
  236. Special icons are icons which can perform a variety of additional functions,
  237. and can be defined by users with a knowledge of ARM code programming. See the
  238. files 'ProgGuide' and 'ProgTut' for instructions on how to create new special
  239. icons.
  240.  
  241. Placing:
  242. Special icons are placed on MegaBoard by choosing their menu items from
  243. the Special icon submenu.
  244.  
  245. Locking:
  246. Special icons can be locked in the same way as filer icons, but contrary to
  247. filer icons they cannot be dragged at all when they are locked.
  248.  
  249. Moving to the front or back:
  250. Special icons can be moved to the front or back the same way as filer icons
  251. (described above).
  252.  
  253. This version of MegaBoard includes the following special icons:
  254.  
  255. Pointer:
  256. Displays the current position of the mouse pointer in screen coordinates.
  257.  
  258. Time:
  259. Displays the current time in the format defined in its Format parameter (see
  260. below for how to edit parameters). The Format parameter is a standard time
  261. and date format string as described on page 327 of the RISC OS 3 User Guide. 
  262. If the format string contained a syntax error the icon will not display the
  263. time, but the word "ERROR" instead.
  264.  
  265. Gobbler:
  266. Deletes files dragged onto it.
  267.  
  268. Acornlogo:
  269. Displays an Acorn logo in the top-right corner of the screen. (Logo sprite by
  270. Adam Goodfellow (adam@comptech.demon.co.uk)).
  271.  
  272. Parameters:
  273. Some special icons (e.g. Time) can be configured by the user. This is
  274. accomplished by editing its parameters in the following manner:
  275. A special icon has parameters associated with it if its menu item has a
  276. submenu arrow pointing to a parameter dialog box which contains a writaeble
  277. icon for each parameter. Initially these icons contain the default values for
  278. the parameters. If you wish to change any of them edit the value displayed.
  279. When all parameters contain the desired values place the icon by clicking on
  280. the 'Create' icon in the dialog box.
  281.  
  282. The Overview Window
  283. -------------------
  284. Opening:
  285. The overview window is opened by choosing the 'Overview' option from the
  286. MegaBoard Menu.
  287.  
  288. Function:
  289. Displayed on the overview window is a "map" of MegaBoard. The white rectangle
  290. around the centre represents the visible area i.e. the screen excluding the
  291. icon bar. The surrounding light grey represents the area invisible to the
  292. user.
  293.  
  294. Icons:
  295. Icons are represented on the overview menu by small colour coded rectangles,
  296. the following is a table of icon types and their colour codes:
  297.  
  298.   Red......File
  299.   Blue.....Directory
  300.   Green....Application
  301.   Magenta..iconised window
  302.   Black....Special icon
  303.  
  304. Dragging icons on the on overview window:
  305. Dragging an overview window icon and dropping it back onto the overview
  306. window has the same effect as dragging it would on the MegaBoard i.e. the
  307. icon is moved to the position it is dropped on. Dragging an overview window
  308. icon to a different window has no effect.
  309. Unless the 'Move locked' radio icon on the overview window is selected, an
  310. attempt to drag a locked icon will have no effect.
  311. If the 'Move locked' radio icon is selected, icons can be dragged and moved
  312. regardless of whether or not they are locked. However this only applies to
  313. the icons' representations on the overview window, restrictions to dragging
  314. locked icons on the MegaBoard remain.
  315.  
  316.  
  317. * Commands
  318. ----------
  319. MegaBoard's support module provides two * Commands, '*Pin' and '*Backdrop'.
  320.  
  321. '*Pin <Pathname> <x_coordinate> <y_coordinate>' places the filer icon
  322. specified by <Pathname> on the MegaBoard at the given coordinates.
  323. Example: *Pin adfs::harddisc4.$.fred 200 200
  324.  
  325. '*Backdrop [-options] [Pathname]' creates a backdrop, whose positioning is
  326. determined by the options as follows:
  327.  
  328. '-Centre'  centres the backdrop horizontally and vertically.
  329. '-HCentre' centres the backdrop horizontally.
  330. '-VCentre' centres the backdrop vertically.
  331.  
  332. '-Scale'  Scales the backdrop horizontally and vertically.
  333. '-HScale' Scales the backdrop horizontally.
  334. '-VScale' Scales the backdrop vertically.
  335.  
  336. '-Tile' Makes the backdrop tiled.
  337.  
  338. '-Top'    Aligns the top of the backdrop picture with the top of the screen.
  339. '-Bottom' Aligns the bottom of the backdrop picture with the top of the icon
  340.           bar.
  341.  
  342. '-Left'  Aligns the left of the backdrop picture with the left of the screen.
  343. '-Right' Aligns the right of the backdrop picture with the right of the
  344.          screen.
  345.  
  346. '-Remove' Removes the current backdrop (if present).
  347.  
  348. This list of options is in order of reverse priority i.e. if two or more
  349. contradictory options are specified (e.g. -hscale and -hcentre) in one
  350. command the one lowest on the above list will take effect.
  351.  
  352. Example: *Backdrop -HCentre -VScale adfs::4.$.Pic0
  353.          Will use the picture in the file 'adfs::4.$.Pic0' as a backdrop. The
  354.          picture will be horizontally centred and vertically scaled.
  355.  
  356. -----------
  357. - Credits -
  358. -----------
  359. Thanks are due to the following for testing, ideas and nagging for more
  360. features:
  361. Pavendip Birah (IRC nickname: PAV)
  362. Asif Nazir (IRC nickname: Hawks)
  363.  
  364. and to Adam Goodfellow for letting me use his AcornLogo sprite.
  365.  
  366. --------------------
  367. - Copyright notice -
  368. --------------------
  369. Except for the addition of special icons this application may NOT be altered.
  370. Nor may it be distributed for profit without my approval, this includes
  371. distribution as an 'extra' with commercial products, however should you wish
  372. to do so you are welcome to contact me do discuss details. A small charge to
  373. cover copying and media is acceptable.
  374.  
  375. This program is SHAREWARE, if you find it useful please register as a user.
  376. Registered users will be entitled to receive free upgrades (see below) and
  377. improved support. The cost of registration is 15 Deutschmarks or 5 UK pounds
  378. including a disc with the latest version of MegaBoard.
  379. Please make all payments in cash only. Users outside the UK or Germany may
  380. send local currency in, it should be equivalent to 15 Deutschmarks. (No coins
  381. please. Should the amount sent exceed DM 15, you will be entitled to receive
  382. upgrades free of P&P equivalent to the excess amount.)
  383.  
  384. Send registrations, comments, bug reports etc. to:
  385.  
  386. Sham Gardner
  387. Vorderstr 19
  388. 76189 Karlsruhe
  389. GERMANY
  390.  
  391. or EMail: un9l@rz.uni-karlsruhe.de
  392.  
  393. Upgrades
  394. --------
  395. Registered users can receive upgrades as follows:
  396.  
  397. From within Germany: Send a disc and a stamped-addressed jiffy bag to the
  398.                      above address.
  399. From outside Germany: Send a disc and the equivalent of 3 Deutschmarks (e.g.
  400.                       1 Pound) to cover P&P to the above address.
  401. Or by EMail from anywhere in the world: Send a short mail to the above
  402.                                         address and I will reply with a
  403.                                         uuencoded archive containing the
  404.                                         latest version of MegaBoard (no P&P
  405.                                         for EMail).
  406.  
  407. -------------------
  408. - Version history -
  409. -------------------
  410.  
  411. 1.00 - First release version
  412.  
  413. 1.01 - Minor bug fixed that occasionally caused icons to disappear.
  414.        Option added to prevent double clicks with Adjust from removing icons.
  415.  
  416. 1.50 - Special icon interface rewritten to require special icons to be
  417.        written in ARM code. Avoiding the unpredictable memory requirements of
  418.        BASIC librarys.
  419.        The three special icons provided with MegaBoard rewritten in ARM code
  420.        to adjust to this requirement.
  421.  
  422. 1.51 - Minor bugs fixed and several little features added.
  423.  
  424. 1.52 - Overview window and option to place directories instead of iconising
  425.        filer windows added.
  426.        iconised windows reopened by their tasks are now automatically
  427.        removed.
  428.  
  429. 1.53 - Selections of objects dragged from filer windows no longer all appear
  430.        in the same spot
  431.  
  432. 1.54 - Bug in special icon placing removed
  433.  
  434. 1.55 - Scaled backdrops now require less memory.
  435.  
  436. 1.61 - * commands '*Pin' and '*BackDrop' supported allowing e.g. textures to
  437.        be set from !Configure.
  438.        Special icon 'AcornLogo' added.
  439.  
  440. 1.62 - Cycled backdrops supported.
  441.  
  442. 1.63 - Changes to the desktop font handled properly.
  443.        The colour picker now always reflects the current backdrop colour.
  444.        Filer and window icon text is either black or white to ensure it is
  445.        readable with any backdrop colour.
  446.        Filer icons whose objects are altered e.g. their have type changed are
  447.        automatically updated to reflect these changes.
  448.  
  449. 1.64 - Facility to move icons to the front or back of the heap added.
  450.        Window icons not longer slow down the system.
  451.  
  452. 1.65 - Option added to auto-scale backdrops to fit the screen size in OS
  453.        units not pixels.
  454.  
  455. 1.66 - Minor bug fixes.
  456.        Special icon parameters are now edited using a dialog box instead of a
  457.        cumbersome submenu structure.
  458.  
  459. 1.67 - Option to save as additional items added.
  460.