home *** CD-ROM | disk | FTP | other *** search
/ Acorn User 10 / AU_CD10.iso / Archived / Games / PD_Games / overcast.arc / !JFShared / !Help < prev    next >
Text File  |  1997-10-10  |  17KB  |  371 lines
  1.                                 !JFShared
  2.                                 =========
  3.  
  4. Why ?
  5. =====
  6.   The !JFShared directory contains resources for use with any of Justin
  7. Fletcher's programs. These mainly include Basic libraries which are used in
  8. many of his programs. The idea behind this is that like the C DeskLib, these
  9. libraries provide a simple way to write a Wimp program. To paraphrase
  10. Doggysoft's WimpExtension, it hopes to make you think "it's a program to..."
  11. rather than "Oh, God. It's a Desktop program to..."
  12.   (WimpExtension is not required, and although a nice module, almost all of
  13. it's functionality is built into these libraries. Same goes for Interface)
  14.  
  15.  
  16. Files :
  17. -------
  18. These are the files in the JFShared resource :
  19.    BasicLib.TestLib            For testing of programs
  20.    BasicLib.WimpLib            Main Wimp applications library (RO3)
  21.    BasicLib.DynMenu            A dynamic menu handling library
  22.    BasicLib.HeapLib            Management of heap blocks in application space
  23.    BasicLib.EconetLib          Simple Econet handling routines
  24.    BasicLib.DispLib            Display library (system font only)
  25.    BasicLib.CGILibrary         A CGI Library
  26.    Help.*                      StrongHelp manuals for the various libraries
  27.    Skeleton.Standard.*         Skeleton Wimp application using MessageTrans
  28.    Skeleton.ArcWeb.*           Ditto, but using the ArcWeb protocol to fetch 
  29.                                web pages.
  30.    Skeleton.Squashed.*         Files required by BasCompress to compress the
  31.                                applications
  32.    !ShowError                  Application which will display the error and
  33.                                line of errors in WimpLib based applications.
  34.    IServices                   A module which needs to be placed in
  35.                                System:Modules.Network - this is done
  36.                                automatically by InstallJF.
  37.  
  38.  
  39. Usage on RiscOS 2 and RO3.00
  40. ============================
  41. This version of JFShared is not supplied with versions of WimpLib which will
  42. work on RiscOS 3.00 or lower. I'm currently supporting Risc OS 3.10 as a
  43. minimum, RiscOS 3.8 as a maximum.
  44.  
  45. Usage on RiscOS 3.5, 3.6 and 3.7
  46. ================================
  47. I do not have this version of Risc OS to test JFShared with, but am aware
  48. that many users have found no problems except with early versions of the
  49. installer. Comments are greatfully appreciated
  50.  
  51.  
  52. System Variables
  53. ================
  54. The libraries which are in common usage are pointed to by various system
  55. variables. If a library, or other resource within the JFShared application,
  56. needs to be accessed (other than those with pointers) they should be
  57. referenced by JFShared:BasicLib.<library name> or what ever.
  58.  
  59. The actual variables are :
  60. JFExtEdit$File         External Edit protocol interface library
  61. JFEconetLibrary$File   Econet SWI interface library
  62. TestLibrary$File       For testing purposes only
  63. HeapLibrary$File       Heap management library
  64. BasicLibrary$File      Pointer to WimpLib
  65. CGILibrary$File        CGI Library
  66. DynMenuLibrary$File    Dynamic Menu library
  67. DispLibrary$File       Display library
  68.  
  69. History
  70. -------
  71. Version 1.00 : Unreleased program used internally.
  72. Version 2.00 : Released to Arcade in form of !JFShared and !Install
  73. Version 2.01 : 04 Mar 1995 - Release to Arcade
  74.                Minor bug fixes to WimpLib and WimpLib2
  75. Version 2.02 : 11 Mar 1995
  76.                WimpLib 1.40 : Extra features for menus
  77.                Fixed !Run file to stop running out of stack
  78. Version 2.03 : 25 Mar 1995
  79.                Added support for ForceLib in form of ForceLibrary$File
  80.                ForceLib : Added PROCinitforce
  81. Version 2.04 : 27 Mar 1995
  82.                WimpLib 1.41 : Added FNsubstvars
  83. Version 2.05 : 30 Mar 1995
  84.                WimpLib 1.42 : Added support for status files
  85. Version 2.06 : 02 Apr 1995
  86.                WimpLib 1.43 : Added FNgstrans function
  87.                               Reorganised structure into groups
  88.                               Added REM help messages for most routines
  89.                               Corrected mistake in CreateIconBarIcon which
  90.                                 did not fill the icon
  91. Version 2.07 : 02 May 1995
  92.                WimpLib 1.44 : Added FNsubstvarsp for prefixed vars
  93. Version 2.08 : 04 Jun 1995
  94.                WimpLib 1.45 : Many alterations to FNsubstvars to cope with
  95.                                 errors.
  96.                               Almost everything can now take Message file
  97.                                 input.
  98. Version 2.09 : 07 Jun 1995
  99.                WimpLib 1.45 : Version for RO2 created correctly.
  100. Version 2.10 : 08 Jun 1995
  101.                Application  : Recognises RO2 and sets BasicLibrary$File
  102.                                 correctly.
  103. Version 2.11 : 14 Jun 1995
  104.                WimpLib 1.46 : Fixed bug in FNsubstvars which didn't claim
  105.                                 error handler as local.
  106. Version 2.12 : 15 Jun 1995
  107.                TestLib 2.00 : Version number given and data logging to
  108.                                 <Wimp$Scrap> added.
  109.                               Renamed variable from <Test$Lib> to
  110.                                 <TestLibrary$File>.
  111.                ExtEditLib 1.00 : Written in basic form.
  112. Version 2.13 : 28 Jun 1995
  113.                ExtEditLib 1.01 : Revised to be slightly easier to use.
  114. Version 2.14 : 30 Jun 1995
  115.                WimpLib 1.47 : Fixed bug in PROCreadhelp for menus
  116.                WimpLib2 1.46: Fixed bug in PROCwinsetextent for bit 0 setting
  117.                AreaLib 2.00 : Given version.
  118. Version 2.15 : 04 Jul 1995
  119.                ExtEditLib 1.02 : Editor support added
  120.                ExtEditLib 1.03 : Many bug fixes for editor section
  121. Version 2.16 : 18 Aug 1995
  122.                WimpLib 1.49 : Bug fix for FNLongfilename
  123. Version 2.17 : 25 Aug 1995
  124.                WimpLib 1.50 : CreateIconBarIcon changed to not filling icons
  125.                                 to fix display problem when marbling.
  126.  
  127. Version 2.18 : 25 Aug 1995
  128.                ShowError 1.00 : Moved within structure.
  129.                Help structure added
  130.                Help.WimpLib 1.00 : Copied from StongHelp
  131.  
  132. Version 2.19 : 26 Aug 1995
  133.                WimpLib 1.51 : redrawicon modified to use ForceRedraw.
  134.                               seticontext and seticonvalid check for same.
  135.                WimpLib2 1.47 : Changes made in WimpLib transfered, pressicon
  136.                                added.
  137.                WimpLib 1.52 : PROCshowfree added to display free space
  138.                Skeleton : Modified Template to cope with showfree.
  139.                Skeleton : Set mask null polls bit
  140.  
  141. Version 2.20 : 28 Aug 1995
  142.                HeapLib 1.00 : Written and incorporated into JFShared.
  143.  
  144. Version 2.21 : 29 Aug 1995
  145.                HeapLib 1.01 : lock and unlock of blocks added.
  146.  
  147. Version 2.22 : 01 Sep 1995
  148.                WimpLib 1.53 : windowtitle modified to update only if changed
  149.                                and redraw only title bar (correctly, unlike
  150.                                FormEd or TemplEd !)
  151.                Help.HeapLib : Written.
  152.                Help.WimpLib : Updated.
  153.                Help.ExtEditLib : Written.
  154.                ExtEditLib 1.04 : modifications to use client FNedit_saverq.
  155.  
  156. Version 2.23 : 11 Sep 1995
  157.                HeapLib 1.02 : PROCheap_reduce added for not reloc blocks
  158.                WimpLib 1.54 : FNfiletype modified, and FNbasetype added.
  159.                               May mean modification required.
  160.                               FNmenuuntick now allows end of menu.
  161.                               Fix to FNwindowtask to not bother tasks.
  162.                               FNfindtask added.
  163.                               PROCstatusflag and FNstatusgetflag added.
  164.                WimpLib2 1.48 : FNfiletype and FNbasetype modified.
  165.                               FNmenuuntick changed.
  166.                               Fix to FNwindowtask.
  167.                               FNfindtask added.
  168.                               FNtaskname returns Unknown.
  169.                               PROCwindowtitle modified.
  170.                Help.WimpLib : Updated
  171.                Help.HeapLib : Updated
  172.                Help.ExtEditLib : Updated
  173.  
  174. Version 2.24 : 23 Sep 1995
  175.                !Boot : JFPatch files give error if JFPatch not known.
  176.                WimpLib 1.55 : FNfiletype and FNbase type modified to not give
  177.                               error if bad filename.
  178.                               PROCeerror for External errors in non-wimp
  179.                               programs.
  180.                WimpLib2 1.49 : Ditto
  181.                Help.WimpLib : Updated
  182.                Help.HeapLib : Updated
  183.                Help.ExtEditLib : Updated
  184.  
  185. Version 2.25 : 30 Oct 1995
  186.                WimpLib2 1.50 : Modifications to FNcreateicon to bring in line
  187.                                with WimpLib.
  188.  
  189. Version 2.26 : 15 Apr 1996
  190.                WimpLib 1.56 : FNstring0 passed null will return null
  191.                WimpLib2 1.51 : ditto
  192.                InstallJF 1.02 : Now in a handy desktop application :-)
  193.                Help.WimpLib : Updated
  194.                Help.HeapLib : Updated
  195.                Help.ExtEditLib : Updated
  196.  
  197. Version 2.27 : 17 Apr 1996
  198.                Application updated to use version number of library.
  199.                Skeleton : checks the version number
  200.  
  201. Version 2.28 : 23 May 1996
  202.                WimpLib2 1.52 : Various fixes and changes - works now !
  203.                EconetLib 1.00 : Added (very rudimentary)
  204.                Help.* : Updated
  205.                Help.EconetLib : Added
  206.  
  207. Version 2.29 : 05 Jun 1996
  208.                CGILibrary 1.00 : Incorporated into JFShared
  209.                WimpLib 1.56  : Added PROCdragsave
  210.                WimpLib2 1.53 : ditto
  211.                Help.* : Updated
  212.                Help.CGILibrary : Added
  213.  
  214. Version 2.30 : 08 Aug 1996
  215.                TestLib 2.01 : Bug in creating log file fixed
  216.                SocketLib 1.00 : Written and added.
  217.                WimpLib 1.58 : Added PROCresizewinto, M option for menus
  218.                WimpLib2 1.54 : Ditto
  219.                Help.* : Updated
  220.                Help.SocketLib : Added
  221.  
  222. Version 2.31 : 10 Aug 1996
  223.                SocketLib 1.01 : Fixed memory release bug
  224.                SocketLib 1.02 : Fixed many bugs - Thanks to Dave Thomas
  225.  
  226. Version 2.32 : 21 Aug 1996
  227.                WimpLib 1.59 : Fixed menu heights at Daves request
  228.                               resizewinto code fixed so that it works !
  229.                WimpLib2 1.55 : Ditto
  230.  
  231. Version 2.33 : 23 Aug 1996
  232.                WimpLib 1.60 : Added support for keystrokes on menus in
  233.                               createmenu, decodemenu and the menu help.
  234.                WimpLib2 1.56 : Ditto
  235.                Help.WimpLib : Updated
  236.                WimpLib 1.61 : Changed PROCseticontext to just update icon,
  237.                               not force a redraw (undo of 2.19!) use Needs
  238.                               Help if things don't redraw properly.
  239.                WimpLib2 1.57 : Ditto
  240.  
  241. Version 2.34 : 31 Aug 1996
  242.                WimpLib 1.62 : Thoughtlessness in FNmsgtoken meant that
  243.                               I couldn't pass filenames as parameters - fixed
  244.                WimpLib2 1.58 : Ditto
  245.                Help.WimpLib : Updated.
  246.  
  247. Version 2.35 : 27 Sep 1996
  248.                SocketLib 1.03 : Modified service routines to use my IServices
  249.                                 module.
  250.                WimpLib 1.63 : Resized iconbar icon to the size used by the
  251.                               network icon
  252.                WimpLib2 1.59 : Ditto
  253.                Help.WimpLib : Updated
  254.  
  255. Version 2.36 : 30 Sep 1996
  256.                WimpLib 1.64 : Added facility to create iconbar icons with
  257.                               priorities.
  258.                WimpLib2 1.60 : Removed priority comments and added code to
  259.                                emulate extended positions.
  260.  
  261. Version 2.37 : 15 Oct 1996
  262.                HeapLib 1.03 : Fixed Heap_Garbage so that it actually works;
  263.                               previously it had been attempting to move locked
  264.                               blocks.
  265.  
  266. Version 2.38 : 17 Oct 1996
  267.                IServices 1.04 : Placed in the JFShared directory.
  268.                Released in two forms - the standard and aol releases.
  269.                AOL is simply the standard version with a prettier install
  270.                program.
  271.                WimpLib 1.65 : Fixed bug in MsgToken from v1.61
  272.                WimpLib2 1.61 : Ditto
  273.  
  274. Version 2.39 : 22 Nov 1996
  275.                SocketLib 1.04 : RMEnsure's InetServices now.
  276.  
  277. Version 2.40 : 23 Nov 1996
  278.                WimpLib 1.66 : Added F11 to the keystroke list, why did I
  279.                               forget that ?
  280.                DynMenu 1.00 : Added to the libraries.
  281.  
  282. Version 2.41 : 14 Dec 1996
  283.                WimpLib 1.67 : Found a way of resizing windows without causing
  284.                               them to redraw the space they would have occupied
  285.                Skeleton : Support for web links to the pages in the template
  286.                           file.
  287.                InetServices 1.07 : Included
  288.                HeapLib 1.04 : Added FNstrdup.
  289.  
  290. Version 2.42 : 25 Jan 1997
  291.                WimpLib 1.68 : Minor change to PROCeerror to stop progs looking
  292.                               silly when displaying Appname$
  293.                WimpLib 1.62 : Ditto
  294.                SocketLib 1.05 : Minor changes to allow BasCompress to squash
  295.                                 it.
  296.                Skeleton : Modifications for BasCompress - new init% variable
  297.                           introduced for 'error handling' (!) and RESTORE <x>
  298.                           removed.
  299.  
  300. Version 2.43 : 29 Jan 1997
  301.                AreaLib : removed.
  302.                CGILib-LTP : removed.
  303.                PBSLibrary : removed.
  304.                ForceLib : removed.
  305.                Help.* : Updated with some of the 'new' changes.
  306.                Skeleton.Message : renamed to Skeleton.Standard and made to use
  307.                                   the URI protocol. handle renamed to
  308.                                   taskhandle.
  309.                Skeleton.ArcWeb : created for 'just in case'.
  310.                Squashed.Compress : copied from IRServer to allow compression
  311.                                    without loss of variable or routine names.
  312.                Squashed.CompressVF : created to allow compression including
  313.                                      the use of special files.
  314.                SocketLib 1.06 : Added many updates from Reuben Thomas to allow
  315.                                 multitasking connects and lookups.
  316.  
  317. Version 2.44 : 05 Feb 1997
  318.                SocketLib 1.07 : Fixed use of THEN=<x> ELSE=<x> so that
  319.                                 BasCompress likes it.
  320.  
  321. Version 2.45 : 23 Feb 1997
  322.                SocketLib 1.08 : Added logging calls
  323.  
  324. Version 2.46 : 14 Mar 1997
  325.                WimpLib 1.69 : Modified CreateIconBarIcon to resize to the
  326.                               sprite.
  327.                Skeleton.*.!RunImage : Added the PROCloadfile erroneously
  328.                                       removed :-(
  329.                SocketLib 1.09 : Fixed FNsocket_eof and modified PROCsocket_close
  330.                                 to ignore <0 sockets
  331.                                 FNsocket_connected and FNinet_decodeerror
  332.                                 written to fill some gaps.
  333.                WimpLib 1.70 : Made FNcreatemenu put the right length into icons
  334.  
  335. Version 2.47 : 20 May 1997
  336.                DynMenu 1.01 : Added check for 0 as restore handle safely
  337.                DispLib 1.02 : Added to JFShared (still under development)
  338.  
  339. Version 2.48 : 30 May 1997
  340.                WimpLib 1.71 : Now allows attaching of child windows :-)
  341.                WimpLib2 : removed. Anyone who requires a copy should contact
  342.                           me. I'm no longer supporting this.
  343.                ISvcs.* : Added for those people who enjoy C code as well,
  344.                          along with the documentation for it.
  345.                Help.WimpLib : Updated
  346.  
  347. Version 2.49 : 06 Jun 1997
  348.                DispLib 1.04 : Added handling for adding lines mid-way, opening
  349.                               windows with a little more control and reading
  350.                               the co-ordinates of an entry.
  351.                WimpLib 1.72 : Embedding child windows can now use window
  352.                               flags
  353.                SocketLib 1.10 : Fixed bug in SocketLib which prevented you
  354.                                 from ports > 65535 (now performs an AND).
  355.                DispLib 1.05 : Can read line, open windows, resize and add lines
  356.                               mid-way now. Colour works.
  357.                WimpLib 1.73 : PROCseticontext will now move the cursor if is
  358.                               in the same icon.
  359.                DispLib 1.06 : Minimum width and natural height added.
  360.                SocketLib 1.11 : Fixed bug in buffer_getrest which looped
  361.                                 infinitely.
  362.                DynMenuLib 1.02 : Menu titles may now be indirected
  363.                DynMenuLib 1.03 : Allowed modifying of the last items flags
  364.                ExtExitLib 1.05 : Minor change to work with BasCompress
  365.  
  366. Version 2.50 : 10 Sep 1997 (released to HENSA/FreeNet)
  367.                WimpLib 1.74 : PROCnotemessage didn't work. At all. Ever. Can
  368.                               you believe it ? (!)
  369.                SocketLib 1.12 : Added '0' as a port number to generate one in
  370.                                 FNfindlisten.
  371.