home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / j / jfs_std / !JFShared / !Help < prev    next >
Encoding:
Text File  |  1996-10-17  |  12.2 KB  |  270 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.AreaLib            For use with Fletcher family 6 user system
  20.    BasicLib.ForceLib           Various Keystroke style facilities (unsupported)
  21.    BasicLib.PBSLibrary         JF's Pin Board Server library
  22.    BasicLib.TestLib            For testing of programs
  23.    BasicLib.WimpLib            Main Wimp applications library (RO3)
  24.    BasicLib.WimpLib2           Main Wimp applications library (RO2)
  25.    BasicLib.HeapLib            Management of heap blocks in application space
  26.    BasicLib.EconetLib          Simple Econet handling routines
  27.    BasicLib.CGILibrary         A CGI Library
  28.    Help.*                      StrongHelp manuals for the various libraries
  29.    Skeleton.Message.*          Skeleton Wimp application using MessageTrans
  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. The !Boot file should automatically select WimpLib or WimpLib2 depending on
  42. the version of UtilityModule, however some applications may require editing
  43. in their !RunImage file.
  44.  
  45. The line which will need editing is in PROCinitwimp. Find the line with
  46. Wimp_Initialise on it (in PROCinitwimp) and change the 310 to 200.
  47.  
  48. MessageTrans applications will need the MsgTrans module loading on RO2 before
  49. they will work.
  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. AreaLibrary$File       Controls the Fletcher 6 user system status files
  61. PBServerLibrary$File   Interface to the PinboardServer protocol
  62. ForceLibrary$File      ForceLib (of no use at present)
  63. JFExtEdit$File         External Edit protocol interface library
  64. JFEconetLibrary$File   Econet SWI interface library
  65. TestLibrary$File       For testing purposes only
  66. HeapLibrary$File       Heap management library
  67. BasicLibrary$File      Pointer to WimpLib or WimpLib2
  68. CGILibrary$File        CGI Library
  69.  
  70.  
  71.  
  72. History
  73. -------
  74. Version 1.00 : Unreleased program used internally.
  75. Version 2.00 : Released to Arcade in form of !JFShared and !Install
  76. Version 2.01 : 04 Mar 1995 - Release to Arcade
  77.                Minor bug fixes to WimpLib and WimpLib2
  78. Version 2.02 : 11 Mar 1995
  79.                WimpLib 1.40 : Extra features for menus
  80.                Fixed !Run file to stop running out of stack
  81. Version 2.03 : 25 Mar 1995
  82.                Added support for ForceLib in form of ForceLibrary$File
  83.                ForceLib : Added PROCinitforce
  84. Version 2.04 : 27 Mar 1995
  85.                WimpLib 1.41 : Added FNsubstvars
  86. Version 2.05 : 30 Mar 1995
  87.                WimpLib 1.42 : Added support for status files
  88. Version 2.06 : 02 Apr 1995
  89.                WimpLib 1.43 : Added FNgstrans function
  90.                               Reorganised structure into groups
  91.                               Added REM help messages for most routines
  92.                               Corrected mistake in CreateIconBarIcon which
  93.                                 did not fill the icon
  94. Version 2.07 : 02 May 1995
  95.                WimpLib 1.44 : Added FNsubstvarsp for prefixed vars
  96. Version 2.08 : 04 Jun 1995
  97.                WimpLib 1.45 : Many alterations to FNsubstvars to cope with
  98.                                 errors.
  99.                               Almost everything can now take Message file
  100.                                 input.
  101. Version 2.09 : 07 Jun 1995
  102.                WimpLib 1.45 : Version for RO2 created correctly.
  103. Version 2.10 : 08 Jun 1995
  104.                Application  : Recognises RO2 and sets BasicLibrary$File
  105.                                 correctly.
  106. Version 2.11 : 14 Jun 1995
  107.                WimpLib 1.46 : Fixed bug in FNsubstvars which didn't claim
  108.                                 error handler as local.
  109. Version 2.12 : 15 Jun 1995
  110.                TestLib 2.00 : Version number given and data logging to
  111.                                 <Wimp$Scrap> added.
  112.                               Renamed variable from <Test$Lib> to
  113.                                 <TestLibrary$File>.
  114.                ExtEditLib 1.00 : Written in basic form.
  115. Version 2.13 : 28 Jun 1995
  116.                ExtEditLib 1.01 : Revised to be slightly easier to use.
  117. Version 2.14 : 30 Jun 1995
  118.                WimpLib 1.47 : Fixed bug in PROCreadhelp for menus
  119.                WimpLib2 1.46: Fixed bug in PROCwinsetextent for bit 0 setting
  120.                AreaLib 2.00 : Given version.
  121. Version 2.15 : 04 Jul 1995
  122.                ExtEditLib 1.02 : Editor support added
  123.                ExtEditLib 1.03 : Many bug fixes for editor section
  124. Version 2.16 : 18 Aug 1995
  125.                WimpLib 1.49 : Bug fix for FNLongfilename
  126. Version 2.17 : 25 Aug 1995
  127.                WimpLib 1.50 : CreateIconBarIcon changed to not filling icons
  128.                                 to fix display problem when marbling.
  129. Version 2.18 : 25 Aug 1995
  130.                ShowError 1.00 : Moved within structure.
  131.                Help structure added
  132.                Help.WimpLib 1.00 : Copied from StongHelp
  133. Version 2.19 : 26 Aug 1995
  134.                WimpLib 1.51 : redrawicon modified to use ForceRedraw.
  135.                               seticontext and seticonvalid check for same.
  136.                WimpLib2 1.47 : Changes made in WimpLib transfered, pressicon
  137.                                added.
  138.                WimpLib 1.52 : PROCshowfree added to display free space
  139.                Skeleton : Modified Template to cope with showfree.
  140.                Skeleton : Set mask null polls bit
  141. Version 2.20 : 28 Aug 1995
  142.                HeapLib 1.00 : Written and incorporated into JFShared.
  143. Version 2.21 : 29 Aug 1995
  144.                HeapLib 1.01 : lock and unlock of blocks added.
  145. Version 2.22 : 01 Sep 1995
  146.                WimpLib 1.53 : windowtitle modified to update only if changed
  147.                                and redraw only title bar (correctly, unlike
  148.                                FormEd or TemplEd !)
  149.                Help.HeapLib : Written.
  150.                Help.WimpLib : Updated.
  151.                Help.ExtEditLib : Written.
  152.                ExtEditLib 1.04 : modifications to use client FNedit_saverq.
  153. Version 2.23 : 11 Sep 1995
  154.                HeapLib 1.02 : PROCheap_reduce added for not reloc blocks
  155.                WimpLib 1.54 : FNfiletype modified, and FNbasetype added.
  156.                               May mean modification required.
  157.                               FNmenuuntick now allows end of menu.
  158.                               Fix to FNwindowtask to not bother tasks.
  159.                               FNfindtask added.
  160.                               PROCstatusflag and FNstatusgetflag added.
  161.                WimpLib2 1.48 : FNfiletype and FNbasetype modified.
  162.                               FNmenuuntick changed.
  163.                               Fix to FNwindowtask.
  164.                               FNfindtask added.
  165.                               FNtaskname returns Unknown.
  166.                               PROCwindowtitle modified.
  167.                Help.WimpLib : Updated
  168.                Help.HeapLib : Updated
  169.                Help.ExtEditLib : Updated
  170.  
  171. Version 2.24 : 23 Sep 1995
  172.                !Boot : JFPatch files give error if JFPatch not known.
  173.                WimpLib 1.55 : FNfiletype and FNbase type modified to not give
  174.                               error if bad filename.
  175.                               PROCeerror for External errors in non-wimp
  176.                               programs.
  177.                WimpLib2 1.49 : Ditto
  178.                Help.WimpLib : Updated
  179.                Help.HeapLib : Updated
  180.                Help.ExtEditLib : Updated
  181.  
  182. Version 2.25 : 30 Oct 1995
  183.                WimpLib2 1.50 : Modifications to FNcreateicon to bring in line
  184.                                with WimpLib.
  185.  
  186. Version 2.26 : 15 Apr 1996
  187.                WimpLib 1.56 : FNstring0 passed null will return null
  188.                WimpLib2 1.51 : ditto
  189.                InstallJF 1.02 : Now in a handy desktop application :-)
  190.                Help.WimpLib : Updated
  191.                Help.HeapLib : Updated
  192.                Help.ExtEditLib : Updated
  193.  
  194. Version 2.27 : 17 Apr 1996
  195.                Application updated to use version number of library.
  196.                Skeleton : checks the version number
  197.  
  198. Version 2.28 : 23 May 1996
  199.                WimpLib2 1.52 : Various fixes and changes - works now !
  200.                EconetLib 1.00 : Added (very rudimentary)
  201.                Help.* : Updated
  202.                Help.EconetLib : Added
  203.  
  204. Version 2.29 : 05 Jun 1996
  205.                CGILibrary 1.00 : Incorporated into JFShared
  206.                WimpLib 1.56  : Added PROCdragsave
  207.                WimpLib2 1.53 : ditto
  208.                Help.* : Updated
  209.                Help.CGILibrary : Added
  210.  
  211. Version 2.30 : 08 Aug 1996
  212.                TestLib 2.01 : Bug in creating log file fixed
  213.                SocketLib 1.00 : Written and added.
  214.                WimpLib 1.58 : Added PROCresizewinto, M option for menus
  215.                WimpLib2 1.54 : Ditto
  216.                Help.* : Updated
  217.                Help.SocketLib : Added
  218.  
  219. Version 2.31 : 10 Aug 1996
  220.                SocketLib 1.01 : Fixed memory release bug
  221.                SocketLib 1.02 : Fixed many bugs - Thanks to Dave Thomas
  222.  
  223. Version 2.32 : 21 Aug 1996
  224.                WimpLib 1.59 : Fixed menu heights at Daves request
  225.                               resizewinto code fixed so that it works !
  226.                WimpLib2 1.55 : Ditto
  227.  
  228. Version 2.33 : 23 Aug 1996
  229.                WimpLib 1.60 : Added support for keystrokes on menus in
  230.                               createmenu, decodemenu and the menu help.
  231.                WimpLib2 1.56 : Ditto
  232.                Help.WimpLib : Updated
  233.                WimpLib 1.61 : Changed PROCseticontext to just update icon,
  234.                               not force a redraw (undo of 2.19!) use Needs
  235.                               Help if things don't redraw properly.
  236.                WimpLib2 1.57 : Ditto
  237.  
  238. Version 2.34 : 31 Aug 1996
  239.                WimpLib 1.62 : Thoughtlessness in FNmsgtoken meant that
  240.                               I couldn't pass filenames as parameters - fixed
  241.                WimpLib2 1.58 : Ditto
  242.                Help.WimpLib : Updated.
  243.  
  244. Version 2.35 : 27 Sep 1996
  245.                SocketLib 1.03 : Modified service routines to use my IServices
  246.                                 module.
  247.                WimpLib 1.63 : Resized iconbar icon to the size used by the
  248.                               network icon
  249.                WimpLib2 1.59 : Ditto
  250.                Help.WimpLib : Updated
  251.  
  252. Version 2.36 : 30 Sep 1996
  253.                WimpLib 1.64 : Added facility to create iconbar icons with
  254.                               priorities.
  255.                WimpLib2 1.60 : Removed priority comments and added code to
  256.                                emulate extended positions.
  257.  
  258. Version 2.37 : 15 Oct 1996
  259.                HeapLib 1.03 : Fixed Heap_Garbage so that it actually works;
  260.                               previously it had been attempting to move locked
  261.                               blocks.
  262.  
  263. Version 2.38 : 17 Oct 1996
  264.                IServices 1.04 : Placed in the JFShared directory.
  265.                Released in two forms - the standard and aol releases.
  266.                AOL is simply the standard version with a prettier install
  267.                program.
  268.                WimpLib 1.65 : Fixed bug in MsgToken from v1.61
  269.                WimpLib2 1.61 : Ditto
  270.