home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 2 / goldfish_vol2_cd1.bin / files / comm / fido / spot / rexx / temptool.doc < prev    next >
Text File  |  1993-09-02  |  4KB  |  105 lines
  1.  
  2.                                 TempTool v1.1
  3.  
  4.                          By Philip O'Malley (C)1993
  5.  
  6.                  (Fidonet: "Phil O'Malley" at 2:250/107.96)
  7.  
  8.  
  9. 1.1 An Introduction
  10.  
  11.     TempTool an ARexx script, designed to work inconjunction with Spot, which
  12. alters the temp file sent to your text editor, thus adding its capabilities
  13. to those of Spot. The intention is to append more features  to the script
  14. when I desire, or am requested to add, them. At the moment v1.1 will change
  15. peoples names in the reply header with nicknames from the userlist.
  16.  
  17.  
  18. 1.2 Execution Syntax
  19.  
  20.     TempTool has the following execution syntax:
  21.  
  22.       rx TempTool.spot <path to your spot.temp file>
  23.  
  24.  
  25. 1.3 Installation
  26.  
  27.     TempTool should be run immediately before your text editor. Thus is best
  28. accomplished by the use an execution script which is called from Spot instead
  29. of calling the editor directly. Such a script, where the spot.temp file was
  30. kept in DH0:T/ and my editor was CEd, could look like:
  31.  
  32.       ; Execution script for TempTool.spot
  33.  
  34.       rx TempTool.spot dh0:t/spot.temp
  35.  
  36.       ced dh0:t/spot.temp -keepio
  37.  
  38.  
  39. 2.1 Substituting Nicknames
  40.  
  41.     Mail editors are wonderful things, but the automatic replies they create
  42. are formal and impersonal. TempTool will interchange a person's name found in
  43. the userlist with a nickname defined in the comment field, thus adding a
  44. personal and perhaps humorous (your decision) touch. Once the script is
  45. installed, all nicknames are entered from the userlist requester in Spot.
  46.  
  47.     However, for maximal speed, TempTool requires the reply headers to
  48. formatted in a specific manner. Firstly, the whole header must be enclosed by
  49. user-definable markers which, if the script has reached you intact, are
  50. initially defined as "!intro_start\n" and "!intro_end\n". To change these
  51. markers to your own ideals then edit the following lines in the script:
  52.  
  53.       marker_intro_start = '!intro_start'||newline
  54.       marker_intro_end   = '!intro_end'||newline
  55.  
  56.     Notice that "newline" is my ARexx definition of a line feed, or hex 0A,
  57. and corresponds to the "\n" which Spot uses in the header window. Secondly,
  58. the reply header name variables (%N and %A) must also be enclosed by user-
  59. definable markers, initially defined as "!#" and "#!". Again, to change these
  60. markers to your own preferences then edit the following lines in the script:
  61.  
  62.       marker_name_start  = '!#'
  63.       marker_name_end    = '#!'
  64.  
  65.     So, using the initial defaults a reply header of...
  66.  
  67.       On %d, %N conveyed to %A:\n
  68.  
  69.     ...would be altered to become:
  70.  
  71.       !intro_start\nOn %d, !#%N#! conveyed to !#%A#!:\n!intro_end\n
  72.  
  73.     However, that is not the end of the story. You must also specify the path
  74. to all your userlists in the variable "userlist.x" where "x" is the number of
  75. the userlist. So, if you had two userlists held in the mail: directory called
  76. "userlist_fidonet" and "userlist_amiganet" you would make the following
  77. entries in the appropriate section of the script:
  78.  
  79.       /* Intra-script path assigns */
  80.  
  81.       userlist.1 = 'mail:userlist_fidonet'
  82.       userlist.2 = 'mail:userlist_amiganet'
  83.  
  84.     The actual nickname entries are via the Spot userlist requester - once
  85. the script is installed you need not touch it again. Here you must made a
  86. userlist entry of the person concerned and put the replacement name which
  87. TempTool will use in the comment field. I did not use the nickname field
  88. itself as it would possibly compromise its system-wide use.
  89.  
  90.  
  91. 3.1 Pseudo-Legal Stuff
  92.  
  93.     TempTool.spot is freely distributable so long as the script is
  94. accompanied by this documentation file, and both are not crunched by any
  95. program that is not freely available in the public domain.  I retain the sole
  96. copyright to this program, and alteration of the script or accompanying
  97. documentation is forbidden without my written approval.
  98.  
  99.     You must be aware that TempTool.spot writes to a directed volume and a
  100. crash during an operation may lead to the corruption of data.  I refuse to be
  101. held responsible for any loss of data caused either directly or indirectly
  102. through the use of this script.  You use it at your own risk, and your use of
  103. it signifies your acceptance of these conditions.
  104.  
  105.