home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 4 / DATAFILE_PDCD4.iso / utilities / utilst / texturgdn / Extras / ZapTexture / !Help next >
Text File  |  1996-09-28  |  3KB  |  83 lines
  1.  
  2.                        !Help file for ZapTexture
  3.                        =========================
  4.  
  5. 1.0 : Features.
  6. 2.0 : Installation.
  7. 3.0 : What it does.
  8.  
  9. 1.0 Features
  10. ============
  11. True syntax colouring for Texture Garden files and support for textures from
  12. Studio24 Pro.
  13.  
  14. There is "Beautify" option which forces the displayed case of recognised
  15. commands to a pattern that enhances the readability of texture files.
  16.  
  17. Cursor key enhancements stolen from Martin Ebourne's modes (see later).
  18.  
  19. If you have a copy of Studio24 Pro then the module works with textures from
  20. that program as well.  It keeps its textures in a "Textures" directory too.
  21. The "Beautify" option is useful for Studio24 Pro texture files.
  22.  
  23. 2.0 Installation
  24. ================
  25. Copy the module "ZapTexture" into an appropriately-named sub-directory of the
  26. "3rdParty" directory inside the Zap application.
  27.  
  28. In the file called "External", in the directory "!Zap.Options.Default" or 
  29. wherever the variable Zap$External points to, add lines as follows:
  30.  
  31. <Zap$3rdParty>.Tyler.ZapTexture
  32.     Texture
  33.  
  34. This tells Zap about the new mode.
  35. Zap's "Keys" file should be edited as follows:
  36.  
  37.     &5XX    &FFF    \#\*.Textures.\#\*    +Texture
  38.  
  39. at the appropriate point in the file.
  40.  
  41. If your version of Zap is earlier than Zap 1.30 then you will need to edit
  42. your !Run file to include a command to load the module.  Then, the next time
  43. Zap is loaded Obey files or desktop boot files (or any other filetypes you
  44. have told Zap about will be loaded into the new mode and come out all
  45. rainbow-hued.
  46.  
  47. 3.0 What it does
  48. ================
  49. When the module does not know about a command it colours it differently from
  50. normal commands to indicate that it has not been recognised.  This enables
  51. the module to be used as a spell-checker and, to a limited extent, a syntax
  52. checker.  The rule, as with most zap modes, is that if it is coloured
  53. incorrectly, then it needs examining.  If it is coloured it as though it is
  54. right, this does not mean it will actually work.
  55.  
  56. The module also contains some enhancements to the cursor keys so that when
  57. they are  used in combination with the shift key they behave in a more
  58. appropriate manner than when is in text mode.  These routines have been
  59. stolen from Martin Ebourne's C mode and are documented by him in his own
  60. directory inside !Zap.  Basically they make the shift-cursor combinations
  61. pause more frequently so they setep more intelligently through lines with few
  62. spaces.  Martin has kindly given me his permission to use his code.
  63.  
  64. The module has difficulties in displaying lines that wrap around the
  65. screen in the correct colours.  I hope to reduce the unsightliness of this
  66. effect as soon as possible.
  67.  
  68. For technical details on the module, users are referred to the documentation
  69. to ZapObey which has a very similar internal structure.  This should be
  70. available from my web site if you can't find it anywhere else.
  71.  
  72. Enjoy.
  73.  
  74.  _____  __  __  _____
  75. |_   _||  \/  ||_   _|
  76.   | |  | |\/| |  | |
  77.   |_|  |_|  |_|  |_|
  78.  
  79. © Tim Tyler 1996.
  80. tim@varuna.demon.co.uk
  81. http://www.varuna.demon.co.uk/tmc
  82.  
  83.