home *** CD-ROM | disk | FTP | other *** search
/ APDL Public Domain 1 / APDL_PD1A.iso / graphics / texturgdn / Extras / ZapTexture / !ZapT_Help next >
Encoding:
Text File  |  1996-10-12  |  3.5 KB  |  91 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 by inserting:
  36.  
  37.     &5XX    &FFF    \#\*.Textures.\#\*    +Texture
  38.  
  39. at the appropriate point in the file.  "&5XX" should be changed to the
  40. smallest number not ptesent in the existing list.  !Zap should then be
  41. restarted.
  42.  
  43. If your version of !Zap is earlier than !Zap 1.30 then you will need to edit
  44. your !Run file to include a command to load the module.  Then, the next time
  45. !Zap is loaded Obey files or desktop boot files (or any other filetypes you
  46. have told !Zap about will be loaded into the new mode.
  47.  
  48. 3.0 What it does
  49. ================
  50. When the module does not know about a command it colours it differently from
  51. normal commands to indicate that it has not been recognised.  This enables
  52. the module to be used as a spell-checker and, to a limited extent, a syntax
  53. checker.  The rule, as with most zap modes, is that if it is coloured
  54. incorrectly, then it needs examining.  If it is coloured it as though it is
  55. right, this does not mean it will actually work.
  56.  
  57. The module also contains some enhancements to the cursor keys so that when
  58. they are  used in combination with the shift key they behave in a more
  59. appropriate manner than when !Zap is in text mode.  These routines have been
  60. stolen from Martin Ebourne's C mode and are documented by him in his own
  61. directory inside !Zap.  Basically they make the shift-cursor combinations
  62. pause more frequently so they step more intelligently through lines with few
  63. spaces.  Martin has kindly given me his permission to use his code.
  64.  
  65. The module has difficulties in displaying lines that wrap around the
  66. screen in the correct colours.  Consequently, the module is not at its best
  67. when used at low widths.
  68.  
  69. Those familiar with my other !Zap modes may be wondering where the
  70. equivalent to their BEAUTIFY command is.  As Texture Garden provides much of
  71. the functionality of this command in its export text options, it has been
  72. stripped out of the !Zap mode to save space.  The Beautify menu option
  73. remains, however, and those pining for the BEAUTIFY command will find that
  74. SHIFT-CTRL-COPY can be used to produce a similar effect.
  75.  
  76. For technical details on the module, users are referred to the documentation
  77. to ZapObey which has a very similar internal structure.  This should be
  78. available from my web site if you can't find it anywhere else.
  79.  
  80. Enjoy.
  81.  
  82.  _____  __  __  _____
  83. |_   _||  \/  ||_   _|
  84.   | |  | |\/| |  | |
  85.   |_|  |_|  |_|  |_|
  86.  
  87. © Tim Tyler 1996.
  88. tim@varuna.demon.co.uk
  89. http://www.varuna.demon.co.uk/tmc
  90.  
  91.