Skip to content
This repository
Browse code

Document the highlighting groups used by the plug-in

  • Loading branch information...
commit 2a2cba0eb258b284d448e20e94d7e0bc6156a5bd 1 parent ea6efd6
Peter Odding authored February 24, 2011

Showing 1 changed file with 15 additions and 1 deletion. Show diff stats Hide diff stats

  1. 16  README.md
16  README.md
Source Rendered
@@ -84,7 +84,7 @@ Exuberant Ctags knows how to generate tags for struct/class members in C++ and J
84 84
 
85 85
     :let g:easytags_include_members = 1
86 86
 
87  
-Exuberant Ctags will be instructed to include struct/class members using the `--extra=+q` command line argument and the `easytags.vim` plug-in will highlight them using the `cMember` highlighting group. Because most color schemes don't distinguish the [Identifier and Type](http://vimdoc.sourceforge.net/htmldoc/syntax.html#group-name) highlighting groups all members will now probably look like type definitions. You can change that by executing any of the following Vim commands (from your vimrc script, a file type plug-in, etc.):
  87
+Exuberant Ctags will be instructed to include struct/class members using the `--extra=+q` command line argument and the `easytags.vim` plug-in will highlight them using the `cMember` highlighting group. Because most color schemes don't distinguish the [Identifier and Type](http://vimdoc.sourceforge.net/htmldoc/syntax.html#group-name) highlighting groups all members will now probably look like type definitions. You can change that by executing either of the following Vim commands (from your vimrc script, a file type plug-in, etc.):
88 88
 
89 89
     " If you like one of the existing styles you can link them:
90 90
     highlight link cMember Special
@@ -98,6 +98,20 @@ UNIX has [symbolic links](http://en.wikipedia.org/wiki/Symbolic_link) and [hard
98 98
 
99 99
     :let g:easytags_resolve_links = 1
100 100
 
  101
+### How to customize the highlighting colors?
  102
+
  103
+The easytags plug-in defines new highlighting groups for dynamically highlighted tags. These groups are linked to Vim's default groups so that they're colored out of the box, but if you want you can change the styles. To do so use a `highlight` command such as the ones given a few paragraphs back. Of course you'll need to change the group name. Here are the group names used by the easytags plug-in:
  104
+
  105
+ * **Lua:** `luaFuncTag`
  106
+ * **C:** `cTypeTag`, `cEnumTag`, `cPreProcTag`, `cFunctionTag`, `cMemberTag`
  107
+ * **PHP:** `phpFunctionsTag`, `phpClassesTag`
  108
+ * **Vim:** `vimAutoGroupTag`, `vimCommandTag`, `vimFuncNameTag`, `vimScriptFuncNameTag`
  109
+ * **Python:** `pythonFunctionTag`, `pythonMethodTag`, `pythonClassTag`
  110
+ * **Java:** `javaClassTag`, `javaMethodTag`
  111
+ * **C#:** `csClassOrStructTag`, `csMethodTag`
  112
+
  113
+As you can see each of these names ends in `Tag` to avoid conflicts with the syntax modes shipped with Vim. And about the singular/plural confusion: I've tried to match the existing highlighting groups defined by popular syntax modes (except of course for the `Tag` suffix).
  114
+
101 115
 ## Troubleshooting
102 116
 
103 117
 ### `:HighlightTags` only works for the tags file created by `:UpdateTags`

0 notes on commit 2a2cba0

Please sign in to comment.
Something went wrong with that request. Please try again.