home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / programs / textual / zap / zmods / Modules / !ZapText / HelpData < prev    next >
Encoding:
Text File  |  1998-06-22  |  9.5 KB  |  238 lines
  1. SWAPCRLF (ZapText - Daniel Wagenaar)
  2. Exchanges CR <-> LF (Carriage returns with linefeeds). This can be used to
  3. convert Mac style texts to RISC OS style texts, or to convert spooled output
  4. (with LFCR) to 'DOS style' text (CRLF).  This may then be converted to
  5. an ordinary RISC-OS style text by dragging it to Zap's icon bar icon.
  6. This command has been written to replace LINEENDS where possible. It is
  7. *much* faster. The action of SWAPCRLF can not be undone using the undo
  8. commands. It's action may be reversed by executing it again.
  9.  
  10. LINEENDS (ZapText - Daniel Wagenaar)
  11. Replaces all occurences of CRLF, CR, LF, LFCR by the correct return
  12. character (as set in the ‘Display-> Misc->Return char->’ submenu). This is
  13. particularly useful when you've copied a text file from an MS-DOS system,
  14. which uses CRLF instead of plain LF.
  15.  
  16. FINDSEL (ZapText - Daniel Wagenaar)
  17. Search for the current selection. The parameter is one of:
  18.   "0","To[ buffer]"            : To buffer
  19.   "1","Next[ match]", "Forward"        : Forward from cursor (next match)
  20.   "-1","Previous[ match]", "Backward"    : Backward from cursor (previous match)
  21.   "2","First[ match]", "[From ]start"    : Forward from start (first match)
  22.   "-2","Last[ match]", "[From ]end"    : Backward from end (last match)
  23.  
  24. (all case insensitive).
  25.  
  26. Note that this parameter used to be numerical; it's now a string. The old,
  27. numerical, arguments are still valid, but must be passed as strings.
  28.  
  29. SWAPCASE (ZapText - Dominic Symes)
  30. Swap case of next character/selected region if there is one.
  31.  
  32. SWAPCASECURSOR (ZapText - James Aylett)
  33. Swap case of next character.
  34.  
  35. LOWERCASE (ZapText - Tim Tyler)
  36. Change next character/selected region if there is one to lower case.
  37.  
  38. LOWERCASECURSOR (ZapText - Tim Tyler)
  39. Change next character to lower case.
  40.  
  41. UPPERCASE (ZapText - Tim Tyler)
  42. Change next character/selected region if there is one to upper case.
  43.  
  44. UPPERCASECURSOR (ZapText - Tim Tyler)
  45. Change next character to upper case.
  46.  
  47. COMMANDSEL <string> (ZapText - James Aylett)
  48. Executes the single command <string> with the current selection as parameter.
  49.  
  50. FINDFILECURSOR (ZapText - Darren Salt)
  51. Look for an object name (file or directory) at the cursor. If successful,
  52. then attempt to load the file or open the directory (as appropriate).
  53.  
  54. SAVEKEEPSTAMP (ZapText - Darren Salt)
  55. Saves the file immediately (ie. no prompt), but preserving the datestamp.
  56.  
  57. UNTABIFY (ZapText - Darren Salt)
  58. Converts tabs to spaces (the reverse of STRIPSPACES 4).
  59. In program source modes (C etc.) tabs in quotes "" are left intact.
  60.  
  61. UNTABIFYSEL (ZapText - Darren Salt)
  62. Converts tabs to spaces within the selection, provided that the selection is
  63. in the current window.
  64. In program source modes (C etc.) tabs in quotes "" are left intact.
  65.  
  66. INSERTBLANK (ZapText - Darren Salt)
  67. In text modes, inserts a space at the cursor as in !Edit.
  68. In binary modes (byte, word, code etc.), inserts the relevant number of
  69. zero bytes.
  70. With block edit mode, it should act as expected.
  71.  
  72. INSERTFILE (ZapText - Justin Fletcher)
  73. Insert a file at the cursor. Prefixes allow special functions :
  74.   |  The file will be indented as if typed
  75.   *  The file will be run through GSTrans first - ie you can use
  76.      system variables.
  77. Parameters : [*][|]<filename>
  78.  
  79. FORMATINDENTED (ZapText - Darren Salt)
  80. An indented version of FORMATTEXT. The text must already be indented using
  81. the supplied string; if you specify "\<" you get whatever's to the left of
  82. the cursor.
  83.  
  84. REMOVELF (ZapText - Daniel Wagenaar)
  85. Designed to convert text with fixed LFs to text with free line-endings.
  86. Converting back to fixed LFs is done by the ADDLF command.
  87. Note that the action of REMOVELF cannot be undone.
  88.  
  89. REMOVELFSEL (ZapText - Daniel Wagenaar)
  90. Acts like REMOVELF only acts on the current selection.
  91. Converting back to fixed LFs is done by the ADDLFSEL command.
  92. Note that the action of REMOVELFSEL cannot be undone.
  93.  
  94. ADDLF (ZapText - Tim Tyler)
  95. Takes a textual buffer and inserts LFs at the end of every line which would
  96. be soft-wrapped if soft-wrap was activated.  The width which is used is the
  97. current width and not the word-wrap width.  This command is designed to
  98. perform the opposite function to the command REMOVELF.  It is quite slow,
  99. but the hourglass percentage is used and it can be aborted by pressing
  100. ESCAPE.
  101.  
  102. ADDLFSEL (ZapText - Tim Tyler)
  103. Takes a selection in a textual buffer and inserts LFs at the end of every
  104. line which would be soft-wrapped if soft-wrap was activated.  See also ADDLF.
  105. This command is designed to perform the opposite function to the command
  106. REMOVELFSEL.  The action is related to that of the FORMATTEXT command.
  107. It is quite slow, but the hourglass percentage is used and it can be aborted
  108. by pressing ESCAPE.
  109.  
  110. UNSPACE (ZapText - Dominic Symes)
  111. Remove excess spacing around the cursor. Note that this now works atomically
  112. (ie it can be undone in one go).
  113.  
  114. EVAL (ZapText - Elliott Hughes)
  115. Evaluates the string parameter with OS_EvaluateExpression, and inserts the
  116. result at the cursor position.
  117.  
  118. SELECTWORD (ZapText - James Aylett)
  119. Selects the word at the cursor, as defined by the current mode.
  120.  
  121. BRACKETCURSOR (ZapText - Justin Fletcher)
  122. Brackets the word in which the cursor sits with the strings given.
  123. Parameters : <break><left string><break><right string>
  124.  
  125. BRACKETSEL (ZapText - Justin Fletcher)
  126. Brackets the selection with the strings given.
  127. Parameters : <break><left string><break><right string>
  128.  
  129. SELECTUNTIL (ZapText - Tim Tyler)
  130. Selects a region under the cursor. This region is delimited by control
  131. characters or any of the characters in the supplied string. The command may
  132. be used to handle double clicks in files where the default selection routine
  133. is not appropriate. (See Zap_ReturnWord in E-ZapCalls.)
  134.  
  135. @SELECTUNTIL (ZapText - Tim Tyler)
  136. Returns the region under the cursor. This region is delimited by control
  137. character or any of the characters in the supplied string. (See
  138. Zap_ReturnWord in E-ZapCalls.)
  139.  
  140. SELECTWHILE (ZapText - Tim Tyler)
  141. Selects a region under the cursor. The parameter is non-delimiters for the
  142. region. (See Zap_ReturnWord in E-ZapCalls.)
  143.  
  144. @SELECTWHILE (ZapText - Tim Tyler)
  145. Returns the region under the cursor. The parameter is non-delimiters for the
  146. region. (See Zap_ReturnWord in E-ZapCalls.)
  147.  
  148. STRIPCTRLCODES (ZapText - Darren Salt)
  149. Strip control codes. In binary modes, beeps instead.
  150. Either takes a byte argument: STRIPCTRLCODES #<byte> 
  151.   Bit 0 set: strip control codes
  152.   Bit 1 set: ... except for \a, \b and \f
  153.   Bit 2 set: remove everything from soft-EOF
  154.   Bit 3 set: strip top bit set characters
  155.  
  156. or takes a string which evaluates to a numerical mask: STRIPCTRLCODES <mask>
  157. in which bit n set = remove chr code n.
  158. The default is STRIPCTRLCODES #3.
  159.  
  160. FILTERSEL <command> (ZapText - Paul Moore)
  161. This command takes the selected area of the current file, and feeds it to the
  162. standard input of the given command. The selection is replaced by the
  163. standard output. (In other words, it filter the selection through the given
  164. command.)
  165.  
  166. C-style redirection is used (ie, command <standard_in >standard_out), so only
  167. filter programs written in languages using the Shared C Library are likely to
  168. work.
  169.  
  170. Error messages are ignored.
  171. <Wimp$ScrapDir> is used for temporary files (called Zap-In and Zap-Out).
  172. The command is looked for on your run path, and then on the ZapFilters: path
  173. if it wasn't found. Some useful filters are supplied with Zap.
  174.  
  175. FILTERBUF <command> (ZapText - Paul Moore)
  176. Filters the entire buffer through the given command. See FILTERSEL.
  177.  
  178. PIPESEL <command> (ZapText - Paul Moore)
  179. Pipes the selection through the given command into a new buffer. See
  180. FILTERSEL.
  181.  
  182. PIPEBUF <command> (ZapText - Paul Moore)
  183. Pipes the entire buffer through the given command into a new buffer. See
  184. FILTERSEL.
  185.  
  186. PIPE (ZapText - Paul Moore)
  187. Pipes the output of a command into a new buffer. See FILTERSEL.
  188.  
  189. INSERTPIPE (ZapText - Paul Moore)
  190. Pipes the output of a command to the cursor. See FILTERSEL.
  191.  
  192. INSERTPIPEDSEL (ZapText - Paul Moore)
  193. Pipes the selection through the given command to the cursor. See FILTERSEL.
  194.  
  195. INSERTPIPEDBUF (ZapText - Paul Moore)
  196. Pipes the entire buffer through the given command to the cursor. See
  197. FILTERSEL.
  198.  
  199. REM (ZapText - James Aylett)
  200. A completely pointless command which does nothing. May be useful for
  201. commenting scripts or something; I don't know.
  202.  
  203. NEXTFILE (ZapText - James Aylett)
  204. Moves the cursor to the next file in sequence, opening a window for it if
  205. necessary.
  206.  
  207. NEXTWINDOW (ZapText - James Aylett)
  208. Moves the cursor to the next window in sequence.
  209.  
  210. NEXTVIEW (ZapText - James Aylett)
  211. Moves the cursor to the next view on the current file.
  212.  
  213. HELPTOPIC (ZapText - Martin Ebourne)
  214. Find help for the supplied string, using Guttorm Vik's StrongHelp.
  215. If there is no supplied string, then find help for the selected text, else
  216. prompt for a word in the minibuffer.
  217. Help paths can be configured using system variables Zap$HelpPath_<modename>.
  218.  
  219. HELPCONTEXT (ZapText - Martin Ebourne)
  220. Find help for the word at the cursor, using Guttorm Vik's StrongHelp.
  221. Help paths can be configured using system variables Zap$HelpPath_<modename>.
  222.  
  223. HELPSEARCH (ZapText - Martin Ebourne)
  224. Freetext search for the supplied string, using Guttorm Vik's StrongHelp.
  225. If there is no supplied string, then find help for the selected text, else
  226. prompt for a word in the minibuffer.
  227. Help paths can be configured using system variables Zap$HelpPath_<modename>.
  228.  
  229. HELPSEARCHCONTEXT (ZapText - Martin Ebourne)
  230. Freetext search for the word at the cursor, using Guttorm Vik's StrongHelp.
  231. Help paths can be configured using system variables Zap$HelpPath_<modename>.
  232.  
  233. @WORDSTR (ZapText - James Aylett)
  234. Returns the word at the cursor as a string.
  235.  
  236. @WORDOFFSTR <offset> (ZapText - James Aylett)
  237. Returns the word at (cursor+offset) as a string.
  238.