Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Updated the readme and help file.

  • Loading branch information...
commit 62a2fd103f1fcfdda9a01af22d2a8131e364ad98 1 parent 7826042
Nate Kane authored
Showing with 26 additions and 15 deletions.
  1. +10 −5 README.markdown
  2. +16 −10 doc/indent_guides.txt
15 README.markdown
View
@@ -7,8 +7,9 @@ Indent Guides is a plugin for visually displaying indent levels in Vim.
* Will highlight indent levels with alternating colors.
* Full support for gVim and basic support for Terminal Vim.
* Seems to work on Windows gVim 7.3 (haven't done any extensive tests though).
-* **NEW:** Customizable size for indent guides, eg. skinny guides (soft-tabs only).
-* **NEW:** Customizable start indent level.
+* Customizable size for indent guides, eg. skinny guides (soft-tabs only).
+* Customizable start indent level.
+* **NEW:** Highlight support for files with a mixture of tab and space indent styles.
## Requirements
* Vim 7.2+
@@ -34,18 +35,23 @@ Here's an example of how to define custom colors instead of using the ones the p
autocmd VimEnter,Colorscheme * :hi IndentGuidesOdd guibg=red ctermbg=3
autocmd VimEnter,Colorscheme * :hi IndentGuidesEven guibg=green ctermbg=4
+Alternatively you can add the following lines to your colorscheme file.
+
+ hi IndentGuidesOdd guibg=red ctermbg=3
+ hi IndentGuidesEven guibg=green ctermbg=4
+
### Terminal Vim
At the moment Terminal Vim only has basic support. This means is that colors won't be automatically calculated based on your colorscheme. Instead, some preset colors are used depending on whether `background` is set to `dark` or `light`.
When `set background=dark` is used, the following highlight colors will be defined:
- hi IndentGuidesEven ctermbg=darkgrey
hi IndentGuidesOdd ctermbg=black
+ hi IndentGuidesEven ctermbg=darkgrey
Alternatively, when `set background=light` is used, the following highlight colors will be defined:
- hi IndentGuidesEven ctermbg=lightgrey
hi IndentGuidesOdd ctermbg=white
+ hi IndentGuidesEven ctermbg=lightgrey
If for some reason it's incorrectly defining light highlight colors instead of dark ones or vice versa, the first thing you should check is that the `background` value is being set correctly for your colorscheme. Sometimes it's best to manually set the `background` value in your `.vimrc`, for example:
@@ -62,4 +68,3 @@ Alternatively you can manually setup the highlight colors yourself, see `:help i
<img src="http://i.imgur.com/7tMBl.png" width="448" height="448" alt="" />
<img src="http://i.imgur.com/EvrqK.png" width="448" height="448" alt="" />
<img src="http://i.imgur.com/hHqp2.png" width="448" height="448" alt="" />
-
26 doc/indent_guides.txt
View
@@ -9,8 +9,8 @@
Author: Nate Kane <nathanaelkane AT gmail DOT com>
-Version: 1.5 (pending release)
-Last Change: 21 Feb 2011
+Version: 1.5
+Last Change: 13 Mar 2011
==============================================================================
CONTENTS *indent-guides-contents*
@@ -41,6 +41,7 @@ Features:~
though).
* Customizable size for indent guides, eg. skinny guides (soft-tabs only).
* Customizable start indent level.
+ * Highlight support for files with a mixture of tab and space indent styles.
==============================================================================
2. COMMANDS *indent-guides-commands*
@@ -90,6 +91,12 @@ in an autocmd.
autocmd VimEnter,Colorscheme * :hi IndentGuidesEven guibg=green ctermbg=4
<
+Alternatively you can add the following lines to your colorscheme file.
+>
+ hi IndentGuidesOdd guibg=red ctermbg=3
+ hi IndentGuidesEven guibg=green ctermbg=4
+<
+
------------------------------------------------------------------------------
*'indent_guides_color_change_percent'*
Use this option to control the percent at which the highlight colors will be
@@ -162,15 +169,15 @@ preset colors are used depending on whether `background` is set to `dark` or
When `set background=dark` is used, the following highlight colors will be
defined:
>
- hi IndentGuidesEven ctermbg=darkgrey
hi IndentGuidesOdd ctermbg=black
+ hi IndentGuidesEven ctermbg=darkgrey
<
Alternatively, when `set background=light` is used, the following highlight
colors will be defined:
>
- hi IndentGuidesEven ctermbg=lightgrey
hi IndentGuidesOdd ctermbg=white
+ hi IndentGuidesEven ctermbg=lightgrey
<
If for some reason it's incorrectly defining light highlight colors instead of
@@ -212,15 +219,14 @@ Bug reports, feedback, suggestions etc are welcomed.
==============================================================================
7. CHANGELOG *indent-guides-changelog*
-1.5 (pending release)~
- * Added highlight support for files with a mixture of soft-tabs and hard-
- tabs (thanks to graywh).
+1.5~
+ * Added highlight support for files with a mixture of tab and space indent
+ styles (thanks graywh).
* Added -bar to all the :commands so they can chain with other :commands
(thanks to graywh).
- * No longer overriding pre-defined custom highlight colors (thanks to
- graywh).
+ * No longer overriding pre-defined custom highlight colors (thanks graywh).
* Using str2float to work around a float bug in some versions of Vim 7.2
- (thanks to voidus).
+ (thanks voidus).
1.4~
* Added the new plugin option g:|indent_guides_enable_on_vim_startup|.
Please sign in to comment.
Something went wrong with that request. Please try again.