home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / elisp / epoch / tek-epoch-stuff / README < prev    next >
Encoding:
Text File  |  1991-12-11  |  4.6 KB  |  136 lines
  1.         Documentation for tek-epoch-stuff1.1.0
  2.         ======================================
  3.  
  4. This release is a bundle of emacs-lisp packages for epoch,
  5. mainly related to highlighting. A couple of packages may be of
  6. interest to non-epoch users, namely the manual browser and the
  7. syntax-decode stuff. Read on for details.
  8.  
  9. Note: much of this code is based on code originally written by others.
  10. Though I won't mention them here, their names are preserved in the
  11. source files and I'd like to thank them for their efforts.
  12.  
  13. For instructions on how to install & use the packages in this release,
  14. see the file INSTALL. The remainder of this file is documentation on
  15. the packages themselves.
  16.  
  17.  
  18. In Brief
  19. ========
  20.  
  21. Here is a list of the packages included, and a brief overview of their
  22. features:
  23.  
  24. * Enhanced manual browser: runs in background; supports multiple man
  25. buffers; man buffers are in a special mode with local key & mouse
  26. bindings; sections of man page are highlighted under epoch. I know
  27. there are a lot of manual browsers out there, but I think this one is
  28. pretty neat - check it out and tell me what you think.
  29.  
  30. * Comment highlighting in source code buffers: comment structure is
  31. determined from the current syntax table; highlighting updated on
  32. find-file and save-buffer. Several other people have released comment
  33. highlighting packages, but this is the most complete & elegant
  34. solution I've seen. Because the comment structure is determined in a
  35. generic manner it will work with any editing mode that has a valid
  36. syntax table. I've tried to optimise it too, and it's reasonably quick.
  37.  
  38. * Interface to Dave Gillespies info browser (included): provides epoch
  39. mouse bindings and highlighting. Once again, this is the most complete
  40. implementation I've seen, and is reasonably quick (although
  41. suggestions for improving the speed of any of these packages are very
  42. welcome).
  43.  
  44. * Header highlighting in news articles displayed under GNUS.
  45. Highlights "From:" and "Subject:" fields in news articles.
  46.  
  47. * Header highlighting in mail messages displayed under VM. Highlights
  48. "From:" and "Subject:" fields in mail messages.
  49.  
  50. * Header highlighting in mail messages displayed under the mh-e
  51. mailreader. Highlights "From:" and "Subject:" fields in mail messages.
  52.  
  53. * Customisation of motion highlighting style. Allows you to change the
  54. style used to highlight mouse drag regions by setting X resources.
  55.  
  56. * The highlighting styles used in all of the above packages are
  57. initialised by a package which looks up the X resource database to
  58. find the appropriate option settings. All of the packages have
  59. sensible defaults though, so you can get started without settting up
  60. any X resources at all: on a color display different colors are used
  61. for highlighting; on a monochrome display an italic or bold font, the
  62. same height and width as the minibuffer font, is used for
  63. highlighting.  See the file tek-style-utils.el for details of how to
  64. customise your highlighting styles.
  65.  
  66.  
  67. Changes from 1.0.0
  68. ==================
  69.  
  70. * Merged in support for the epoch 4.0 button handling (i.e. use of
  71. styles directly instead of via attributes). A variable is used to
  72. select between the two behaviours - see INSTALL for details.
  73.  
  74. * Added highlighting under mh-e. Thanks to Mike Burgett
  75. <burgett@adobe.com> for this.
  76.  
  77.  
  78. Manifest
  79. ========
  80.  
  81. COPYING
  82. INSTALL
  83. LCD-entry
  84. README
  85. epoch-running.el
  86. get-font.patch
  87. maclib-toolbox.el
  88. mh-e.el
  89. mh-e.patch
  90. syntax-decode.el
  91. tek-gnus-hilite-setup.el
  92. tek-gnus-hilite.el
  93. tek-info-buttons.el
  94. tek-info-setup.el
  95. tek-info.el
  96. tek-man-setup.el
  97. tek-man.el
  98. tek-mh-e-hilite-setup.el
  99. tek-mh-e-hilite.el
  100. tek-motion-setup.el
  101. tek-src-hilite-setup.el
  102. tek-src-hilite.el
  103. tek-style-utils.el
  104. tek-vm-hilite-setup.el
  105. tek-vm-hilite.el
  106.  
  107.  
  108. Other Details
  109. =============
  110.  
  111. The source code highlighting package uses a package I wrote called
  112. syntax-decode, which extracts the comment structure for the current
  113. major mode from the current syntax table. This package could easily be
  114. modified to extract other data from the syntax table as well, so let
  115. me know if you have a use for it.
  116.  
  117. This package also stores the data thus extracted in an alist, to avoid
  118. decoding the same syntax table more than once. This makes it a little
  119. faster in modes which it's seen before.
  120.  
  121.  
  122. Bugs
  123. ====
  124.  
  125. There are probably a few, so feel free to send me (Ken Wood) a bug
  126. report at kwood@austek.oz.au . I will try and look at it, but I won't
  127. promise anything.
  128.  
  129. In particular, the manual browser could probably do with a bit more
  130. work. Several people have sent me suggestions, but I haven't had a
  131. chance to include them yet. Feel free to improve upon it if you choose
  132. - please send me a copy of your mods in this case.
  133.  
  134.  
  135.                === The End ===
  136.