home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / hensa / documentation / swis_2 / SWIs / ReadMe < prev    next >
Text File  |  1997-10-10  |  3KB  |  68 lines
  1.              Release note for the 'SWIs package' (10 Oct 1997)
  2.              =================================================
  3.  
  4. Since mid-January this year, in between my other projects, I've been working
  5. to seperate the SWIs manual into seperate parts which might be more easily
  6. updated and managed. This process, although it may have seemed simple has
  7. taken longer than I intended for a number of reasons (standardisation,
  8. updates and other things getting in the way). However, this release - the
  9. first in this form - should cover a much larger range of the operating system
  10. and support modules than previously and in a more regular fashion.
  11.  
  12. From what was the SWIs manual there is now :
  13.   OS       v3.00 - most of the Operating System
  14.   Wimp     v1.01 - the desktop side of the Operating System
  15.   MiscSWIs v1.00 - support and softloadable modules
  16.   InetSWIs v1.00 - the Internet SWI calls (OS and 3rd party)
  17.   TBSWIs   v0.01 - the Toolbox SWIs                        (Not included)
  18.  
  19. In addition to these, a new manual has been created from others and textual
  20. documentation :
  21.   Inet     v1.03 - The Socket SWIs, constants and other related things
  22.  
  23. There are a number of things that need addressing yet, foremost of which is
  24. obbiously updating the manuals to include every form of call available. Of
  25. the other concerns :
  26.   • The Wimp manual needs more standardisation applying to it
  27.   • The MiscSWIs manual requires tidying
  28.   • InetSWIs needs massively updating
  29.   • TBSWIs needs /really/ sorting out !
  30.  
  31. For this release (as with all others), I have checked the manuals using
  32. StrongTxt and cleaned them using CleanHlp. As such I am aware of the broken
  33. links due to pages being absent - please don't mail me about these. These
  34. links remain broken for two reasons:
  35.   1) they'll work when I add them
  36.   2) they're constant 'brokenness' reminds me to write them up at some point.
  37.  
  38.  
  39. New things
  40. ----------
  41. Of the new things you can expect to see in these manuals, the things that
  42. immediately spring to mind are :
  43.   • Conversion help; most of the OS_Convert<x># calls now have individual
  44.     pages.
  45.   • Some ImageEntry and FSEntry documentation
  46.   • Nested Wimp calls documentation (by experimentation and disassembly - I'm
  47.     still waiting for some docs from Acorn).
  48.   • More Risc OS 3.5-3.7 documentation; Only having an A5000 this will be
  49.     slow to change, but I hope to keep Risc OS 3.6 as my base reference for
  50.     future releases.
  51.   • A few more services and vectors documented.
  52.   • SpriteOp calls documented in both hex and decimal (at last!)
  53.  
  54.  
  55. Submissions
  56. -----------
  57. Please, please, please send me submissions ! I can count the number of
  58. submissions I've received on the fingers of one hand... hang on, no, I can
  59. count them on the number of arms I have ! If you have made changes to the
  60. manual, please send me the changes, even if it's just one page. I don't mind
  61. receiving complete manuals, but I'd prefer a manual of the changes made, or
  62. individual pages. In the case of anyone mad enough to be doing the same as
  63. myself and changing great swathes of the pages, the entire manual would be
  64. appropriate (I'll run it through CompareDr and hope!).
  65.  
  66. Submissions, as with everything else can be sent to <gerph@innocent.com>, and
  67. any size is acceptable.
  68.