home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / z / zap / !Zap / 3rdParty / Tyler / HTMLReadMe < prev    next >
Text File  |  1996-11-05  |  7KB  |  178 lines
  1.  
  2.          ZapHoTMeal - a !Zap syntax colouring mode for HTML files
  3.          ========================================================
  4.  
  5. Contents
  6. ========
  7.  
  8. 1.0 : Features.
  9. 2.0 : Installation.
  10. 3.0 : What it does.
  11. 4.0 : Customisation.
  12. 5.0 : Licence
  13. 6.0 : History
  14.  
  15. 1.0 Features
  16. ============
  17.  
  18. Extensive syntax colouring of the 'inside' of HTML tags.  Full support
  19. for HTML 3.2 tags (AFAIK).
  20.  
  21. There is Beautify option which forces the displayed case of recognised
  22. commands.
  23.  
  24. The Zap SAVEANDRUN and RUN commands now start up a new task and execute the
  25. file, loading it into a browser.
  26.  
  27. It is possible to customise the module to add your own tags and attributes.
  28.  
  29. Cursor key enhancements stolen from Martin Ebourne's modes (see later).
  30.  
  31. ZapHoTMeaL shares a number of features with my ZapObey mode and you are
  32. referred to this as a source of relevant documentation.
  33.  
  34. 2.0 Installation
  35. ================
  36.  
  37. Copy the module "ZapHoTMeaL" into an appropriately-named subdirectory of the
  38. "3rdParty" directory inside the !Zap application.
  39.  
  40. In the file called "External", in the directory "!Zap.Options.Default" or 
  41. wherever the variable Zap$External points to, add lines as follows:
  42.  
  43. <Zap$3rdParty>.Tyler.ZapHoTMeaL
  44.     HoTMeaL
  45.  
  46. ...in your !Zap.Options.Default.External file, and lines like:
  47.  
  48. HTML        &1345    HoTMeaL
  49. HTML        &1FAF    HoTMeaL
  50.  
  51. ...in your keys file.  !Zap will then need to be restarted.
  52.  
  53. 3.0 What it does and does not do
  54. ================================
  55.  
  56. There is Beautify option which can be ticked just off the mode menu.
  57. Setting this forces the displayed case of recognised commands to make the
  58. file more legible.  It does not affect the file, just the way it is
  59. displayed.
  60.  
  61. The module also contains some enhancements to the cursor keys so that when
  62. they are  used in combination with the shift key they behave in a more
  63. appropriate manner than when is in text mode.  These routines have been
  64. stolen from Martin Ebourne's C mode and are documented by him in his own 
  65. directory.  Basically they make the shift-cursor combinations pause more
  66. frequently and more intelligently step through the code.  As HTML files
  67. usually contain paths, this can come in useful.  Martin has kindly given me
  68. his permission to use his code.
  69.  
  70. When editing HTML in !Zap some users may find they benefit from the use of
  71. alternative keymaps.  This is currently left to the user's discretion.
  72.  
  73. This mode has now been tested on a RISC-PC, and problems with earlier
  74. versions have been resolved.  This is the first major release of
  75. ZapHoTMeaL where I welcome correspondence and bug reports.  However, please
  76. do not mail me to inform me that tags on word boundaries are not coloured
  77. properly, or that multi-line comments display badly, as I am fully aware of
  78. these shortcomings.
  79.  
  80. The "HTMLPRETTY" command (which was never documented) has now been removed
  81. from the ZapHoTMeaL module.
  82.  
  83. 4.0 Customisation
  84. =================
  85.  
  86. It is possible to add new tags to ZapHoTMeaL in a similar way to the manner
  87. in which ZapObey supports command extensions.
  88.  
  89. I have attempted to program this module in a manner which makes it as easy
  90. as possible for users to alter the list of commands which it recognises and
  91. highlights.
  92.  
  93. The list of recognised tags is stored at the very end of the module. 
  94. There is no user-interface provided for changing this list, but the module
  95. is hacker-friendly and if you are reasonably confident about what you are
  96. doing and find that there are some tags which the module is consistently
  97. not recognising, then it is possible to simply load the module directly
  98. into an editor, and change the list of recognised tags directly.
  99.  
  100. All three alphabetic lists of tags may be edited.  The start of each table
  101. MUST remain word aligned.  New commands should be inserted at their
  102. appropriate place in the alphabet.
  103.  
  104. 5.0 Licence
  105. ===========
  106.  
  107. This module is Freeware, and may be distributed freely provided that all
  108. files remain together and intact.
  109.  
  110. 6.0 Possible plans
  111. ==================
  112.  
  113. Add support for Darren Salt's CTRL-double-click protocol for launching
  114. browsers from URLs in the text.
  115.  
  116. Add a list of entities so these may be parsed and syntax-checked.
  117.  
  118. Fix problems associated with tags on line boundaries not being coloured
  119. properly.  This will not be easy, but would be a great improvement.
  120.  
  121. 6.0 History
  122. ===========
  123.  
  124. v0.42 (05-Nov-96)
  125.     * Got hold of the W3C HTML 3.2 spec (at last) and supported every tag,
  126.       attribute and attribute value contained therein.  This document is
  127.       a bit wishy-washy (and it does not even conform to its own spec) and
  128.       so I still do hot have a proper specification for the units attribute.
  129.     * Got hold of the "The bare bones guide to HTML" by Kevin Werbach from
  130.       "http://werbach.com/barebones/" and included all the tags and
  131.       attributes found there.  This includes Netscape's extensions included
  132.       in version 3.0 of their browser, including frames and Java.
  133.     * The downside to all this is that the new tags eat up extra memory.
  134.     * Parameters of Name= attributes are no longer ignored and are now
  135.       coloured like the opening and closing mark-up tags.  This also
  136.       applies to HRef=, Background= and Src= tags which are no longer
  137.       marked as unknown tags if their parameters are unquoted.
  138.     * Minor bug involving incorrect colouring of sequences like:
  139.       "<test;" where the "test" was coloured as an entity fixed.
  140.     * Triple alphabetic index now implented to improve speed.
  141.     * Internal revamp of the format so that markers are used to mark the
  142.       beginnings of the three tables.  This means all the tables may now be
  143.       easily edited by third parties if they feel the need to do this to
  144.       cope with extensions to HTML.  Note that the starts of the tables
  145.       MUST remain word-aligned.
  146.     * After some soul-searching, HTMLPretty now makes all tags appear in
  147.       upper case.  Attributes remain in mixed case for the moment.
  148.  
  149. v0.41 (01-Nov-96)
  150.     * Carriage returns (&0D) are now displayed properly and not as "!"s.
  151.     * Support for "Fig" tag "Lang" attribute added.
  152.     * Spaces are no longer stripped from the file by default.
  153.  
  154. v0.40 (29-Oct-96)
  155.     * Much improved syntax colouring on tags that wrap between lines.
  156.     * New colour added for the values of attributes in tags.
  157.     * A huge number of additional tags added after examining an HTML spec.
  158.     * Dual alphabetic index implented for improved redraw speed.
  159.     * Some unnecessary code removed resulting in a decrease in size.
  160.     * This file of documentation created.
  161.  
  162. v0.32 (27-Oct-96)
  163.     * Help ZapHotMeal no longer gives errors.
  164.     * A few additional tags added.
  165.  
  166. v0.31 (20-Oct-96) 
  167.     * Bugfix for RISC PC users experiencing occasional problems.
  168.     * Name changed from ZapHTML to ZapHoTMeaL.
  169.  
  170. v0.30 (28-Oct-95)
  171.     * First version.
  172.  
  173. Enjoy
  174.  _____  __  __  _____               The Mandala Centre,
  175. |_   _||  \/  ||_   _|  11 Alexandra Road, Clifton, Bristol, BS8 2DD.
  176.   | |  | |\/| |  | |              tim@varuna.demon.co.uk
  177.   |_|  |_|  |_|  |_|         http://www.varuna.demon.co.uk/tmc/
  178.