Keywords: ARexx,manual,reference,tutorial,AmigaGuide,script,TurboText,Edge,Ed
DESCRIPTION
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This is the RQ version of ARexxGuide. It works properly only with
v34 of the AmigaGuide viewer (pre-3.0 versions) and requires
rexxreqtools.library and reqtools.library. The libraries are not
included, but should be available wherever ARexxGuide is found.
The standard version (ARexxGuide2_0A.lha) does not require the
libraries and includes text formatting codes for Multiview users.
ARexxGuide is a complete ARexx reference with tutorials and dozens
of ready-to-use examples. Done in AmigaGuide format, it includes
argument templates and descriptions of all instruction keywords, of
built-in functions, and of the functions in rexxsupport.library.
The basic elements of the language are fully explained. Example
programs -- some of them interactive -- answer frequently-asked
questions about the language. Sample clauses are included with each
function and instruction explanation. Error codes and possible
solutions are explained.
A help-system that will turn nearly any text editor into an online
reference to ARexx is included. Working macros for three editors
are provided as examples. A step-by-step tutorial explains the
simple steps for making a new macro for a different editor.
ARexxGuide is a shareware offering. The suggested fee is $15.
VERSION
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2.0a: Some embarrasing problems in the included scripts are fixed.
Those who previously downloaded the 2.0 version can get
copies of the fixed scripts in the archive ARexxG_20patch.lha.
The second edition includes extensive changes thoughout. Two new
tutorials explain ARexx as a macro language. A new section on
techniques answers frequently-asked questions about ARexx with
example code that can often be plugged directly into a script. Each
possible error code is explained.
Notes on compatability issues have been added throughout the guide.
They show how ARexx differs from the standard definition of REXX
and offer methods for handling the differences.
RQ version ======================
Two different versions of the second edition are distributed. Both
include the same information, but present it in somewhat different
ways. The RQ version uses requesters to show definitions and other
information that is displayed in the standard version by moving to
a new node. The RQ version uses `rexxreqtools.library' by Rafael
D'Halleweyn. and `ReqTools' by Nico François to implement the
requesters. Because the requesters must be able to communicate with
AmigaGuide through ARexx, this version can be used only with
pre-MultiView versions of AmigaGuide -- that is, with version 34 of
the library.
REQUIREMENTS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For the standard version: (ARexxGuide2_0A.lha)
Any AmigaGuide viewer.
Multiview can be used with OS 3.x. Users of OS 1.3 or 2.x will
need the AmigaGuide utility and amigaguide.library which are
distributed by Commodore on most BBSes and networks that support
the Amiga.
For the RQ version: (ARexxGuide2_0rqA.lha)
AmigaGuide version 34 viewer and library.
`reqtools.library' and `rexxreqtools.library'.
These libraries are included in the distribution archives for
ReqTools by Nico François. Look for `ReqTools22a_User.lha' on
your favorite shareware source. A minimum version of 37.5 for
rexxreqtools.library is required.
ARCHIVE CONTENTS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The ARexxGuide drawer of this archive contains 21 files that make
up one AmigaGuide® application. The AmigaGuide files are:
ArexxGuide.guide
ARx_Cmd.ag
ARx_Elements.ag
ARx_Elements2.ag
ARx_Elements3.ag
ARx_Func.ag
ARx_Func2.ag
ARx_Func3.ag
ARx_Func4.ag
ARx_Guide.xref
ARx_Index
ARx_Instr.ag
ARx_Instr2.ag
ARx_Instr3.ag
ARx_Intro.ag
ARx_Operator.ag
ARx_PrgUcr.ag
ARx_Tknq.ag
ARx_Tutor.ag
ARx_UcrTutor1.ag
ARx_UcrTutor2.ag
Only ARexxGuide.guide is intended as an AmigaGuide executable. The
other files are called from within the main node of that guide.
The following ARexx script files, located in the same directory,
are used to run interactive examples from ARexxGuide, or to provide
utilities for the program:
ARexxGuide.rexx
ARx_Cmpr.rexx
ARx_IactExamples.rexx
ARx_Reg.rexx
ARx_Setup.rexx
Arx_Trace.rexx
Two additional files are included with the RQ version of the guide.
ARx_Glossary.rexx
ARx_GlossaryPort.rexx
The `Editors' drawer contains macros for the ARexxGuide help
system. Example macros are included for Ed 2.0 (the editor that
comes with the OS), TurboText, and Edge. A tutorial in ARexxGuide
explains how to make a file for a different editor. Any editor that
is capable of minimal communication with ARexx can be used.
The 'Extras' drawer contains some files that are not necessary, but
may be helpful to some users. Read the opening comment for more
information.
The file 'UnCrunch.rexx' is the the source document for the program
included in the tutorial section.
DISTRIBUTION
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The files in this archive are copyright © 1993,1994 by Robin Evans
and may be distributed only in the original form and only under the
conditions outlined below.
Distribution of the material in this archive is prohibited if the
contents of the original archive are altered in any way.
The archive may be distributed in its original form on local and
national computer networks, on Aminet distribution channels
(including the Walnut Creek CD-ROM), on Fish collections, or on
disk collections distributed by non-profit entities. Distribution
by other means (including distribution by profit-making entities
other than those mentioned) is prohibited unless specific
permission is granted.
Rights are reserved for other forms of distribution of this archive
or of its contents individually, including but not limited to
distribution of a printed version of any file contained in the
archive, distribution with commercial products, or distribution on
computer networks in hypertext form of any file in the archive.
Contact the author for further information and permissions.
Robin Evans 10 Apr 1994
from Internet:
robin@halcyon.com
r.evans6@genie.geis.com
on GEnie:
R.EVANS6
by phone:
(206) 682-7077
|
aminet net>