home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / utilities / utilsf / lineeditor / !ReadMe next >
Text File  |  1996-09-04  |  23KB  |  508 lines
  1.                         LineEditor Module release 2.71
  2.                         ==============================
  3.  
  4. ** Source, binaries and documentation        **
  5. ** Copyright (C) Oliver Betts 1994,1995,1996 **
  6.  
  7. This software is provided as is - it has been tested to a reasonable extent,
  8. but probably has a few lurking bugs.  I take no responsibility for any loss
  9. or damage, directly or indirectly caused.
  10.  
  11. UNIX is a trademark of AT&T; 4DOS is a trademark of JP Software Inc.
  12. Incidentally, I highly recommend 4DOS if you have to use DOS.
  13.  
  14. Versions with a letter suffix are test versions and may only be distributed
  15. with express permission from me.  Other versions may be distributed freely
  16. provided all files are supplied intact and that no profit is made.  You may
  17. bundle it with other freeware software provided these distribution
  18. restrictions are met, but please make sure you're supplying the latest
  19. version.  If you want to distribute it in some other way, get in touch.
  20.  
  21. *****************************************************************************
  22.  
  23. This module started out as some modifications to version 2.30 of Richard K.
  24. Lloyd's LineEditor module, to make it work better with TaskWindows
  25. (specifically to use the same *FX4 and *FX 220-228 settings as the Wimp).
  26.  
  27. However, RKL seems not to respond to email or snail mail, and so not having
  28. his permission to release my modified version, I have entirely rewritten the
  29. module.  In doing so I have fixed a number of bugs which were in the original
  30. and added many extra features, some of which were inspired by tcsh (and other
  31. UNIX shells) and 4DOS (for DOS!).
  32.  
  33. I'm still actively working on this program, so watch out for new versions.
  34. Please let me know if you find any bugs or problems (read this file first
  35. though!).  I'll release the source with future versions.
  36.  
  37. Files in this release:
  38.  
  39. !ReadMe    - this file
  40. LineEditor - the module
  41. RebindKeys - obey file to change key bindings
  42. Actions    - a list of the actions which can be bound to keys
  43. DfltKeys   - default key bindings
  44. OllyKeys   - the bindings I use -- provided as an example
  45. Rebinder   - used by RebindKeys -- don't run directly
  46. Zap131     - patch file to upgrade Zap 1.30's use of LineEditor's SWIs
  47.  
  48. The keys file has a very similar layout to the !Zap keys file.  The
  49. mechanism for rebinding is a bit nasty, and will be improved when I get
  50. some spare time.
  51.  
  52. For a list of the default key bindings, load the LineEditor module and type
  53. "*Help Editor".
  54.  
  55. Random note:  Ctrl-N is now mapped to Next-line (same as cursor down), and
  56. similarly for some other useful Ctrl-<letter> combinations.  Unless bound
  57. otherwise, Ctrl-Shift-<letter> is bound to "vanilla", which will input
  58. Ctrl-<letter>.  Alternatively, "quote" the keypress, e.g. Ctrl-Q Ctrl-N.
  59.  
  60. Use with Dom Symes' !Zap (see also !Zap's !Help file):
  61.  
  62. * To use function keys and Control + key you need to type Ctrl-Q first to
  63.   "Quote" the key - otherwise !Zap will process the key.  The cursor keys,
  64.   TAB and PageUp/PageDown are passed through and so don't need quoting.
  65.   !Zap 1.20 will also pass most Ctrl-Letter combinations through, although
  66.   it won't pass through keys that have certain actions bound to them (eg.
  67.   QUOTE).  See the !Zap documentation for a complete list.
  68.  
  69. * COPYing works - activated by the command COPY which is bound to COPY and
  70.   Shift-COPY by default.  From !Zap 1.20, pressing Escape during COPYing will
  71.   stop the copy, but not abort the line.  Press Escape again to abort the
  72.   line.  LineEditor behaves in the same way outside of TaskWindows.
  73.  
  74. * TaskWindows under RISC OS 2: The TaskWindow module supplied with !Edit on
  75.   RISC OS 2 Application Disc 1 (v 0.03) won't work with !Zap - you need the
  76.   one supplied with the C/Asm DDE (about 0.29) or above.  0.03 only works
  77.   with !Edit 1.00 and not very well.  The RISC OS 3.1 TaskWindow module
  78.   works best of all, but you can't legally get it without having RO 3.1...
  79.  
  80. * With the default keymap supplied with !Zap 1.10 and 1.20, Enter on the
  81.   numeric keypad acts like Ctrl-J in TaskWindows, ie the line isn't stored in
  82.   the history.  You can make it act like Return by altering the appropriate
  83.   line in the keys file from:
  84.    kENTER        &166    RETURN
  85.   to:
  86.    kENTER        &166    CHAR &0D
  87.   which makes Enter behave like Return in TaskWindows, and in other modes.
  88.  
  89. * Due to a minor bug in !Zap, Ctrl-Q Ctrl-@ in a TaskWindow gives an `R',
  90.   rather than setting the mark.  A work around is to use Ctrl-Q Ctrl-SPACE
  91.   instead in TaskWindows.
  92.  
  93. Use with Acorn's !Edit/!SrcEdit:
  94.  
  95. * !Edit/!SrcEdit TaskWindows don't "understand" the codes to move the cursor
  96.   left and right (&08 and &09) so things don't work terribly well.
  97.  
  98. * My version and RKL's seem to work equally well/badly (simple recall and
  99.   filename completion work okay).
  100.  
  101. * I don't think it's possible to work around not having VDU 8 - get !Zap if
  102.   you want to use TaskWindows much - it's much faster too!
  103.  
  104. Use with Alun Jones' !TaskShell:
  105.  
  106. * TaskShell 1.21 has very full VDU support (since it runs full screen and
  107.   uses the OS VDU calls).  It works well with LineEditor, except that
  108.   Ctrl/Shift + Tab combinations don't work as expected (Alun has acknowledged
  109.   this a due to a shortfall in TaskShell's emulation of the keyboard system).
  110.  
  111. * Unfortunately, TaskShell doesn't currently support cursor copying.
  112.  
  113. * LineEditor doesn't send codes to change cursor shape to TaskWindows (as
  114.   they are ignored by most servers and just slow things down a bit).  With
  115.   TaskShell, they would change the cursor shape, but it's not easy to tell
  116.   the difference between a TaskShell and a TaskWindow.
  117.  
  118. Use with Guttorm Vik's !StrongED:
  119.  
  120. * Recent versions of StrongED (I've tested with 4.11beta2) have improved
  121.   TaskWindow support, and support all the codes LineEditor requires.
  122.  
  123. * !StrongED support COPYing in TaskWindows, in much the same way as !Zap.
  124.  
  125. Use with Brian Brunswick's !VMode:
  126.  
  127. * VMode is a graphical desktop TaskWindow server.  It's a bit slow though.
  128.   Version 1.5 seems to work with LineEditor so long as you don't want to
  129.   use the cursor keys, the function keys, Tab, etc.
  130.  
  131. That's all the TaskWindow servers I am aware of.  If you know of any others,
  132. let me know and I'll check them out and add them to the list.
  133.  
  134. Use with RISC OS 2:
  135.  
  136. * I've added code to versions 2.34 and above to read the task handles of
  137.   TaskWindows under RISC OS 2, so local history buffers should now work.
  138.  
  139. * The TaskWindow modules supplied with RISC OS 2 and the Acorn C DDE (0.03
  140.   and 0.29 anyway) have a problem - if LineEditor is loaded, closing a
  141.   TaskWindow doesn't release the memory allocated to the task.  This would
  142.   seem to be a TaskWindow bug [it occurs if you soft-load 0.03 or 0.29 with
  143.   RISC OS 3.1, and with RKL's version].  My best advice (other than to get
  144.   RISC OS 3.1) is to reduce the next slot before starting a TaskWindow and
  145.   not to close task windows that you might want again.
  146.  
  147. * There's a problem with the cursor keys producing symbols rather than being
  148.   interpreted as cursor keys with some setups when using TaskWindow 0.29.
  149.  
  150. Comments and suggestions are greatly encouraged - email will get a reply (if
  151. I can get through), snail mail will eventually, but don't hold your breath. 
  152. Please try to give as much detail as possible in bug-reports - steps to
  153. demonstrate the bug from loading in the module are very helpful indeed.
  154.  
  155. Thanks to Andy Hayward, David Moore and Dom Symes for testing and comments.
  156. Also to Clive Jones for suggesting how to find the current task's handle
  157. under RISC OS 2 (though his idea didn't work ;) ).  Also, thanks to everyone
  158. who's reported bugs and problems, particularly Ian Palmer and Nick Craig-Wood
  159. who've been especially diligent.  And to Ben Summers for supplying some
  160. (slightly buggy) code for creating a dynamic area and maintaining a heap in
  161. it, and to OSLib's headers for telling me how to delete a dynamic area once
  162. I've got one.  And Mark Wooding for some code.
  163.  
  164. Note: Mantis' net feed is overloaded at present, so I'm not currently
  165. putting files on ftp.mantis.co.uk and I've disabled the auto-mailer.
  166. Our feed is due to be upgraded during October 1996, so the next 2
  167. paragraphs should then be true again.
  168.  
  169. You can obtain the latest ve