home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / s / suite / !Suite / !Help < prev    next >
Encoding:
Text File  |  1995-02-07  |  14.1 KB  |  293 lines

  1. !Suite
  2. v 2.12 (06-Feb-1995)
  3. This program require RISC-OS 3.10 or greater to run.
  4.  
  5. This program is Shareware. This means that you can copy this program to
  6.    anyone you like, but if you find the program useful, you should register,
  7.    as explained below. This entitles you to the latest version of this
  8.    program, and of all my other applications.
  9. If you do copy the program it should be in its original format, with ALL of
  10.    the accompanying files. That is : !Boot
  11.                                      !Help
  12.                                      !Run
  13.                                      !RunImage
  14.                                      !Sprites
  15.                                      Code
  16.                                      Defaults
  17.                                      MakeCode
  18.                                      Messages
  19.                                      Sprites
  20.                                      Templates
  21.    and the following libraries : ARM3, AutoWarn, BasicEd, Bin, CacheSpr,
  22.       Clock, LoseCaret, SetCSD, SetType, Speaker, VDU, and Volume.
  23.  
  24.  
  25. Purpose
  26. -------
  27. A suite of utilities.
  28.  
  29.  
  30. To use
  31. ------
  32. Firstly, you will need some icons on the icon bar. These are accessible from
  33. the icon bar menu. Click menu (the middle mouse button) on the !Suite icon,
  34. or on one of !Suite's icons that may already be created, and go across to the
  35. 'Show' sub-menu. Here, you can select which of Suite's icons you wish to have
  36. on the icon bar.
  37.  
  38. Bin - Drag a file or directory (or group of files/directories) onto this
  39.       icon. The file(s)/directory(ies) will then be deleted according to the
  40.       options set in the options window.
  41.  
  42.       Options : Force deletion of locked objects
  43.                 Keep backup
  44.                    Only if same disc
  45.                 Confirm
  46.                    OK/Cancel icons   or   Mouse pointer
  47.                    Individual selection of deletion
  48.  
  49.          If the force option is set, all files will be deleted, including
  50.       locked ones.
  51.          If the 'keep backup' option is set, deleted files will be moved
  52.       to a temporary directory inside !Suite. If there are files in this
  53.       directory, the bin icon will change to a larger bin. To delete the
  54.       files from this directory, click on the 'Empty bin' icon in the bin
  55.       options window. The 'only if same disc' option means that only files
  56.       deleted from the same disc as !Suite was run from will be stored. This
  57.       allows files deleted from a hard disc to be retained temporarily,
  58.       whilst files from floppies are deleted instantly, rather than having to
  59.       move the data between discs.
  60.          If the confirm option is set, when a file/directory is dragged onto
  61.       the bin icon, a window will open, asking you to confirm that the file
  62.       should be deleted. This can be done in two ways. Either, there will be
  63.       an OK and a Cancel icon, which should be clicked to confirm or cancel
  64.       the file deletion, or moving the mouse pointer into this new window
  65.       will change the pointer to a confirmation pointer. Then click SELECT
  66.       to confirm deletion, and MENU or ADJUST to cancel deletion.
  67.          If confirmation is not set, it is impossible to change the state
  68.       of the method of confirmation and individual selection.
  69.          The individual selection of deletion will alter how more than one
  70.       file is treated when in the bin list. If the option is set, each file
  71.       will have to be confirmed separately. If the option is not set, OK
  72.       will only need to be selected once, and all files will be deleted.
  73.  
  74.          Even if the bin is in the middle of a list of files and/or
  75.       directories you can drag further files and/or directories onto the bin
  76.       icon. This will add them to the end of the list, and will offer you the
  77.       option to delete them when it gets round to that point of the list. The
  78.       program will make use of the multi-tasking delete operation, as per the
  79.       normal filer. (N.B. The bin WILL delete locked files if the option is
  80.       set, and will also delete a directory if it is the Currently Selected
  81.       Directory, by going up a directory. The CSD will ONLY be changed if the
  82.       directory to be deleted is the CSD.)
  83.  
  84. Set-Type - Drag a file or group of files onto this icon, and a window will
  85.       open showing the filename, and asking you for the new type. Enter the
  86.       type in the necessary icon, and press RETURN. This will *SetType the
  87.       file accordingly. The filename in the window will then change if there
  88.       is another file in the list, and you will be asked to enter the type as
  89.       before. When there are no more files to set-type, the window will
  90.       close.
  91.  
  92. Bas-Edit - Drag a file onto this icon to load it into the BASIC Editor. If
  93.       the option is set, then the CSD will be set to that of the file. Just
  94.       click on the icon to enter the BASIC Editor with no file loaded and the
  95.       CSD unchanged.
  96.  
  97. VDU - Drag a file onto this icon to show it on screen. Press SHIFT to scroll
  98.       through the text.
  99.  
  100. Speaker - Click on this icon to toggle the internal speaker status. The
  101.       sprite will change to reflect the status of the internal speaker, when
  102.       you click on the icon, and will also change if the status is changed by
  103.       another program, or by the CLI.
  104.  
  105. CSD - Drag a file onto this icon to set the CSD to the directory containing
  106.       that file. Drag a directory or application onto it, and the CSD will be
  107.       set inside that directory. If the option is set, then a window will
  108.       open telling you what the CSD has been set to.
  109.  
  110. Sprites - Drag an application onto this icon to force the wimp to look at
  111.       the !Sprites file inside it (if there is one), or drag a sprite file
  112.       onto the icon to look at it. Please note : the filer window is not
  113.       automatically updated, so the effects of using this option will not be
  114.       immediately obvious. Click SELECT on the icon to open the icon-cacher
  115.       choice window. Here it is possible to choose between *IconSprites and
  116.       *ToolSprites, for any icon dragged onto the icon. If a *ToolSprites is
  117.       performed, a request is made to the Wimp to redraw the whole screen, so
  118.       the new tools are shown.
  119.  
  120. Clock - Click on the icon to show the clock for a few seconds. The ability
  121.       to do this is of use to anybody with an ARM2, and maybe an ARM250,
  122.       where the constant screen updates of a normal clock can slow the
  123.       computer down quite noticably. The length of time for which the clock
  124.       is shown is set from the options window, as is the format. At this
  125.       point in time four formats are available :
  126.                 hours and minutes (hh:mm);
  127.                 hours, minutes and seconds (hh:mm:ss);
  128.                 analogue without seconds (-s);
  129.                 analogue with seconds (+s).
  130.       There is also the option to specify whether the clock should be on the
  131.       left side of the icon bar, the right side of the icon bar, or in its
  132.       own window, which can be moved around the screen to wherever you like.
  133.  
  134. ARM Cache - Click on the icon to toggle the state of the cache on/off. The
  135.       sprite will change to reflect the state of the cache, when you click on
  136.       the icon, and will also change if the state is changed by another
  137.       program, or by the CLI. (NB. State checking is not available on RiscPCs
  138.       - somebody removed the code from RISC OS!!)
  139.  
  140. Volume control - Click on the icon to open a window. This window has a red
  141.       bar which can be dragged in order to alter the volume, and also two
  142.       arrows, which can be clicked on to increase or decrease the sound
  143.       volume. Clicking on the icon marked 'Test' makes a beep to allow you to
  144.       judge how loud the volume is.
  145.  
  146. Auto Warn - Click on the icon to open a window. Enter the minimum time (in
  147.       seconds) of a pause that you wish to be alerted from. (ie. entering a
  148.       time of 10 seconds would generate a beep if a task took up more than 10
  149.       seconds.) Click on the OK icon, or press RETURN, to update the warn
  150.       time. Then, as long as the icon is on the icon bar, a beep is generated
  151.       whenever a pause lasts longer than the time you entered in the window.
  152.       NB. it is not worthwhile entering a time of 1 second as the program
  153.       asks only to receive Wimp messages at one second intervals - ie. the
  154.       slightest pause in Wimp polling would generate a warning beep.
  155.  
  156. Lose Caret - Click on the icon to turn the caret off. This is useful if a
  157.       program uses keyboard short-cuts, without having a window of its own.
  158.  
  159. The application also supports interactive help.
  160.  
  161.    Finally, the program counts its errors and their time intervals. If it has
  162. to report five errors, each one being within two seconds of the previous one,
  163. then the program will kill itself (remove itself from memory, as opposed to
  164. anything more graphic!). This solves (hopefully!) the problems of an
  165. unbreakable error loop.
  166.  
  167.  
  168. Customisation
  169. -------------
  170. Edit the line inside the !Run file inside the application to show what icons
  171. you which to appear on load up. i.e. Append to the Run <Suite$Dir>.!RunImage
  172. the suffixes which correspond to the icons - BIN - Bin icon
  173.                                              SET - Set-Type icon
  174.                                              BAS - BASIC Editor icon
  175.                                              VDU - VDU icon
  176.                                              SPE - Internal speaker icon
  177.                                              CSD - Set CSD icon
  178.                                              SPR - Icon Cacher
  179.                                              CLK - Clock icon
  180.                                              ARM - ARM3 Cache icon
  181.                                              VOL - Volume control
  182.                                              WRN - Auto Warn Alerter
  183.                                              CRT - Lose Caret
  184.                                              MEM - Free Memory
  185.  
  186. A keyboard short-cut is also implemented, allowing you to remove an icon from
  187. screen quickly. To use this, simply press one Ctrl and one Shift key, and
  188. click on the icon to be removed.
  189.  
  190. Also on the icon-bar menu is the 'Options' selection. This sub-menu
  191. offers control of how the program runs. The options are grouped according to
  192. the functions that they refer to. The options are :
  193.         Bin : Force deletion of locked objects?
  194.               Keep a backup of deleted files?
  195.                  Only if from the same disc as !Suite?
  196.               Confirm deletion?
  197.                  Confirm with OK/Cancel icons, or with the mouse pointer?
  198.                  Delete groups of files one at a time, or as one?
  199.  
  200.    BASIC Ed : Set the CSD when loading a file into the BASIC Editor?
  201.  
  202.      SetCSD : Open a window showing the new CSD when it is set?
  203.  
  204.       Clock : Update time for how many seconds?
  205.               Where?
  206.               What format?
  207.  
  208.        Misc : Hi-res sprites? (For a multi-sync monitor)
  209.               Force icons left? (Keeps icons to the left of other
  210.                  applications that install on the left side of the icon bar.)
  211.               Save options as default. (The current state will be set every
  212.                         time !Suite is run. N.B. This saves only the options
  213.                         mentioned in this paragraph, and does not reflect the
  214.                         status of the icons shown on screen.)
  215.  
  216. This version of !Suite uses a new library technique, which means that only
  217. the functions that you need have to be loaded. !LibraryMg is provided to
  218. control which libraries are loaded on start-up of !Suite. However, !LibraryMg
  219. works by changing the file-type of the libraries. As a result of this,
  220. !LibraryMg cannot work if the disc !Suite is on is write-protected. This also
  221. means that the libraries are still present on disc. If you are certain that
  222. you are never going to want these libraries, you can delete them. To do this,
  223. press and hold SHIFT, whilst double-clicking on the !Suite icon in the filer
  224. window. Now double click on the 'Libraries' directory, and here you will see
  225. all of !Suite's libraries. Now the unused libraries can be deleted in the
  226. normal way.
  227. (PLEASE only do this to your own BACKUP copy of the program, however, as
  228. !Suite should not be distributed with any of the libraries missing)
  229.  
  230.  
  231. Programmers info
  232. ----------------
  233. This program responds to message type &4C49454E (that's NEIL in ASCII!) to
  234. alter what icons are shown on screen. So, to send the prog a message, use
  235. something like :
  236.    DIM buff% 128
  237.    !buff%=100:buff%!4=0:buff%!8=0:buff%!12=0:buff%!16=&4C49454E
  238.    buff%!20=icon:buff%!24=state
  239.    SYS "Wimp_SendMessage",17,buff%,0
  240.  
  241. where icon is : 0 = Bin
  242.                 1 = Set-Type
  243.                 2 = BASIC Ed
  244.                 3 = VDU
  245.                 4 = Speaker
  246.                 5 = Set CSD
  247.                 6 = Icon cacher
  248.                 7 = Clock
  249.                 8 = ARM Cache
  250.                 9 = Volume control
  251.                10 = Auto warn alerter
  252.                11 = Lose caret
  253.  
  254. and state is :  0 = off
  255.                 1 = on
  256.  
  257. I cannot really think why anybody would want to use it, but I put it in on
  258. a whim, and it may be of use to you if you want to change the icons shown
  259. depending on who is using the computer.
  260.  
  261.  
  262. Bugs & Improvements
  263. -------------------
  264. Please report any bugs found and any possible improvements you can think of
  265. at the address shown below.
  266.  
  267.  
  268. Registering
  269. -----------
  270. To register, send £5 to me, at the address shown below, stating what version
  271. of which programs you have. You can enclose your own disk for the programs,
  272. and if you do so you can deduct 50p from the price. Registering entitles you
  273. to upgrade to later versions of the same programs and to get new programs
  274. for the price of £1. Any additional contributions from overseas towards
  275. postage would be greatly appreciated.
  276.  
  277.  
  278. Neil Walker.
  279. 16, Finderne Drive.
  280. Wymondham.
  281. Norfolk.
  282. NR18 0HU.
  283.  
  284.  
  285. Legal Notice
  286. ------------
  287. This program is supplied 'as is'. I therefore cannot be held responsible
  288. for any loss of data, profits or any other loss, either directly or
  289. indirectly, that may be incurred by the use (or misuse) of this software,
  290. even if I am aware of the possibility of such a loss. However, I can assure
  291. you that in its original state, the program contains no deliberate viruses,
  292. or damaging procedures, except where these are necessary for the fulfilment
  293. of the program's function.