home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / elisp / epoch / tek-highlight-2.0 / README < prev    next >
Encoding:
Text File  |  1992-08-20  |  5.1 KB  |  148 lines
  1.         Documentation for tek-highlight-2.0.0
  2.         =====================================
  3.  
  4. This release is a bundle of emacs-lisp packages for epoch,
  5. all related to highlighting. A couple of packages may be of
  6. interest to non-epoch users, namely the syntax-decode stuff.
  7. 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. * Comment highlighting in source code buffers: comment structure is
  25. determined from the current syntax table; highlighting updated on
  26. find-file and save-buffer. Several other people have released comment
  27. highlighting packages, but this is the most complete & elegant
  28. solution I've seen. Because the comment structure is determined in a
  29. generic manner it will work with any editing mode that has a valid
  30. syntax table. I've tried to optimise it too, and it's reasonably quick.
  31.  
  32. * Highlighting in Dave Gillespies info browser: provides epoch
  33. highlighting for the info browser. Once again, this is the most complete
  34. implementation I've seen, and is reasonably quick (although
  35. suggestions for improving the speed of any of these packages are very
  36. welcome).
  37.  
  38. * File highlighting in dired buffers. Highlights files in dired
  39. buffers according to customizable criteria.
  40.  
  41. * Header highlighting in news articles displayed under GNUS.
  42. Highlights "From:" and "Subject:" fields in news articles.
  43.  
  44. * Header highlighting in mail messages displayed under VM. Highlights
  45. "From:" and "Subject:" fields in mail messages.
  46.  
  47. * Header highlighting in mail messages displayed under the mh-e
  48. mailreader. Highlights "From:" and "Subject:" fields in mail messages.
  49.  
  50. * Customisation of motion highlighting style. Allows you to change the
  51. style used to highlight mouse drag regions by setting X resources.
  52.  
  53. * The highlighting styles used in all of the above packages are
  54. initialised by a package which looks up the X resource database to
  55. find the appropriate option settings. All of the packages have
  56. sensible defaults though, so you can get started without settting up
  57. any X resources at all: on a color display different colors are used
  58. for highlighting; on a monochrome display an italic or bold font, the
  59. same height and width as the minibuffer font, is used for
  60. highlighting.  See the file tek-style-utils.el for details of how to
  61. customise your highlighting styles.
  62.  
  63.  
  64. Changes from tek-epoch-stuff 1.1.0
  65. ==================================
  66.  
  67. This package started out as tek-epoch-stuff, maintained by Ken Wood
  68. (kwood@austek.oz.au).  Unfortunately, the company that both Ken and I
  69. worked for went out of business.  Ken no longer has access to the
  70. Internet.
  71.  
  72. As Ken can no longer support the package, I have decided to re-release
  73. just the highlighting portion under a new name "tek-highlight".  I
  74. intend to re-release the mouse support under the name "tek-mouse" at a
  75. later date.
  76.  
  77. The main changes are:
  78.  
  79. * Automated the support for the epoch 4.0 button handling (i.e. use of
  80. styles directly instead of via attributes).
  81.  
  82. * Added highlighting support for dired.
  83.  
  84. * Removed the actual info browser - you should get the latest version
  85. from the elisp archive (info-dg: ~/modes/info.el.Z).  This package
  86. just supplies a highlighting interface to the info browser.  This
  87. package has been tested with version 1.04 of info-dg.
  88.  
  89. * Removed the manual browser support.  I haven't been able to track
  90. down the location of the original package.  I would rather support a
  91. highlighting interface to a manual browser than an actual manual
  92. browser itself.
  93.  
  94. * Removed all mouse support - to be put in a separate package called
  95. "tek-mouse".
  96.  
  97. * Corrected the spelling of "highlight" throughout the package.
  98.  
  99. Manifest
  100. ========
  101.  
  102. COPYING
  103. INSTALL
  104. LCD-entry
  105. README
  106. get-font.patch
  107. mh-e.patch
  108. syntax-decode.el
  109. tek-dired-highlight-setup.el
  110. tek-dired-highlight.el
  111. tek-gnus-highlight-setup.el
  112. tek-gnus-highlight.el
  113. tek-info-highlight-setup.el
  114. tek-info-highlight.el
  115. tek-mh-e-highlight-setup.el
  116. tek-mh-e-highlight.el
  117. tek-motion-highlight-setup.el
  118. tek-src-highlight-setup.el
  119. tek-src-highlight.el
  120. tek-style-utils.el
  121. tek-vm-highlight-setup.el
  122. tek-vm-highlight.el
  123. unique-hooks.el
  124.  
  125.  
  126. Other Details
  127. =============
  128.  
  129. The source code highlighting package uses a package written by Ken
  130. Wood called syntax-decode, which extracts the comment structure for
  131. the current major mode from the current syntax table. This package
  132. could easily be modified to extract other data from the syntax table
  133. as well, so let me know if you have a use for it.
  134.  
  135. This package also stores the data thus extracted in an alist, to avoid
  136. decoding the same syntax table more than once. This makes it a little
  137. faster in modes which it's seen before.
  138.  
  139.  
  140. Bugs
  141. ====
  142.  
  143. There are probably a few, so feel free to send me (Rod Whitby) a bug
  144. report at rwhitby@research.canon.oz.au.  I will try and look at it,
  145. but I won't promise anything.
  146.  
  147.                === The End ===
  148.