home *** CD-ROM | disk | FTP | other *** search
/ Kosovo Orphans' Appeal Charity CD / KosovoOrphansAppeal.iso / archimedesworld_cd2 / programming / recorderrors / _help < prev    next >
Text File  |  1996-04-12  |  4KB  |  122 lines
  1.                                   RecordErrors
  2.                                   ============
  3.  
  4. Version 1.06 (17 Mar 1996)
  5.      
  6. Introduction
  7. ------------
  8.    Robin Abecasis asked me, sometime ago now, to write a module which could
  9. tell him all the errors which had occured whilst he had not been with the
  10. bulletin board he runs. If an error occurs on the bulletin board a box
  11. usually appears with OK on it. And this stops everything dead.
  12.    Fortunately, somebody thought of this and wrote the NoError module. This
  13. will click on the OK button after about 5 seconds and the BBS can continue.
  14. Unfortunately if you aren't there you can't see what the error was. And if
  15. you were there, there would be no need for NoError.
  16.    So here comes RecErrors, a program which will log all these errors into a
  17. file so that you can see what has happened.
  18.  
  19.  
  20. Usage
  21. -----
  22.    Run the !Create file. That's it.
  23.    Hopefully, the code will be assembled with no errors and all that in
  24. future will be required is the running of the !Run code file.
  25.    To set the filename of the log file alter the !Run file, or set the
  26. variable RecordErrors$File to point somewhere useful.
  27.  
  28.     
  29. How it works
  30. ------------
  31.    The module uses the WimpSWIVe module by Andrew Clover of Doggysoft. This
  32. allows modules to easily patch calls to the Wimp SWI base, and allows
  33. RecErrors to get in on all calls to ReportError and to send the information
  34. into a file for looking at. The file is opened only when needed, so it is
  35. perfectly safe to do silly things like *Close and other pointless things. The
  36. file also has it's type set after each error.
  37.  
  38.  
  39. Disclaimer
  40. ----------
  41.   The author accepts no responsibility for any problems which this
  42. application may cause or loss of data resulting in its use. This application
  43. is Public Domain. This means that it may be distributed, so long as no charge
  44. other than copying costs are charged for it.
  45.  
  46.  
  47. Bugs
  48. ----
  49. Å Do not give silly filenames to RecordErrors$File, it shouldn't cause any
  50.   problems, but I wouldn't count on it.
  51.   
  52.  
  53. Source code
  54. -----------
  55.    This program requires the !JFPatch pre-assembler to make the code. This is
  56. a simple text-to-basic assembler which takes a text assembler file, makes a
  57. basic program from it to assemble, assembles it and returns any errors.
  58. Currently, it is under development and requires a lot of work before it will
  59. be released in any form. As such, the patch file is mostly useless, but must
  60. be distributed with the resultant module.
  61.    All source code an the resultant module must be distributed together.
  62.  
  63.  
  64. WimpSWIVe
  65. ---------
  66.    This program require WimpSWIve (v0.05) to be installed before it will run
  67. correctly. It provides easy access to filtering Wimp calls other than
  68. Wimp_Poll (provided by FilterManager) and is provided with NewerLook (which
  69. is ok, but takes a bit of getting used to).
  70.    The WimpSWIVe module is ⌐ Andrew Clover, and if copied should be copied
  71. with the documentation which is provided. Refer to the file WSWI-Help for
  72. more details.
  73.  
  74.  
  75. Contact
  76. -------
  77. Any comments, queries, donations or bug reports can be sent to :
  78.  
  79. Fido   : Justin Fletcher at 2:255/116.3
  80. E-Mail : Gerph@essex.ac.uk
  81. URL    : http://prompt.essex.ac.uk/users/jrflet
  82. IRC    : On #Acorn as Gerph
  83. Finger : finger jrflet@postman.essex.ac.uk
  84. Tel    : (01842) 813979 (Home)
  85.        : (01206) 873119 (Uni)
  86.  
  87. Snail Mail :
  88.     Justin Fletcher
  89.     öGaladrielò
  90.     17b Cromwell Road,
  91.     Weeting,
  92.     Brandon,
  93.     Suffolk.
  94.     IP27 0QT
  95.  
  96. Uni address : (year 1995/6 only)
  97.     Eddington Tower,
  98.     Flat 9/5,
  99.     University of Essex,
  100.     Wivenhoe Park,
  101.     Colchester.
  102.     CO4 3SQ
  103.  
  104.  
  105. History
  106. -------
  107. Version 1.00 : 23 Apr 1995
  108.                Basic module written for WimpSWIVe.
  109. Version 1.01 : 24 Apr 1995 
  110.                Improved to handle no file / error from message
  111. Version 1.02 : 24 Apr 1995
  112.                Checks bit 5 for transient error boxes.
  113.                28 Apr 1995 - Sent to Arcade
  114. Version 1.03 : 14 May 1995
  115.                Error copied to workspace to fix bug with filecore.
  116. Version 1.04 : 14 May 1995
  117.                Option to include users name in log file.
  118. Version 1.05 : 21 Jun 1995
  119.                Internals modified in JFPatch code.
  120. Version 1.06 : 17 Mar 1996
  121.                Option to include date added 'officially'.
  122.                Release to Ouijaboard.