/plugins/NetRexxScript/tags/0.1.1c/README.TXT

# · Plain Text · 48 lines · 34 code · 14 blank · 0 comment · 0 complexity · 462161b9615486efaf47c39aece7a127 MD5 · raw file

  1. NetRexx Script readme file
  2. NetRexxScript feature highlights:
  3. * Efficient execution of NetRexx scripts and macros in jEdit
  4. * Optional caching of parsed scripts to improve performance
  5. * Option to "preparse" all available scripts as a unit for performance (aka "greased lightning mode") and cross-script access support
  6. * Option to suppress or allow trace output
  7. * Options to execute a currently open NetRexx file including unsaved changes
  8. * Optional dockable console window with command line to run scripts with parms and view say output or respond to ask input
  9. * View say output with or without trace from the console window to aid debugging
  10. * Option to "prefix" scripts automatically adds access to jEdit functions and variables
  11. * Script parse errors are automatically highlighted in script source files and listed in the "Error List" as well as displayed in a console window
  12. * User defined "classpath" option for making classes available to NetRexx scripts
  13. * User defined "scriptpath" option for access to scripts outside of jEdit macro libraries
  14. * Support for executing compiled NetRexx scripts or any "main" type Java class file as a macro or console command
  15. * Includes an updated version of the "NetRexx at Once" cross reference guide to Java and NetRexx
  16. Installation:
  17. You must install the plugin manually at this time.
  18. When it reaches a stable 1.0 version and gets packaged for distribution from the jEdit site, you will be able to use the automatic installation process, but for now -
  19. To install it manually:
  20. * Download the NetRexxScript.jar file and the NetRexxC.jar file or download and unzip the zip file which contains both
  21. * Copy both files to the user account's jEdit jars directory or the main jEdit jars directory.
  22. On Windows XP the user's jEdit home directory could be C:\Documents and Settings\useracct\.jedit\jars (Where "useracct" is the actual userid.)
  23. The jEdit main jar directory may be C:\Program Files\jEdit\jars
  24. If you have the NetRexxJe plugin installed, NetRexxC.jar is installed with it, so just copy NetRexxScript.jar to the same directory.
  25. Sample Scripts provided with the NetRexxScript plugin:
  26. * asktest -- This script demonstrates console IO to the user - it requires the NetRexxScript dockable window to work
  27. Say output displays in the OUT panel of the console and ask input is read from the command line
  28. * index -- This script demonstrates the effect of caching on indexed variables
  29. If cached, the second execution will show different results for the second display of s['x']
  30. * iosample -- This script demonstrates easy GUI IO to the end user
  31. * multi -- This script demonstrates one script calling another in preparse mode - demonstrates parse error if caching option is off
  32. * test -- This is the basic test script for the plugin -- It demonstrates say output that contains some trace sections
  33. which can be viewed in the trace panel of the plugin console window
  34. * testbin -- This is a "binary" NetRexx script - it does not use "Rexx class" variables and runs OK even without the "prefix" option