home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 626a.lha / TKEd_v1.00 / TKEd.doc.english.pp / TKEd.doc.english
Text File  |  1992-04-07  |  42KB  |  1,339 lines
  1.   +-----------------------+
  2.  /                       /|
  3. +-----------------------+ |
  4. | Prg.name : TKEd V1.00 | | 
  5. | Date     : 12.02.1992 | +---------------------------+
  6. |                       |/                           /|
  7. +-----------------------+---------------------------+ |
  8. |     ----  Copyright Tom Kroener                   | |
  9. |    /(c)|            Richard Wagner Str. 40        | |
  10. |   / TKs|            D-6602 Saarbruecken-Dudweiler | |
  11. |  / 1991|            GERMANY                       | |
  12. | --------             +---------+                  | |-----------------+
  13. |                      | e-mail :|                  | |                /|
  14. |          +-----------+         +-----------+      | |               / |
  15. |          | kroener@cs.uni-sb.de (internet) |      | |              /  +
  16. |          | T_KROENER@SAARAG.ZER (Zerberus) |      | +             /  /|
  17. |          +----------------------------------+     |/             /  / |
  18. +---------------------------------------------------+-------------+  /  |
  19. | TKEd is NOT public-domain.                                      | /   |
  20. | It may not be used in commercial products without my permission |/    |
  21. +-----------------------------------------------------------------+     |
  22. | TKEd is SHAREWARE. You may copy TKEd and give it to other people|     |
  23. | as long as all files of the directory 'TKEd' are included and   |     |
  24. | no changes were made.                                           |     |
  25. | This version of TKEd allows you to load texts up to a length of |     |
  26. | 8000 Bytes.                                                     |     |
  27. | This should be enough to test TKEd.                             |     |
  28. | You can test TKEd for two or three weeks, but if you want to    |     |
  29. | use TKEd after this time, you have to send me the shareware     |     |
  30. | constribution ( $25 or 30 DM ).                                 |     +
  31. | If you do so , you will become a registered user and you will   |    /
  32. | get the latest update of TKEd (size of texts only limited       |   /
  33. | by memory).                                                     |  /
  34. | ( If you send me an check, please use DM (Deutsche Mark)!!      | /
  35. |                                                                 |/
  36. +-----------------------------------------------------------------+ 
  37.  
  38. -----------------
  39. Changes to V0.91:
  40. -----------------
  41. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  42.  
  43. 1.  TKEd has now a very comfortable AREXX-interface with 77 different
  44.     functions.
  45.     
  46. 2.  Completely rewritten memory management. Less amount of memory and
  47.     faster than TKEd V0.91.
  48.  
  49. 3.  Search and Replace of a text 5 times faster than TKEd V0.91.
  50.     If both (search and replace) strings  have the same length, TKEd V1.00 
  51.     makes this up to 40 times faster than TKEd V0.91 (show me an editor 
  52.     which replaces all occurences of the letter 'e' with another one 
  53.     faster than TKEd !!!!)
  54.  
  55. 4.  Blocks can now be moved to the left and to the right.
  56.  
  57. 5.  Some new menus:  'AutoBackup'
  58.                      'VersionBackup'
  59.                      'Count Occurences'
  60.                      'Matching Bracket'
  61.                      'Block->'
  62.                      'Block<-'
  63.                      'Next Word'
  64.                      'Previous Word'
  65.                      'Delete Word'
  66.                      'SwapCase'
  67.                      'Goto Buffer (0..9)'
  68.                      'ARexx'
  69.                          
  70. 6.  Most of the requesters are build up more logically.
  71.  
  72. 7.  More parameters possible in the User-Menus. 
  73.  
  74. 8.  Paths as parameters in User-Menus can now be entered comfortably
  75.     via filerequesters.
  76.  
  77. 9.  Length of a line up to 255 characters.
  78.  
  79. 10. TKEd now makes a backup of your text (with the ending
  80.     '.bak') while saving a text.
  81.     
  82. 11. TKEd can also make different versions of backups of a text.
  83.  
  84. 12. TKEd manages now up to 10 different textes. Also possibility to
  85.     copy blocks between the different textbuffers.
  86.  
  87. 13. Some small bugs removed.
  88.  
  89. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  90.  
  91. In this documenttext, all of the menus are described in the order of
  92. their appearence.
  93. So it's easy to find the description of the new menus.
  94.  
  95.  
  96. First I want to thank Colin Fox (of Pyramyd Designs) and Bruce Dawson
  97. (of CygnusSoft Software) for their great req.library and Nico Francois
  98. for his powerpacker.library.
  99.  
  100. Many thanks also to Stefan Winterstein for testing TKEd and discussing 
  101. errors and features of TKEd. 
  102.  
  103. **************************************************************************
  104. * Installation:                                                          *
  105. **************************************************************************
  106.  
  107. To install the req.library and the powerpacker.library, start the
  108. programs 'Install_Req.Library' and 'Install_PP.Library' .
  109.  
  110. To install TKEd simply move the icon to the desired directoy.
  111.  
  112.  
  113. If TKEd breaks with a requester 'Oberon Assert: Trap # 2 (Stack Überlauf)'
  114. select the icon of TKEd, start the (workbench-) menu 'Info' and
  115. set the field 'Stack' to 10000. (or if TKEd is running from the CLI or Shell,
  116. enter the command 'stack 10000' before starting TKEd.
  117. TKEd needs this stack for loading a text.
  118.  
  119. **************************************************************************
  120. * The Keys                                                               *
  121. **************************************************************************
  122.  
  123. Some of the menus of TKEd have shortcuts. This means, that you can
  124. also select a menu using the corresponding shortcut.
  125.  
  126. The standard (AmigaDos) way to call shortcuts is to hold down
  127. the right Amiga button and then press the specified button.
  128. (e.g Amiga+l will show the TKEd filerequester)
  129.  
  130. Some other shortcuts (e.g in the menu 'Misc') use the 'Ctrl' button
  131. instead of the right Amiga button.
  132. (e.g. Ctrl+l deletes one line ).
  133.  
  134. To move cursor up or down, use the cursor up/down keys in combination with
  135. the alt-, shift- or the ctrl- key.
  136.  
  137. Cursor up/down          : Moves cursor one line up/down
  138. Alt + cursor up/down    : Moves cursor 4 lines up/down
  139. Shift + cursor up/down  : Moves cursor one page up/down
  140. Ctrl + cursor up/down   : Moves cursor to the beginning/end of a text
  141.  
  142. Cursor left/right         : Moves cursor one character to the left/right
  143. Alt + cursor left/right   : Moves cursor one word to the left/right
  144. Shift + cursor left/right : Moves cursor to the left/right end of the window
  145. Ctrl + cursor left/right  : Moves cursor to the left/right end of a line
  146.  
  147. For moving through the text, you can also use some of the keys of the numeric
  148. keypad in combination with the Shift (or Alt) key.
  149.  
  150. Alt+Home  (Key 7) goes to the beginning of the text.
  151. Alt+End   (Key 1) goes to the end of the text.
  152. Alt+Pg Up (Key 9) goes one page up.
  153. Alt+Pg Dn (Key 3) goes one page down.
  154.  
  155.  
  156. The Help key shows some information about TKEd.
  157.  
  158. Most of the simple textrequesters (these with only one gadget) can also
  159. be closed by pressing the ESC - key.
  160.  
  161. **************************************************************************
  162. * Loading a text                                                         *
  163. **************************************************************************
  164.  
  165. There are 4 ways to load a text:
  166.  
  167. 1.  Start TKEd and use the menu 'Load'
  168.  
  169. 2.  Start TKEd from the CLI (or Shell) with the (path-) name of the text
  170.     (e.g. 'TKEd s:startup-sequence' will start TKEd and load the file
  171.      's:startup-sequence')
  172.      
  173. 3.  Hold down the 'Shift' key, select the icon of the text, select the icon
  174.     of TKEd and use the (workbench-) menu 'Open'.
  175.     
  176. 4.  Select the icon of the text, start the (workbench-) menu 'Info',
  177.     and write the path of TKEd (e.g 'sys:Utilities') into the field
  178.     'Default Tool' .
  179.     After saving this, you can start TKEd by clicking the icon of
  180.     the text and TKEd will load the text.
  181.  
  182. **************************************************************************
  183. * The Menus                                                              *
  184. **************************************************************************
  185.  
  186. +++++++++++
  187. + Project ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  188. +++++++++++  
  189. --------------------------------------------------------------------------  
  190.  
  191. -New-
  192.   Delete all the text.
  193.  
  194. -------------------------------------------------------------------------- 
  195.  
  196. -Open-
  197.   Opens a filerequester to choose the file to load.
  198.   If the text was packed with the PowerPacker, TKEd needs more memory to 
  199.   decrunch it. If you have not enough memory to do this, first decrunch
  200.   the text with the PowerPacker (See Fish 253 for the PD-version of
  201.   the PowerPacker) and then load the decrunched text.
  202.  
  203. --------------------------------------------------------------------------
  204.  
  205. -Save-
  206.   Saves the text.
  207.  
  208. --------------------------------------------------------------------------
  209.   
  210. -Save As-
  211.   Opens a filerequester to choose the path and the filename for saving
  212.   the text.
  213.  
  214. --------------------------------------------------------------------------
  215.  
  216. -Print-
  217.   Sends the text to the printer.
  218.  
  219. --------------------------------------------------------------------------
  220.  
  221. -Insert File-
  222.   Opens a filerequester to choose the file to be inserted in the
  223.   text.
  224.   The file will be inserted between the current line and the previous 
  225.   line .
  226.  
  227. --------------------------------------------------------------------------
  228.  
  229. -About-  
  230.   Shows some information about the author and the version of TKEd.
  231.   Shows also the (unpacked) length of TKEd ( in bytes ).
  232.   If  the number of bytes showed by the 'list' command is greater then
  233.   the number of bytes shown here, TKEd could be infected with a
  234.   link-virus.
  235.   Use a (link-)viruschecker for more information.  
  236.   
  237. --------------------------------------------------------------------------
  238.       
  239. -Save & Quit-
  240.   Saves the text and quit TKEd.
  241.  
  242. --------------------------------------------------------------------------
  243.   
  244. -Quit-
  245.   Quit TKEd.
  246.  
  247. --------------------------------------------------------------------------
  248. +++++++++
  249. + Prefs ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  250. +++++++++
  251. --------------------------------------------------------------------------
  252.   
  253. -Load-
  254.   If you have changed the preferences, you can load the preferences which
  255.   you have saved earlier.
  256.   If you start TKEd, it does automaticly load the file 's:TKEd.cfg'
  257.  
  258. --------------------------------------------------------------------------
  259.   
  260. -Save-
  261.   Opens a filerequester to save your preferences.
  262.   Default filename is s:TKEd.cfg
  263.   The information saved is:
  264.     -The colors
  265.     -The number of spaces for each tab
  266.     -If auto indent is on or off
  267.     -If autobackup is on or off
  268.     -If versionbackup is on or off
  269.     -All the data of the User - menus (commands, texts, etc)
  270.     -The shortcuts of the 'Amiga'- menus.
  271.  
  272. --------------------------------------------------------------------------
  273.  
  274. -Default-
  275.     Sets the preferences to the default values and clears all User - menus.
  276.  
  277. --------------------------------------------------------------------------
  278.  
  279. -Colors-
  280.   Opens a color requester to change the colors of TKEd.
  281.  
  282.  
  283. --------------------------------------------------------------------------
  284.    
  285. -TabsSize-
  286.     How many spaces are printed for one tab ( TKEd handles no tabs, it
  287.     expands tabs to spaces).
  288.  
  289. --------------------------------------------------------------------------
  290.  
  291. -ShortCuts-
  292.     Gives you the possibility to define your own shortcuts for the
  293.     menus using the standard AmigaDos shortcuts (not the menus with
  294.     the Ctrl-key-shortcuts).
  295.     Shows a textrequester with a string containing the 29 characters
  296.     of the shortcuts of the 29 menus (in the order of their appearance).
  297.     To change a shortcut, delete the character you want to change
  298.     and replace it by the one you like.
  299.  
  300. --------------------------------------------------------------------------
  301.     
  302. -Auto Indent-
  303.     If auto indent is off, each line (after pressing 'RETURN') starts
  304.     at column 1.
  305.     If auto indent is on, each line starts under the first character
  306.     of the previous line, which is not a space.
  307.  
  308.         
  309. --------------------------------------------------------------------------
  310.  
  311. -AutoBackup-
  312.   If 'AutoBackup' is on, TKEd makes a backup of your text (with the ending
  313.   '.bak') while saving a text
  314.  
  315. --------------------------------------------------------------------------
  316.  
  317. -VersionBackup-
  318.   If 'VersionBackup' is on, TKEd makes different versions of backups
  319.    of your text (with the ending '.bakX') while saving a text.
  320.    X stands for a digit from 0 to 30000.
  321.    Example: If you have a text named 'Letter' and you save it three times,
  322.             the backups 'Letter.bak0', 'Letter.bak1' and 'Letter.bak2'
  323.             will be created.
  324.             The newest version of the text will still have the name 'Letter'.
  325.             The eldest version will have the name 'Letter.bak0'
  326.  
  327. --------------------------------------------------------------------------
  328. ++++++++++
  329. + Search +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  330. ++++++++++
  331. --------------------------------------------------------------------------
  332.  
  333. -Find-
  334.   Shows a textrequester to enter the text to search for.
  335.  
  336. --------------------------------------------------------------------------
  337.   
  338. -Next-
  339.   Goes to the next occurrence of the text to search for.
  340.  
  341. --------------------------------------------------------------------------
  342.  
  343. -Previous--
  344.   Goes to the previous  occurrence of the text to search for.
  345.  
  346. --------------------------------------------------------------------------
  347.  
  348. -Search/Replace-
  349.   Shows a textrequester to enter the text to search for,
  350.   than another textrequester to enter the text which shall
  351.   replace the searched text.
  352.   After that, for each occurrence of the search text, a requester
  353.   will ask you whether you want to replace the text, whether you
  354.   don't want to replace  it or whether you want to stop the 
  355.   searching/replacing.
  356.  
  357. --------------------------------------------------------------------------
  358.  
  359. -Replace next-
  360.   Goes to the next occurrence of the searched text and asks to replace it.
  361.  
  362. --------------------------------------------------------------------------
  363.   
  364. -Replace previous-
  365.   Goes to the previous occurrence of the searched text and asks to 
  366.   replace it.
  367.  
  368. --------------------------------------------------------------------------
  369.  
  370. -Replace all-
  371.   Like search/replace, but it replaces all occurrences in the text 
  372.   without asking.
  373.  
  374. --------------------------------------------------------------------------
  375.  
  376. -Count Occurences-
  377.   Like the menu 'Find', but counts all the occurences in the text.
  378.   
  379. --------------------------------------------------------------------------
  380.  
  381. -Matching Bracket-
  382.   If the cursor is positioned over a bracket, this function will locate
  383.   the bracket belonging to this bracket (if there is any).
  384.   Handles (), [] and {}.
  385.   
  386. --------------------------------------------------------------------------
  387.  
  388. -Goto Mark 0-
  389.    ...
  390.    ...
  391. -Goto Mark 9-
  392.     If you have marked a line (see New Mark) TKEd will move to the
  393.     marked line.
  394.     Very nice if you use the shortcuts 0,1,...8,9.
  395.  
  396. --------------------------------------------------------------------------
  397.  
  398. -New Mark-
  399.     Marks the current line with the number you enter in the requester.
  400.     You can set up to 10 different marks by using the numbers 0..9.
  401.     Using a number twice will overwrite the first mark.
  402.  
  403. --------------------------------------------------------------------------
  404.             
  405. -Clear Mark-
  406.     Clears the mark you select.    
  407.     
  408. --------------------------------------------------------------------------
  409. +++++++++
  410. + Block ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  411. +++++++++
  412. --------------------------------------------------------------------------
  413.  
  414. -Block Start-
  415.   Marks the beginning of a block.
  416.  
  417. --------------------------------------------------------------------------
  418.   
  419. -Block End-
  420.   Marks the end of a block. The marked text will be displayed in a differnd
  421.   color.
  422.  
  423. --------------------------------------------------------------------------
  424.  
  425. -Block Delete-
  426.   Goes to the buffer where the block is marked, and deletes the block.
  427.  
  428. --------------------------------------------------------------------------
  429.   
  430. -Block Copy-
  431.   If a block is marked, it will be copied  ( if the cursor stands
  432.   on the current line) to the previous line.
  433.  
  434. --------------------------------------------------------------------------
  435.   
  436. -Block Move-
  437.   Same as 'Block Copy', but deletes the (original) marked block.
  438.  
  439. --------------------------------------------------------------------------
  440.  
  441. -Block->-
  442.   Moves each line of a marked block one column to the right.
  443.   
  444. --------------------------------------------------------------------------
  445.  
  446. -Block<--
  447.   Moves each line of a marked block one column to the left.
  448.   Lines beginning at column 1 will not be moved.
  449.   
  450. --------------------------------------------------------------------------
  451.   
  452. -Unmark Block-
  453.   Unmarks a marked block.
  454.  
  455. --------------------------------------------------------------------------
  456.  
  457. -Insert Block-
  458.   Opens a filerequester to load a saved block.
  459.   Default name: 't:blk'
  460.   
  461. --------------------------------------------------------------------------
  462.   
  463. -Print Block-
  464.   Sends the currently marked block to the printer. (See also menu 'Block' ).
  465.  
  466. --------------------------------------------------------------------------
  467.  
  468. -Save Block-
  469.   Shows a filerequester to choose the path and the filename for saving
  470.   the currently marked block. (See also menu 'Block' ).
  471.   Deault name:  't:blk'
  472.   
  473. --------------------------------------------------------------------------
  474. +++++++++   +++++++++
  475. + User1 +++++ User2 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
  476. +++++++++   +++++++++
  477. --------------------------------------------------------------------------
  478.  
  479. -Set Menu:-  (1-5)
  480.   Shows a textrequester which allows you to enter the command that will
  481.   be executed if you select the menu or the function key that belongs 
  482.   to the menu.
  483.   If the command contains [] , TKEd will show a requester ( while 
  484.   excuting the command) and you can enter a text, which will replace
  485.   the []. If the [] are in a text, be sure that one blank is before
  486.   and (if text follows) one blank is after the [].
  487.   Examples : copy [] to ram:
  488.              execute []
  489.              
  490.   If the command contains {}, TKEd will replace the {} by the name of the
  491.   currently loaded file. (be sure to save your text if you have modified
  492.   it).
  493.   About the blanks before or after the {} : see above.
  494.   Examples : copy {} to ram:
  495.              lc -l {}
  496.              
  497.   If the command contains (), TKEd will open a filerequester to make it
  498.   easy to enter the path to a file.
  499.   Example :  muchmore ()
  500.              
  501.   Combinations of {}, () and [] are possible; you can also use each kind
  502.   of bracket several times.
  503.   Examples : copy {} to []
  504.              rename () ()
  505.              lc [] {}
  506.              
  507.   The command text (after inserting the parameters for (),[] or {} )
  508.   can have a length up to 255 characters.
  509.              
  510.   After the textrequester for the command, another one will appear which
  511.   allows you to enter the text which will be shown in the menu.
  512.   This text can have a length up to 18 characters.
  513.   
  514.   If you save your preferences, this data will be saved and reloaded
  515.   everytime you start TKEd.
  516.   
  517.   If you set a menu, existing data will be overwritten, so you
  518.   don't have to clear it first.
  519.   
  520.   To give you the possibility to have a look at the output of an executed
  521.   command, TKEd normaly makes a 'Workbenchtofront' before executing a
  522.          g.SetDrMd (rp, SHORTSET{g.inversvid});
  523. X, 0);
  524. ve his ok to close
  525.   the outputwindow.
  526.   If you don't want to see anythink, add the keyword 'noreq' to the
  527.   command.
  528.   
  529.  
  530. --------------------------------------------------------------------------
  531.   
  532. -Clear Menu-
  533.   Clears the data of the menu.
  534.  
  535. --------------------------------------------------------------------------
  536.              
  537. -Help-
  538.   Shows parts of the information above.
  539.  
  540. --------------------------------------------------------------------------
  541.   
  542. -F1 - F10-
  543.  
  544.   If you don't want to use the mouse, pressing the keys F1 - F10, 
  545.   will also execute the command.
  546.  
  547. --------------------------------------------------------------------------
  548. ++++++++++   ++++++++++
  549. + ARexx1 +++++ ARexx2 ++++++++++++++++++++++++++++++++++++++++++++++++++++
  550. ++++++++++   ++++++++++
  551. --------------------------------------------------------------------------
  552.  
  553. -Set Menu:-  (1-5)
  554.   Shows a textrequester which allows you to enter the name of a
  555.   AREXX-program that will be executed if you select the menu or the 
  556.   function key that belongs to the menu.
  557.  
  558.   After the textrequester for the command, another one will appear which
  559.   allows you to enter the text which will be shown in the menu.
  560.   This text can have a length up to 18 characters.
  561.   
  562.   If you save your preferences, this data will be saved and reloaded
  563.   everytime you start TKEd.
  564.   
  565.   If you set a menu, existing data will be overwritten, so you
  566.   don't have to clear it first.
  567.  
  568.   The AREXX-program will be executed asynchronous, so you can work with
  569.   TKEd will the AREXX-command is running in the backround.
  570.   
  571.   After the AREXX-program has terminated, a requester will appear displaying
  572.   the results of the AREXX-program.
  573.   Both results should be 0 (if the program returns no errors)
  574.  
  575.   If you don't want this requester, add the keyword 'noreq' to the
  576.   name of the AREXX-program.
  577.   
  578.  
  579. --------------------------------------------------------------------------
  580.   
  581. -Clear Menu-
  582.   Clears the data of the menu.
  583.  
  584. --------------------------------------------------------------------------
  585.              
  586. -Help-
  587.   Shows parts of the information above.
  588.  
  589. --------------------------------------------------------------------------
  590.   
  591. -Shift F1 - Shift F10-
  592.  
  593.   If you don't want to use the mouse, pressing the keys Shift F1 - Shift F10
  594.   will also execute the command.
  595.  
  596. --------------------------------------------------------------------------
  597.  
  598.  
  599. ++++++++
  600. + Misc +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++    
  601. ++++++++
  602.  
  603. -Move-
  604.   There are several functions under this name:
  605.   
  606.  
  607. -Page Up-
  608.   Moves the cursor one page up.
  609.  
  610. -Page down-
  611.   Moves the cursor one page down.
  612.  
  613. -Begin of file-
  614.   Moves the cursor to the very first character position in the file.
  615.  
  616. -End of file-  
  617.   Moves the cursor to the last page of the file.
  618.  
  619. -Begin of line-
  620.   Moves the cursor to column 1 of the current line.
  621.  
  622. -End of line-
  623.   Moves the cursor to the right end of the current line.
  624.  
  625. -Goto line-
  626.   Shows a requester which allows you to enter the number of the line 
  627.   to go to.
  628.  
  629. -Next Word-
  630.   Moves the cursor to the next word.
  631.   
  632. -Previous Word-
  633.   Moves the cursor to the previous word.
  634. --------------------------------------------------------------------------
  635.   
  636. -Delete Word-
  637.   Delete word removes the word the cursor is standing on.
  638.  
  639.   
  640. --------------------------------------------------------------------------
  641.   
  642. -Delete line-
  643.   Delete line removes the current line.
  644.  
  645. --------------------------------------------------------------------------
  646.  
  647. -Delete to EOL-
  648.   Delete to EOL removes the contents of the current line from the
  649.   cursor position towards the right end of the line. 
  650.  
  651. --------------------------------------------------------------------------
  652.   
  653. -Swap Chars-
  654.   Swaps the character on which the cursor stands, and the following one.
  655.  
  656. --------------------------------------------------------------------------
  657.   
  658. -Help-
  659.   Displays some alternative shortcuts.
  660.  
  661. --------------------------------------------------------------------------
  662.    
  663. -Macros-
  664.   -Begin-
  665.     If you select this, TKEd will ask you the key to assign the macro to.
  666.     Enter the key (it must be a 'normal' ASCII-character), and click 'OK'
  667.     or press 'RETURN'.
  668.     After this all actions you make (including keys, menus etc.)
  669.     will be  recorded by TKEd until you select 'Macros -End-'.
  670.   -End-
  671.     Stops the recording of your actions.
  672.   -Execute-  
  673.     Executes the recorded actions. You can also do this by pressing the
  674.     key which you have assigned to the macro.
  675.     
  676.   Attention: If you use menus in the macro, try (if possible) to use
  677.              the shortcuts, because menu-selection by mouse makes sometimes
  678.              some trouble (some events are recoreded twice, but I don't
  679.              know why).
  680.              
  681.              Some actions like canceling a requester or the selection
  682.              in the filerequester are not recorded.
  683.              So if you e.g. want to find all occurences of a word and
  684.              to replace them first select 'Search/Replace' and enter
  685.              the search- and the replacetext.
  686.              After that, start recording your macro and use
  687.              'Replace next' (or 'Replace prev').
  688.  
  689. --------------------------------------------------------------------------
  690.     
  691. -Enter Ascii-
  692.    Allows you to enter the ascii value of a character (0-255) 
  693.  
  694. --------------------------------------------------------------------------
  695.  
  696. -SwapCase-
  697.    Changes the character under the cursor from uppercase (lowercase) to
  698.    lowercase (uppercase).
  699.    
  700. --------------------------------------------------------------------------
  701.  
  702. -JoinLines-
  703.   Joins the current line with the previous line
  704.   
  705. --------------------------------------------------------------------------
  706.  
  707. -Free Memory-
  708.    Gives you some information about the available memory.  
  709.    
  710. --------------------------------------------------------------------------
  711. +++++++
  712. + Err ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  713. +++++++
  714. --------------------------------------------------------------------------
  715.  It is useful for programmers if an editor has the possibility to display
  716.  the error-messages of their compilers.
  717.  Most of the compilers have their own style to show up errors, and I don't
  718.  know all of them.
  719.  So I decide to create a (simple) standard for the error-messages, and 
  720.  TKEd is able to work with it.
  721.  If your compiler differs from this standard, you have two possibilities:
  722.  
  723.  a) Write a small tool which converts the error-messages of your compiler 
  724.     into a form which can be read by TKEd.
  725.     Most of the compilers put their messages into an opened console window,
  726.     so it's easy to redirect them into a file (my tool 'TKA68KErr' executes
  727.     the command 'A68K > ram:tmperr' and modifies the created file 
  728.     'ram:tmperr').
  729.     
  730.  b) If you don't know how to write such a tool, start your compiler, 
  731.     redirect the output into a file ( like 'compile > ram:text.err')
  732.     and send this file and some information about your compiler
  733.     ( language, version ...) to me.
  734.     If possible (and if I have enough time to do that), I will write
  735.     the tool 
  736.  
  737. So and now the information about the format TKEd needs: 
  738.  
  739. 1.
  740.   The tool must create a file named 'ram:TKErr' that contains the information
  741.   for TKEd.
  742.   
  743. 2.
  744.   For each error, the file must contain three lines of information:
  745.   a)  The linenumber of the error
  746.   b)  The column of the error
  747.   c)  The error-message (maximum length: 144 characters)
  748.  
  749.   All the information must be normal ascii-text.
  750.   ( You have to save the linenumber as a string, not as an integer !!)
  751.   
  752. 3.
  753.   Be sure that there are no empty lines between the three lines
  754.   belonging to one error.
  755.     
  756. 4.
  757.   An example for a text showing three errors:
  758.   
  759.   2
  760.   12
  761.   Syntax error
  762.   10
  763.   1
  764.   ) expected
  765.   33
  766.   5
  767.   Unexpected end of file
  768.   
  769. 5.
  770.   Be sure that your tool works correctly, because TKEd doesn't control
  771.   what it reads.
  772.   If your tool creates an uncorrect file, the error menus will show
  773.   anything but not the errors.
  774.   
  775. 6.
  776.   The tools should work like normal dos commands, so that it can
  777.   be started using the 'User'-menus (see above).
  778.  
  779. 7.
  780.   On this disk, I include 2 errortools:
  781.  
  782.   Name:            Compiler:          Language:        Author:
  783.   ------------------------------------------------------------------------
  784.   TKOberonErr      Oberon V2.0        Oberon           Tom Kroener
  785.   TKA68KErr        A68K V2.61         Assembler        Tom Kroener
  786.  
  787.  
  788.   The tools are in the directory 'ErrorTools' and should be used
  789.   from the usermenus of TKEd.
  790.   I don't know if these tools work fine with other versions of these 
  791.   compilers, but I hope so.   
  792.   
  793.   If you use TKOberonErr, the program 'OErr' (a tool belonging to the 
  794.   Oberon-compiler) should be placed in a directory of a path for 
  795.   AmigaDos commands (e.g. 'sys:', 'c:' or other added paths).
  796.  
  797.   If you use TKA68KErr, the program 'A68K' .... (see above)
  798.  
  799.  
  800.   If someone programs such a tool for any other compiler and it works
  801.   fine, I would be happy if he (or she) send it to me.
  802.   I will publish it with the next version of TKEd. 
  803. --------------------------------------------------------------------------
  804.   
  805. -First Error-
  806.   Jumps to the first error and displays a requester with the errormessage.
  807.  
  808. --------------------------------------------------------------------------
  809.   
  810. -Next Error-
  811.   Jumps to the next error and displays a requester with the errormessage.
  812.       
  813. ++++++++++
  814. + Buffer +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  815. ++++++++++
  816.  
  817. -Goto Buffer-
  818.   0..9  : Shows the text in buffer 0..9
  819.  
  820.  
  821. *********
  822. * AREXX *+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  823. *********
  824.  
  825. Most of the functions of TKEd can be used by an AREXX program.
  826. The AREXX-port of TKEd has the name 'TKEd.1' and can be accessed after
  827. the ARREX-command 'address 'TKEd.1''.
  828. For further details consult your ARREX-manual.
  829.  
  830. For each TKEd you start, another port with another number as extension
  831. will be opened (e.g if you start TKEd three times,  the ports
  832. 'TKEd.1', 'TKEd.2' and 'TKEd.3' will exist).
  833.  
  834. Now the list of the names, functions, parameters and results of the
  835. AREXX-functions:
  836.  
  837.  
  838. No.  Name
  839.      Function
  840.      Parameters
  841.      Returnvalues
  842.  
  843.  
  844.   1. New
  845.      Clears all the text 
  846.      No parameter
  847.      Nothing
  848.  
  849.   2: Open
  850.      Loads a text
  851.      1:Name of the text (No parameter: opens a filerequester)
  852.      Name of the text, if successful, else 10
  853.  
  854.   3. Save
  855.      Saves a text
  856.      No parameter
  857.      0 if succesful, else 10
  858.  
  859.   4. SaveAs
  860.      Saves a text with a new name (the loaded text keeps his name)
  861.      1:New name of the text
  862.      New name, if succesful, else 10
  863.  
  864.   5. Print
  865.      Sends the text to the printer
  866.      No parameter
  867.      0 if successful, else 10
  868.  
  869.   6. InsertFile
  870.      Inserts a text
  871.      1:Name of the text
  872.      Name of the inserted text, if successful, else 10
  873.  
  874.   7. SaveAndQuit
  875.      Saves a text and quits TKEd
  876.      No parameter
  877.      0 if succesful, else 10
  878.  
  879.   8. Quit
  880.      Quit TKEd
  881.      No parameter
  882.      Nothing
  883.  
  884.   9. Find
  885.      Searches a word in the text
  886.      1:word (No parameter: opens a textrequester)
  887.      0 if found, else 10
  888.  
  889.  10. FindNext
  890.      Searches next occurence of the word
  891.      No parameters
  892.      0 if found, else 10
  893.  
  894.  11. FindPrevious
  895.      Searches previous occurence of the word
  896.      No parameters
  897.      0 if found, else 10
  898.  
  899.  12. FindChange
  900.      Searches for the next occurence of a word and replaces it with another
  901.      1:Word to search for  2:Replacing word (if parameter = PROMPT, then
  902.                                              opens textrequesters)
  903.      0 if possible, else 10
  904.  
  905.  13. ChangeNext
  906.      Searches for the next occurence of a word and replaces it with another
  907.                                         one
  908.      1:Word to search for  2:Replacing word
  909.      0 if possible, else 10
  910.  
  911.  14. ChangePrevious
  912.      Searches for the previous occurence of a word and replaces it with 
  913.                                          another one
  914.      1:Word to search for  2:Replacing word
  915.      0 if possible, else 10
  916.      
  917.  15. ChangeAll
  918.      Replaces all occurences of a word with another
  919.      1:Word to search for   2:Replacing word
  920.      Nothing
  921.  
  922.  16. CountOccurences
  923.      Counts all occurences of a word in a text
  924.      1:word
  925.      Number of occurences
  926.      
  927.  17. MatchingBracket
  928.      See menu 'Matching Bracket'
  929.      No parameters
  930.      0 if matching bracket found, else 10
  931.      
  932.  18. GotoBookMark
  933.      Goes to the mark
  934.      Number of the mark (0..9)
  935.      0 if successful, else 10
  936.      
  937.  19. SetBookMark
  938.      Sets a new mark
  939.      Number of the new mark (0..9)
  940.      0 if successful, else 10
  941.      
  942.  20. ClearBookMark
  943.      Clears a mark
  944.      Number of the mark (0..9)
  945.      0 if successful, else 10
  946.      
  947.  21. BlockStart
  948.      Marks start of a block
  949.      No parameters
  950.      Nothing
  951.      
  952.  22. BlockEnd
  953.      Markes end of a block
  954.      No parameters
  955.      Nothing
  956.      
  957.  23. BlockDelete
  958.      Goes to the buffer where the block is marked, and deletes the block
  959.      No parameters
  960.      Nothing
  961.      
  962.  24. BlockCopy
  963.      Copies a marked block
  964.      No parameters
  965.      Nothing
  966.      
  967.  25. BlockMove
  968.      Moves a marked block
  969.      No parameters
  970.      Nothing
  971.     
  972.  26. BlockRight
  973.      Moves a marked block one position to the right
  974.      No parameters
  975.      Nothing
  976.      
  977.  27. BlockLeft
  978.      Moves a marked block one position to the left
  979.      No parameters
  980.      Nothing
  981.      
  982.  28. UnmarkBlock
  983.      Unmarks a block
  984.      No parameters
  985.      Nothing
  986.      
  987.  29. InsertBlock
  988.      Opens a filerequester, to load a saved block
  989.      No parameters
  990.      Nothing
  991.      
  992.  30. PrintBlock
  993.      Sends a marked block to the printer
  994.      No parameters
  995.      0 if successful, else 10
  996.      
  997.  31. SaveBlock
  998.      Opens a filerequester, to save a block
  999.      No parameters
  1000.      Nothing
  1001.      
  1002.  32. PreviousPage
  1003.      Goes to the previous page
  1004.      No parameters
  1005.      Nothing
  1006.      
  1007.  33. NextPage
  1008.      Goes to the next page 
  1009.      No parameters
  1010.      Nothing
  1011.      
  1012.  34. BeginOfFile
  1013.      Goes to the very first character of a text
  1014.      No parameters
  1015.      Nothing
  1016.      
  1017.  35. EndOfFile
  1018.      Goes to the end of the text
  1019.      No parameters
  1020.      Nothing
  1021.    
  1022.  36. BeginOfLine
  1023.      Goes to the very first character of a line
  1024.      No parameters
  1025.      Nothing
  1026.      
  1027.  37. EndOfLine
  1028.      Goes to the right end of a line
  1029.      No parameters
  1030.      Nothing
  1031.      
  1032.  38. GotoLine
  1033.      Goes to a line
  1034.      Number of the line
  1035.      0 if successful, else 10
  1036.      
  1037.  39. GotoColumn              Remark: If the line is shorter the the column
  1038.      Goes to a column        you want to place the cursor at, spaces will be
  1039.      Number of the column    inserted at the end of the line
  1040.      0 if successful, else 10
  1041.       
  1042.  40. NextWord
  1043.      Goes to the next word
  1044.      No parameters
  1045.      Nothing
  1046.  
  1047.  41. PreviousWord
  1048.      Goes to the previous word
  1049.      No parameters
  1050.      Nothing
  1051.      
  1052.  42. DeleteLine
  1053.      Deletes the current line
  1054.      No parameters
  1055.      Nothing
  1056.      
  1057.  43. DeleteToEOL
  1058.      Deletes the current line from the position of the cursor to the end
  1059.                                                        of the line
  1060.      No parameters
  1061.      Nothing
  1062.  
  1063.  44. Cursor
  1064.      Moves the cursor up/down/left/right
  1065.      up, down, left or right
  1066.      Nothing
  1067.             
  1068.  45. Line
  1069.      Moves cursor the specified number of lines up/down
  1070.      Number of lines (e.g. 23, -45, +6)
  1071.      10, if the cursor reaches the beginning/end of the text, else 0
  1072.      
  1073.  46. Column
  1074.      Moves cursor the specified number of characters to the lft/right
  1075.      Number of characters (e.g. 23, -45, +6)
  1076.      10, if the cursor reaches the beginning/end of the line, else 0
  1077.  
  1078.  47. return
  1079.      Same as pressing the 'return'-key
  1080.      No parameters
  1081.      Nothing
  1082.  
  1083.  48. del
  1084.      Same as pressing the 'Del'-key
  1085.      No parameters
  1086.      Nothing
  1087.  
  1088.  49. backspace
  1089.      Same as pressing the '<-' -key
  1090.      No parameters
  1091.      Nothing
  1092.      
  1093.  50. GetLineNumber
  1094.      Returns the number of the current line
  1095.      No parameters
  1096.      Number of the line
  1097.      
  1098.  51. GetColumnNumber
  1099.      Returns the number of the current column
  1100.      No parameters
  1101.      Number of the column
  1102.      
  1103.  52. GetChar
  1104.      Returns the character at the cursor-position
  1105.      No parameters
  1106.      1 character
  1107.      
  1108.  53. GetLine
  1109.      Returns the text of the current line
  1110.      No parameters
  1111.      Text of the line
  1112.     
  1113.  54. WriteChar
  1114.      Writes down one character
  1115.      1 character
  1116.      0 if successful, else 10
  1117.      
  1118.  55. WriteString
  1119.      Writes down a string
  1120.      String (up to 255 characters long)
  1121.      0 if successful, else 10
  1122.   
  1123.  56. EnterAscii
  1124.      Writes down the ASCII-character belonging to the number
  1125.      ASCII-number of the character  (0 < number < 256)
  1126.      0 if successful, else 10
  1127.      
  1128.  57. SwapChars
  1129.      Swaps to characters
  1130.      No parameters
  1131.      Nothing
  1132.      
  1133.  58. LastLine
  1134.      Returns the linenumber of the very last line of a text
  1135.      No parameters
  1136.      Number of the last line
  1137.      
  1138.  59. GetFileName
  1139.      Returns the name of the loaded text
  1140.      No parameters
  1141.      Name of the text
  1142.      
  1143.  60. TKEdtoFront
  1144.      Pushes the screen of TKEd to the front
  1145.      No parameters
  1146.      Nothing
  1147.      
  1148.  61. TKEdtoBack
  1149.      Pushes the screen of TKEd to the back
  1150.      No parameters
  1151.      Nothing
  1152.      
  1153.  62. ReName
  1154.      Renames the text
  1155.      New name for the text
  1156.      Nothing
  1157.      
  1158.  63. GotoBlockStart
  1159.      Goes to the beginning of a marked block
  1160.      No parameters
  1161.      0 if successful, else 10
  1162.      
  1163.  64. GotoBlockEnd
  1164.      Goes to the end of a marked block
  1165.      No parameters
  1166.      0 if successful, else 10
  1167.      
  1168.  65. DeleteWord
  1169.      Deletes the word under the cursor
  1170.      No parameters
  1171.      Nothing
  1172.      
  1173.  66. SwapCase
  1174.      See same menu
  1175.      No parameters
  1176.      0 if possible, else 10
  1177.      
  1178.  67. UpperCase
  1179.      Changes the character under the cursor from lowercase to uppercase
  1180.      No parameters
  1181.      0 if possible, else 10
  1182.  
  1183.  68. LowerCase
  1184.      Changes the character under the cursor from uppercase to lowercase
  1185.      No parameters
  1186.      0 if possible, else 10
  1187.  
  1188.  69. FirstError
  1189.      Displays the first error of an errorfile
  1190.      If parameter = PROMPT : Shows a requester with the errormessage
  1191.      Errormessage (if exist), else 10
  1192.      
  1193.  70. NextError
  1194.      Displays the next error of an errorfile
  1195.      If parameter = PROMPT : Shows a requester with the errormessage
  1196.      Errormessage (if exist), else 10
  1197.      
  1198.  71. FuctionKey
  1199.      Executes one of the user-menus
  1200.      Number 0 to 19 (F1=0 ... F10=9, Shift-F1=10 ... Shift-F10 = 19)
  1201.      Nothing
  1202.  
  1203.  72. JoinLines
  1204.      Joins the current line with the previous line
  1205.  
  1206.  73. GotoBuffer
  1207.      Shows the text in the specified buffer
  1208.      Number of the buffer (0 to 9)
  1209.      0 if any text is loaded, 5 if no text is loaded, 10 if error
  1210.  
  1211.  74. GetBufferNumber
  1212.      Returns the number of the current buffer
  1213.      No parameters
  1214.      Number of the buffer
  1215.      
  1216.  75. Indent
  1217.      Switches indent on/off
  1218.      ON, to switch on, anything else will switch off
  1219.      Nothing
  1220.           
  1221.  76. AutoBackup
  1222.      Switches autobackup on/off
  1223.      ON, to switch on, anything else will switch off
  1224.      Nothing
  1225.           
  1226.  77. VersionBackup
  1227.      Switches versionbackup on/off
  1228.      ON, to switch on, anything else will switch off
  1229.      Nothing
  1230.           
  1231.      
  1232.      
  1233. Using AREXX, you can realise functions you miss:
  1234.  
  1235.  
  1236. Example:
  1237.  
  1238. /* MakeNumber : Inserts a linenumber  ( '1: ', '2: ' etc.) at the beginning 
  1239.    of each line */
  1240.  
  1241. /****** Start ******/
  1242.  
  1243.  
  1244. options results
  1245.  
  1246. address 'TKEd.1'      /* Name of TKEd's port */
  1247.  
  1248. 'LastLine'            /* Get number of the last line in a text */
  1249. x=result
  1250.  
  1251. 'BeginOfFile'         /* Go to the top of the text */
  1252.  
  1253. 'GetLineNumber'       /* Get linenumber */
  1254. y=result
  1255.  
  1256. do while y < x
  1257.   'BeginOfLine'
  1258.  
  1259.   'WriteString' y     /* Write number */
  1260.   'WriteString :'  /* Write ': '   */
  1261.  
  1262.   'Cursor' "down"
  1263.  
  1264.   'GetLineNumber'         /* Get linenumber */
  1265.   y=result
  1266.  
  1267. end
  1268.  
  1269. 'BeginOfLine'
  1270.  
  1271. 'WriteString' y     /* Write number */
  1272. 'WriteString ": "'  /* Write ': '   */
  1273.  
  1274.  
  1275.  
  1276. /****** End ******/
  1277.  
  1278. If you have installed AREXX, you can start this program from the 'User'-
  1279. menus using the command 'run rx rexx:makenumber'.
  1280. (Never forget the 'run', because TKEd will wait for the end of the AREXX
  1281. command. The AREXX command again waits for TKEd to return from the
  1282. execution of the 'User'-menu => TKEd hangs...
  1283.  
  1284.  
  1285. **************************************************************************
  1286. * Other informations                                                     *
  1287. **************************************************************************
  1288.  
  1289. a)  TKEd is reentrant and the pure-bit is set.
  1290.     So it's easy to make TKEd resident.
  1291.  
  1292. b)  TKEd can load and decrunch texts packed with the powerpacker.
  1293.     TKEd decrunches the text to the ram disk ( 'ram:' ) and loads it.
  1294.     Be sure to have the ram.device in your 'devs:' directory and the
  1295.     ram.handler in your 'l:' directory.   
  1296.     If you have not enough memory to do this, first decrunch
  1297.     the text with the PowerPacker (See Fish 253 for the PD-version of
  1298.     the PowerPacker) and then load the decrunched text.
  1299.    
  1300.    
  1301. c)  Most of the tests of my compiler for NIL-pointers, wrong types, ranges 
  1302.     and so on are still part of TKEd.
  1303.     This reduces the speed of TKEd, but often prevents to see the Guru.
  1304.     If TKEd crashes, a message will appear:
  1305.     If this happens, I would be happy if you would send me a letter with 
  1306.     this message and the function of TKEd which you have called just before
  1307.          g.SetDrMd (rp, SHORTSET{g.complement});
  1308. error .
  1309.     If you are a registered user I will send you a disk with the newest
  1310.     version of TKEd; if not, I hope that you find the next published version
  1311.     of TKEd (having less errors) good enough to send me the share.
  1312.  
  1313. d)  If you miss a feature, write to me (you need not to be a registered
  1314.     user to do this).
  1315.     I will try to add the mostly asked features to TKEd.
  1316.  
  1317.  
  1318.     
  1319. **************************************************************************
  1320.  
  1321.  
  1322. If you have criticism, suggestions, errortools, trouble with TKEd,
  1323. error reports, gifts or something else write to
  1324.  
  1325. Tom Kroener
  1326. Richard Wagner Str. 40
  1327. D-6602 SB-Dudweiler
  1328. GERMANY  
  1329.  
  1330.                             --- Tom
  1331.     
  1332.     
  1333.     
  1334.  
  1335.  
  1336.  
  1337.   
  1338.  
  1339.