Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Document vim-misc as external dependency (needs to be installed separ…

…ately from now on)
  • Loading branch information...
commit ebf637d839e05a62cddad6b878d8b3c3e7222067 1 parent a83d240
@xolox authored
Showing with 76 additions and 28 deletions.
  1. +12 −2 INSTALL.md
  2. +36 −12 README.md
  3. +28 −14 doc/luainspect.txt
View
14 INSTALL.md
@@ -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/lua-inspect.zip) from [Vim Online](http://www.vim.org/scripts/script.php?script_id=3169), unzip that in `~/.vim/` (on UNIX) or `%USERPROFILE%\vimfiles` (on Windows) and you're good to go.
+*Please note that the vim-lua-inspect 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-lua-inspect] [download-lua-inspect] 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-lua-inspect] [github-lua-inspect] and [vim-misc] [github-misc] plug-ins using a local clone of the git repository.
+
+
+[download-lua-inspect]: http://peterodding.com/code/vim/downloads/lua-inspect.zip
+[download-misc]: http://peterodding.com/code/vim/downloads/misc.zip
+[github-lua-inspect]: http://github.com/xolox/vim-lua-inspect
+[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
View
48 README.md
@@ -1,6 +1,6 @@
# Semantic highlighting for Lua in Vim
-The Vim plug-in `luainspect.vim` uses the [LuaInspect](http://lua-users.org/wiki/LuaInspect) tool to (automatically) perform semantic highlighting of variables in Lua source code. It was inspired by [lua2-mode](http://www.enyo.de/fw/software/lua-emacs/lua2-mode.html) (for [Emacs](http://www.gnu.org/software/emacs/)) and the [SciTE](http://www.scintilla.org/SciTE.html) plug-in included with LuaInspect. In addition to the semantic highlighting the following features are currently supported:
+The Vim plug-in `luainspect.vim` uses the [LuaInspect] [lua-inspect] tool to (automatically) perform semantic highlighting of variables in Lua source code. It was inspired by [lua2-mode] [lua2-mode] (for [Emacs] [emacs]) and the [SciTE] [scite] plug-in included with LuaInspect. In addition to the semantic highlighting the following features are currently supported:
* Press `<F2>` with the text cursor on a variable and the plug-in will prompt you to rename the variable.
@@ -8,11 +8,11 @@ The Vim plug-in `luainspect.vim` uses the [LuaInspect](http://lua-users.org/wiki
* When you hover over a variable with the mouse cursor in graphical Vim, information about the variable is displayed in a tooltip.
- * If the text cursor is on a variable while the highlighting is refreshed then all occurrences of the variable will be marked in the style of [Vim's cursorline option](http://vimdoc.sourceforge.net/htmldoc/options.html#%27cursorline%27).
+ * If the text cursor is on a variable while the highlighting is refreshed then all occurrences of the variable will be marked in the style of [Vim's cursorline option] [cursorline].
* When luainspect reports a wrong argument count for a function call the text will be highlighted with a green underline. When you hover over the highlighted text a tooltip shows the associated warning message.
- * When LuaInspect reports warnings about unused variables, wrong argument counts, etc. they are shown in a [location list window](http://vimdoc.sourceforge.net/htmldoc/quickfix.html#location-list).
+ * When LuaInspect reports warnings about unused variables, wrong argument counts, etc. they are shown in a [location list window] [location-list].
* When a syntax error is found (during highlighting or using the rename functionality) the lines where the error is reported will be marked like a spelling error.
@@ -20,9 +20,15 @@ The Vim plug-in `luainspect.vim` uses the [LuaInspect](http://lua-users.org/wiki
## Installation
-Unzip the most recent [ZIP archive](http://peterodding.com/code/vim/downloads/lua-inspect.zip) 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 a Lua file and within a few seconds semantic highlighting should be enabled automatically!
+*Please note that the vim-lua-inspect plug-in requires my vim-misc plug-in which is separately distributed.*
-Note that on Windows a command prompt window pops up whenever LuaInspect is run as an external process. If this bothers you then you can install my [shell.vim](http://peterodding.com/code/vim/shell/) plug-in which includes a [DLL](http://en.wikipedia.org/wiki/Dynamic-link_library) that works around this issue. Once you've installed both plug-ins it should work out of the box!
+Unzip the most recent ZIP archives of the [vim-lua-inspect] [download-lua-inspect] 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-lua-inspect] [github-lua-inspect] and [vim-misc] [github-misc] plug-ins using a local clone of the git repository.
+
+Now try it out: Edit a Lua file and within a few seconds semantic highlighting should be enabled automatically!
+
+Note that on Windows a command prompt window pops up whenever LuaInspect is run as an external process. If this bothers you then you can install my [shell.vim] [vim-shell] plug-in which includes a [DLL] [dll] that works around this issue. Once you've installed both plug-ins it should work out of the box!
## Usage
@@ -45,7 +51,7 @@ You don't need to use this command unless you've disabled automatic highlighting
* <span style="border-bottom: 1px dotted green">luaInspectWrongArgCount</span>
* <span style="border-bottom: 1px dotted red">luaInspectSyntaxError</span>
-If you don't like one or more of the default styles the Vim documentation [describes how to change them](http://vimdoc.sourceforge.net/htmldoc/syntax.html#:hi-default). If you want to disable the semantic highlighting in a specific Vim buffer execute `:LuaInspect!` in that buffer. When you want to re-enable the highlighting execute `:LuaInspect` again, but now without the [bang](http://vimdoc.sourceforge.net/htmldoc/map.html#:command-bang).
+If you don't like one or more of the default styles the Vim documentation [describes how to change them] [hi-default]. If you want to disable the semantic highlighting in a specific Vim buffer execute `:LuaInspect!` in that buffer. When you want to re-enable the highlighting execute `:LuaInspect` again, but now without the [bang (!)] [bang].
### The `:LuaInspectToggle` command
@@ -60,19 +66,19 @@ By default the semantic highlighting and the warning messages in the location li
### The `g:loaded_luainspect` option
-This variable isn't really an option but if you want to avoid loading the `luainspect.vim` plug-in you can set this variable to any value in your [vimrc script](http://vimdoc.sourceforge.net/htmldoc/starting.html#vimrc):
+This variable isn't really an option but if you want to avoid loading the `luainspect.vim` plug-in you can set this variable to any value in your [vimrc script] [vimrc]:
:let g:loaded_luainspect = 1
### The `g:lua_inspect_warnings` option
-When LuaInspect reports warnings about unused variables, wrong argument counts, etc. they are automatically shown in a [location list window](http://vimdoc.sourceforge.net/htmldoc/quickfix.html#location-list). If you don't like this add the following to your [vimrc script](http://vimdoc.sourceforge.net/htmldoc/starting.html#vimrc):
+When LuaInspect reports warnings about unused variables, wrong argument counts, etc. they are automatically shown in a [location list window] [location-list]. If you don't like this add the following to your [vimrc script] [vimrc]:
:let g:lua_inspect_warnings = 0
### The `g:lua_inspect_events` option
-By default semantic highlighting is automatically enabled after a short timeout and when you save a buffer. If you want to disable automatic highlighting altogether add the following to your [vimrc script](http://vimdoc.sourceforge.net/htmldoc/starting.html#vimrc):
+By default semantic highlighting is automatically enabled after a short timeout and when you save a buffer. If you want to disable automatic highlighting altogether add the following to your [vimrc script] [vimrc]:
:let g:lua_inspect_events = ''
@@ -84,18 +90,36 @@ Note that this only works when the plug-in is loaded (or reloaded) *after* setti
### The `g:lua_inspect_internal` option
-The plug-in uses the Lua interface for Vim when available so that it doesn't have to run LuaInspect as an external program (which can slow things down). If you insist on running LuaInspect as an external program you can set this variable to false (0) in your [vimrc script](http://vimdoc.sourceforge.net/htmldoc/starting.html#vimrc):
+The plug-in uses the Lua interface for Vim when available so that it doesn't have to run LuaInspect as an external program (which can slow things down). If you insist on running LuaInspect as an external program you can set this variable to false (0) in your [vimrc script] [vimrc]:
:let g:lua_inspect_internal = 0
## 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/lua-inspect/> and <http://github.com/xolox/vim-lua-inspect>. If you like this plug-in please vote for it on [Vim Online](http://www.vim.org/scripts/script.php?script_id=3169).
+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/lua-inspect/> and <http://github.com/xolox/vim-lua-inspect>. If you like this plug-in please vote for it on [Vim Online] [vim-online].
## License
-This software is licensed under the [MIT license](http://en.wikipedia.org/wiki/MIT_License).
+This software is licensed under the [MIT license] [mit].
© 2013 Peter Odding &lt;<peter@peterodding.com>&gt;.
+[bang]: http://vimdoc.sourceforge.net/htmldoc/map.html#:command-bang
+[cursorline]: http://vimdoc.sourceforge.net/htmldoc/options.html#%27cursorline%27
+[dll]: http://en.wikipedia.org/wiki/Dynamic-link_library
+[download-lua-inspect]: http://peterodding.com/code/vim/downloads/lua-inspect.zip
+[download-misc]: http://peterodding.com/code/vim/downloads/misc.zip
+[emacs]: http://www.gnu.org/software/emacs/
+[github-lua-inspect]: http://github.com/xolox/vim-lua-inspect
+[github-misc]: http://github.com/xolox/vim-misc
+[hi-default]: http://vimdoc.sourceforge.net/htmldoc/syntax.html#:hi-default
+[location-list]: http://vimdoc.sourceforge.net/htmldoc/quickfix.html#location-list
+[lua-inspect]: http://lua-users.org/wiki/LuaInspect
+[lua2-mode]: http://www.enyo.de/fw/software/lua-emacs/lua2-mode.html
+[mit]: http://en.wikipedia.org/wiki/MIT_License
+[pathogen]: http://www.vim.org/scripts/script.php?script_id=2332
+[scite]: http://www.scintilla.org/SciTE.html
+[vim-online]: http://www.vim.org/scripts/script.php?script_id=3169
+[vim-shell]: http://peterodding.com/code/vim/shell/
[vimrc]: http://vimdoc.sourceforge.net/htmldoc/starting.html#vimrc
+[vundle]: https://github.com/gmarik/vundle
View
42 doc/luainspect.txt
@@ -56,15 +56,24 @@ following features are currently supported:
*luainspect-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 a Lua file and
-within a few seconds semantic highlighting should be enabled automatically!
+Please note that the vim-lua-inspect plug-in requires my vim-misc plug-in
+which is separately distributed.
+
+Unzip the most recent ZIP archives of the vim-lua-inspect [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-lua-inspect [10] and vim-misc [11] plug-ins using a
+local clone of the git repository.
+
+Now try it out: Edit a Lua file and within a few seconds semantic highlighting
+should be enabled automatically!
Note that on Windows a command prompt window pops up whenever LuaInspect is
run as an external process. If this bothers you then you can install my
-shell.vim [7] plug-in which includes a DLL [8] that works around this issue.
+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!
===============================================================================
@@ -111,7 +120,7 @@ If you don't like one or more of the default styles the Vim documentation
describes how to change them (see |:hi-default|). If you want to disable the
semantic highlighting in a specific Vim buffer execute ':LuaInspect!' in that
buffer. When you want to re-enable the highlighting execute |:LuaInspect|
-again, but now without the bang (see |:command-bang|).
+again, but now without the bang (!) (see |:command-bang|).
-------------------------------------------------------------------------------
The *:LuaInspectToggle* command
@@ -183,14 +192,14 @@ 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/lua-inspect/ and http://github.com/xolox/vim-lua-inspect.
-If you like this plug-in please vote for it on Vim Online [9].
+If you like this plug-in please vote for it on Vim Online [14].
===============================================================================
*luainspect-license*
License ~
-This software is licensed under the MIT license [10]. Š 2013 Peter Odding
-<peter@peterodding.com>.
+This software is licensed under the MIT license [15]. Copyright 2013 Peter
+Odding <peter@peterodding.com>.
===============================================================================
*luainspect-references*
@@ -202,9 +211,14 @@ References ~
[4] http://www.scintilla.org/SciTE.html
[5] http://peterodding.com/code/vim/luainspect/screenshot.png
[6] http://peterodding.com/code/vim/downloads/lua-inspect.zip
-[7] http://peterodding.com/code/vim/shell/
-[8] http://en.wikipedia.org/wiki/Dynamic-link_library
-[9] http://www.vim.org/scripts/script.php?script_id=3169
-[10] 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-lua-inspect
+[11] http://github.com/xolox/vim-misc
+[12] http://peterodding.com/code/vim/shell/
+[13] http://en.wikipedia.org/wiki/Dynamic-link_library
+[14] http://www.vim.org/scripts/script.php?script_id=3169
+[15] http://en.wikipedia.org/wiki/MIT_License
vim: ft=help
Please sign in to comment.
Something went wrong with that request. Please try again.