diff options
| -rw-r--r-- | INSTALL.md | 14 | ||||
| -rw-r--r-- | README.md | 15 | ||||
| -rw-r--r-- | autoload/xolox/easytags.vim | 4 | ||||
| -rw-r--r-- | doc/easytags.txt | 73 |
4 files changed, 70 insertions, 36 deletions
@@ -1,3 +1,13 @@ -If you're looking for the simplest way to get the plug-in up and running, download [the latest ZIP archive](http://peterodding.com/code/vim/downloads/easytags.zip) from [Vim Online](http://www.vim.org/scripts/script.php?script_id=3114), unzip that in `~/.vim/` (on UNIX) or `%USERPROFILE%\vimfiles` (on Windows) and you're good to go. +*Please note that the vim-easytags plug-in requires my vim-misc plug-in which is separately distributed.* -If you're using git and/or [Pathogen](http://www.vim.org/scripts/script.php?script_id=2332), [Vundle](https://github.com/gmarik/vundle) or a similar plug-in manager and want to keep the plug-in up to date using git, you can use the GitHub repository directly, it should just work. +Unzip the most recent ZIP archives of the [vim-easytags] [download-easytags] and [vim-misc] [download-misc] plug-ins inside your Vim profile directory (usually this is `~/.vim` on UNIX and `%USERPROFILE%\vimfiles` on Windows), restart Vim and execute the command `:helptags ~/.vim/doc` (use `:helptags ~\vimfiles\doc` instead on Windows). To get started execute `:Note` or `:edit note:`, this will start a new note that contains instructions on how to continue from there (and how to use the plug-in in general). + +If you prefer you can also use [Pathogen] [pathogen], [Vundle] [vundle] or a similar tool to install & update the [vim-easytags] [github-easytags] and [vim-misc] [github-misc] plug-ins using a local clone of the git repository. + + +[download-easytags]: http://peterodding.com/code/vim/downloads/easytags.zip +[download-misc]: http://peterodding.com/code/vim/downloads/misc.zip +[github-easytags]: http://github.com/xolox/vim-easytags +[github-misc]: http://github.com/xolox/vim-misc +[pathogen]: http://www.vim.org/scripts/script.php?script_id=2332 +[vundle]: https://github.com/gmarik/vundle @@ -8,7 +8,13 @@ There's just one problem: You have to manually keep your tags files up-to-date a ## Installation -Unzip the most recent [ZIP archive] [download] file inside your Vim profile directory (usually this is `~/.vim` on UNIX and `%USERPROFILE%\vimfiles` on Windows), restart Vim and execute the command `:helptags ~/.vim/doc` (use `:helptags ~\vimfiles\doc` instead on Windows). Now try it out: Edit any file type supported by Exuberant Ctags and within ten seconds the plug-in should create/update your tags file (`~/.vimtags` on UNIX, `~/_vimtags` on Windows) with the tags defined in the file you just edited! This means that whatever file you're editing in Vim (as long as it's on the local file system), tags will always be available by the time you need them! +*Please note that the vim-easytags plug-in requires my vim-misc plug-in which is separately distributed.* + +Unzip the most recent ZIP archives of the [vim-easytags] [download-easytags] and [vim-misc] [download-misc] plug-ins inside your Vim profile directory (usually this is `~/.vim` on UNIX and `%USERPROFILE%\vimfiles` on Windows), restart Vim and execute the command `:helptags ~/.vim/doc` (use `:helptags ~\vimfiles\doc` instead on Windows). + +If you prefer you can also use [Pathogen] [pathogen], [Vundle] [vundle] or a similar tool to install & update the [vim-easytags] [github-easytags] and [vim-misc] [github-misc] plug-ins using a local clone of the git repository. + +Now try it out: Edit any file type supported by Exuberant Ctags and within ten seconds the plug-in should create/update your tags file (`~/.vimtags` on UNIX, `~/_vimtags` on Windows) with the tags defined in the file you just edited! This means that whatever file you're editing in Vim (as long as it's on the local file system), tags will always be available by the time you need them! Additionally if the file you just opened is an AWK, C#, C, C++, Objective-C, Java, Lua, PHP, Python, Ruby, Shell, Tcl or Vim source file you should also notice that the function and type names defined in the file have been syntax highlighted. @@ -325,15 +331,19 @@ This software is licensed under the [MIT license](http://en.wikipedia.org/wiki/M [cursorhold]: http://vimdoc.sourceforge.net/htmldoc/autocmd.html#CursorHold [cygwin]: http://en.wikipedia.org/wiki/Cygwin [dll]: http://en.wikipedia.org/wiki/Dynamic-link_library -[download]: http://peterodding.com/code/vim/downloads/easytags.zip +[download-easytags]: http://peterodding.com/code/vim/downloads/easytags.zip +[download-misc]: http://peterodding.com/code/vim/downloads/misc.zip [e339]: http://vimdoc.sourceforge.net/htmldoc/message.html#E339 [exctags]: http://ctags.sourceforge.net/ +[github-easytags]: http://github.com/xolox/vim-easytags +[github-misc]: http://github.com/xolox/vim-misc [hlinks]: http://en.wikipedia.org/wiki/Hard_link [ide]: http://en.wikipedia.org/wiki/Integrated_development_environment [jsctags]: https://npmjs.org/package/jsctags [localtime]: http://vimdoc.sourceforge.net/htmldoc/eval.html#localtime() [messages]: http://vimdoc.sourceforge.net/htmldoc/message.html#:messages [neocomplcache]: http://www.vim.org/scripts/script.php?script_id=2620 +[pathogen]: http://www.vim.org/scripts/script.php?script_id=2332 [shell]: http://peterodding.com/code/vim/shell/ [slinks]: http://en.wikipedia.org/wiki/Symbolic_link [syn_groups]: http://vimdoc.sourceforge.net/htmldoc/syntax.html#group-name @@ -346,3 +356,4 @@ This software is licensed under the [MIT license](http://en.wikipedia.org/wiki/M [vim_fts]: http://ftp.vim.org/vim/runtime/syntax/ [vim_online]: http://www.vim.org/scripts/script.php?script_id=3114 [vimrc]: http://vimdoc.sourceforge.net/htmldoc/starting.html#vimrc +[vundle]: https://github.com/gmarik/vundle diff --git a/autoload/xolox/easytags.vim b/autoload/xolox/easytags.vim index 1372f2c..4db1a3c 100644 --- a/autoload/xolox/easytags.vim +++ b/autoload/xolox/easytags.vim @@ -1,9 +1,9 @@ " Vim script " Author: Peter Odding <peter@peterodding.com> -" Last Change: May 23, 2013 +" Last Change: May 25, 2013 " URL: http://peterodding.com/code/vim/easytags/ -let g:xolox#easytags#version = '3.3.5' +let g:xolox#easytags#version = '3.3.6' " Public interface through (automatic) commands. {{{1 diff --git a/doc/easytags.txt b/doc/easytags.txt index 70cdaf4..2f354ff 100644 --- a/doc/easytags.txt +++ b/doc/easytags.txt @@ -73,15 +73,23 @@ see if it would work -- surprisingly well I'm happy to report! *easytags-installation* Installation ~ -Unzip the most recent ZIP archive [6] file inside your Vim profile directory -(usually this is '~/.vim' on UNIX and '%USERPROFILE%\vimfiles' on Windows), -restart Vim and execute the command ':helptags ~/.vim/doc' (use ':helptags -~\vimfiles\doc' instead on Windows). Now try it out: Edit any file type -supported by Exuberant Ctags and within ten seconds the plug-in should -create/update your tags file ('~/.vimtags' on UNIX, '~/_vimtags' on Windows) -with the tags defined in the file you just edited! This means that whatever -file you're editing in Vim (as long as it's on the local file system), tags -will always be available by the time you need them! +Please note that the vim-easytags plug-in requires my vim-misc plug-in which +is separately distributed. + +Unzip the most recent ZIP archives of the vim-easytags [6] and vim-misc [7] +plug-ins inside your Vim profile directory (usually this is '~/.vim' on UNIX +and '%USERPROFILE%\vimfiles' on Windows), restart Vim and execute the command +':helptags ~/.vim/doc' (use ':helptags ~\vimfiles\doc' instead on Windows). + +If you prefer you can also use Pathogen [8], Vundle [9] or a similar tool to +install & update the vim-easytags [10] and vim-misc [11] plug-ins using a +local clone of the git repository. + +Now try it out: Edit any file type supported by Exuberant Ctags and within ten +seconds the plug-in should create/update your tags file ('~/.vimtags' on UNIX, +'~/_vimtags' on Windows) with the tags defined in the file you just edited! +This means that whatever file you're editing in Vim (as long as it's on the +local file system), tags will always be available by the time you need them! Additionally if the file you just opened is an AWK, C#, C, C++, Objective-C, Java, Lua, PHP, Python, Ruby, Shell, Tcl or Vim source file you should also @@ -105,7 +113,7 @@ A note about Windows ~ On Windows the |system()| function used by 'easytags.vim' causes a command prompt window to pop up while Exuberant Ctags is executing. If this bothers -you then you can install my shell.vim [7] plug-in which includes a DLL [8] +you then you can install my shell.vim [12] plug-in which includes a DLL [13] that works around this issue. Once you've installed both plug-ins it should work out of the box! Please let me know if this doesn't work for you. @@ -181,8 +189,8 @@ The *g:easytags_languages* option Exuberant Ctags supports many languages and can be extended via regular expression patterns, but for some languages separate tools with -ctags-compatible output exist (e.g. jsctags [9] for Javascript). To use these, -the executable and its arguments must be configured: +ctags-compatible output exist (e.g. jsctags [14] for Javascript). To use +these, the executable and its arguments must be configured: > let g:easytags_languages = { \ 'language': { @@ -417,14 +425,14 @@ your vimrc script, a file type plug-in, etc.): ------------------------------------------------------------------------------- The *g:easytags_resolve_links* option -UNIX has symbolic links [10] and hard links [11], both of which conflict with +UNIX has symbolic links [15] and hard links [16], both of which conflict with the concept of having one unique location for every identifier. With regards to hard links there's not much anyone can do, but because I use symbolic links quite a lot I've added this option. It's disabled by default since it has a small performance impact and might not do what unknowing users expect it to: When you enable this option the plug-in will resolve symbolic links in pathnames, which means your tags file will only contain entries with canonical -pathnames [12]. To enable this option (which I strongly suggest doing when you +pathnames [17]. To enable this option (which I strongly suggest doing when you run UNIX and use symbolic links) execute the following Vim command: > :let g:easytags_resolve_links = 1 @@ -455,11 +463,11 @@ about this. If you have suggestions, please feel free to submit them. Passing custom command line arguments to Exuberant Ctags ~ You may want to run Exuberant Ctags with specific command line options, for -example the code_complete [13] plug-in requires the signature field to be +example the code_complete [18] plug-in requires the signature field to be present. To do this you can create a configuration file for Exuberant Ctags, e.g. '~/.ctags' on UNIX or '%USERPROFILE%\ctags.cnf' on Windows. The file should contain one command line option per line. See the Exuberant Ctags -manual [14] for details. +manual [19] for details. ------------------------------------------------------------------------------- Update & highlight tags immediately after save ~ @@ -633,7 +641,7 @@ project directories. ------------------------------------------------------------------------------- The plug-in doesn't seem to work in Cygwin ~ -If you want to use the plug-in with Vim under Cygwin [15], you need to have +If you want to use the plug-in with Vim under Cygwin [20], you need to have the Cygwin version of Ctags installed instead of the Windows version (thanks to Alex Zuroff for reporting this!). @@ -644,13 +652,13 @@ Contact ~ If you have questions, bug reports, suggestions, etc. the author can be contacted at peter@peterodding.com. The latest version is available at http://peterodding.com/code/vim/easytags/ and http://github.com/xolox/vim-easytags. -If you like this plug-in please vote for it on Vim Online [16]. +If you like this plug-in please vote for it on Vim Online [21]. =============================================================================== *easytags-license* License ~ -This software is licensed under the MIT license [17]. Copyright 2013 Peter +This software is licensed under the MIT license [22]. Copyright 2013 Peter Odding <peter@peterodding.com>. =============================================================================== @@ -663,16 +671,21 @@ References ~ [4] http://ftp.vim.org/vim/runtime/syntax/ [5] http://ctags.sourceforge.net/languages.html [6] http://peterodding.com/code/vim/downloads/easytags.zip -[7] http://peterodding.com/code/vim/shell/ -[8] http://en.wikipedia.org/wiki/Dynamic-link_library -[9] https://npmjs.org/package/jsctags -[10] http://en.wikipedia.org/wiki/Symbolic_link -[11] http://en.wikipedia.org/wiki/Hard_link -[12] http://en.wikipedia.org/wiki/Canonicalization -[13] http://www.vim.org/scripts/script.php?script_id=1764 -[14] http://ctags.sourceforge.net/ctags.html#FILES -[15] http://en.wikipedia.org/wiki/Cygwin -[16] http://www.vim.org/scripts/script.php?script_id=3114 -[17] http://en.wikipedia.org/wiki/MIT_License +[7] http://peterodding.com/code/vim/downloads/misc.zip +[8] http://www.vim.org/scripts/script.php?script_id=2332 +[9] https://github.com/gmarik/vundle +[10] http://github.com/xolox/vim-easytags +[11] http://github.com/xolox/vim-misc +[12] http://peterodding.com/code/vim/shell/ +[13] http://en.wikipedia.org/wiki/Dynamic-link_library +[14] https://npmjs.org/package/jsctags +[15] http://en.wikipedia.org/wiki/Symbolic_link +[16] http://en.wikipedia.org/wiki/Hard_link +[17] http://en.wikipedia.org/wiki/Canonicalization +[18] http://www.vim.org/scripts/script.php?script_id=1764 +[19] http://ctags.sourceforge.net/ctags.html#FILES +[20] http://en.wikipedia.org/wiki/Cygwin +[21] http://www.vim.org/scripts/script.php?script_id=3114 +[22] http://en.wikipedia.org/wiki/MIT_License vim: ft=help |