home *** CD-ROM | disk | FTP | other *** search
/ vim.ftp.fu-berlin.de / 2015-02-03.vim.ftp.fu-berlin.de.tar / vim.ftp.fu-berlin.de / mac / vim54rt.sit / runtime / syntax / README.txt < prev    next >
Encoding:
Text File  |  1999-08-14  |  2.0 KB  |  54 lines  |  [TEXT/ALFA]
  1. This directory contains vim scripts for specific languages.
  2.  
  3. syntax.vim    Used for the ":syntax on" command.  Uses synload.vim.
  4.  
  5. manual.vim    Used for the ":syntax manual" command.  Uses synload.vim.
  6.  
  7. synload.vim    Contains autocommands to load a language file when a certain
  8.         file name (extension) is used.  And sets up the Syntax menu
  9.         for the GUI.
  10.  
  11. nosyntax.vim    Used for the ":syntax off" command.  Undo the loading of
  12.         synload.vim.
  13.  
  14.  
  15. A few special files:
  16.  
  17. 2html.vim    Converts any highlighted file to HTML (GUI only).
  18. colortest.vim    Check for color names and actual color on screen.
  19. hitest.vim    View the current highlight settings.
  20. whitespace.vim  View Tabs and Spaces.
  21.  
  22.  
  23. If you want to add your own syntax file for your personal use, read the docs
  24. at ":help mysyntaxfile".
  25.  
  26. If you make a new syntax file which would be useful for others, please send it
  27. to Bram@vim.org.  Include instructions for detecting the file type for this
  28. language, by file name extension or by checking a few lines in the file.
  29. And please stick to the rules below.
  30.  
  31.  
  32. Rules for making a syntax file:
  33. - Use the same layout as the other syntax files.
  34. - The name of the file must be the same as the head of the group names in the
  35.   file.  This avoids using the same group name as another syntax file.  Use
  36.   the same name for the string that b:current_syntax is set to.  Always use
  37.   lower case.
  38. - Start with a "syntax clear".
  39. - Do not include anything that is a user preference.
  40. - Do not include mappings or abbreviations.  Only include setting 'iskeyword'
  41.   if it is really necessary for recognizing keywords.
  42. - Avoid using specific colors.  Use the standard highlight groups whenever
  43.   possible.  Don't forget that some people use a different background color,
  44.   or have only eight colors available.
  45.  
  46. If you have remarks about an existing file, send them to the maintainer of
  47. that file.  Only when you get no response send a message to Bram@vim.org.
  48.  
  49. If you are the maintainer of a syntax file and make improvements, send the new
  50. version to Bram@vim.org.
  51.  
  52.  
  53. For further info see ":help syntax" in Vim.
  54.