home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Archives / ARexxTools / arxced27.lha / arxced / arx_help.readme < prev   
Encoding:
Text File  |  1996-01-02  |  3.5 KB  |  91 lines

  1.  
  2.     arx_help.ced 2.7 - by Rolf Rotvel
  3.  
  4.     DESCRIPTION
  5.     ArexxGuide online help for CED 3.5.
  6.  
  7.     Press a key and the script will search ArexxGuide for the node
  8.     corresponding to the word under the cursor, convert it to ascii, and
  9.     loads it into CED.
  10.  
  11.     Optional saving of ascii nodes for much faster loading next time you
  12.     need the information.
  13.  
  14.     REQUIREMENTS
  15.     ArexxGuide (Off course :-)), CygnusEd v3.5 and rexxtricks.library.
  16.  
  17.     INSTALLATION
  18.     Copy rexxtricks.library to libs:
  19.  
  20.     ArexxGuide must be set up correctly (Use the ARx_Setup.rexx script).
  21.     The environment variable env:AmigaGuide/path must include the directory
  22.     where arx_guide.xref is located. And env:ARexxGuide/AGCmd must hold the
  23.     name of your amigaguide viewer.
  24.  
  25.     Have a look in the xref drawer. If you want online help for something
  26.     not included in ArexxGuide then copy the relevant .xref file(s)
  27.     somewhere and make sure that the environment variable
  28.     env:ArexxGuide/xrfiles includes the complete path to these files.
  29.  
  30.     Install the script on one of the FKeys in CED or bind it to any other
  31.     key with a long invocation macro.
  32.  
  33.     USAGE
  34.     If ArexxGuide is already running _or_ you want to view the ArexxGuide
  35.     index the node will be shown with your regular AmigaGuide viewer (As
  36.     defined in env:ARexxGuide/AGCmd).
  37.  
  38.     The FORCEAGCMD switch forces the use of your regular AmigaGuide viewer.
  39.     Usefull if you want to browse around in the guide for a while or want
  40.     access to nodes not found in the xref file.
  41.     I have 'arx_help.ced' installed on the HELP key and 'arx_help.ced
  42.     FORCEAGCMD' on shift-HELP.
  43.  
  44.     The searching and guide > ascii conversion is not that fast. So if you
  45.     have room enough on your HD I recommend turning the saving of ascii
  46.     nodes on.
  47.     All you have to do is edit the 'ascdir' line at the top of the script
  48.     and make sure that the directory you specify exists. The script will now
  49.     save the ascii node to that directory and next time you need the
  50.     information it will load it directly from there. And _that's_ pretty
  51.     fast :-)
  52.  
  53.     NOTES
  54.     Converted AmigaGuide links in the ascii node is shown enclosed in '{}'
  55.     brackets.
  56.  
  57.     CREDITS:
  58.     Heavily based on the arx_help scripts by Robin Evans. And thanks off
  59.     course to Robin for the excellent ArexxGuide.
  60.     Thanks to Klaus Seistrup for the CED view-opening routine.
  61.     And to Jürgen Kohrmeyer for rexxtricks.library and help with the
  62.     wildcard problem.
  63.  
  64.     COPYRIGHT
  65.     No copyright. Do whatever you want with this.
  66.  
  67.     DISCLAIMER
  68.     It's your fault :-)
  69.  
  70.     AUTHOR
  71.     Please send any comments to me. I can be reached at 2:238/38.0@fidonet
  72.     or 39:140/110.0@amiganet. Email: rolf@hoa.ping.dk
  73.  
  74.     HISTORY:
  75.     1.0  First release
  76.     1.1  Much more intelligent when cursor is placed on white space. Made
  77.          GETCWORD() CED specific. Put back TAB2SPACE().
  78.     1.2  Small (But important :-)) bugfix.
  79.     2.0  Now loads the node directly into CED!
  80.     2.1  Added optional saving of ascii nodes for faster loading.
  81.     2.2  Fixed problems when looking up ADDRESS().
  82.     2.3  Found a node in the xref file that doesn't exist !?!. Added check
  83.          for non-existing nodes.
  84.     2.4  Added check for quotes around node in xref file
  85.     2.5  All links in node is now converted properly and shown in '{}'
  86.          brackets
  87.     2.6  Fixed wildcrad problem. Now finds all nodes correctly. Added
  88.          FORCEAGCMD switch.
  89.     2.7  Included additional .xref files in the archive. And a script that
  90.          helps creating them.
  91.