Skip to content

Commit 62a2fd1

Browse files
committed
Updated the readme and help file.
1 parent 7826042 commit 62a2fd1

File tree

2 files changed

+26
-15
lines changed

2 files changed

+26
-15
lines changed

README.markdown

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,9 @@ Indent Guides is a plugin for visually displaying indent levels in Vim.
77
* Will highlight indent levels with alternating colors.
88
* Full support for gVim and basic support for Terminal Vim.
99
* Seems to work on Windows gVim 7.3 (haven't done any extensive tests though).
10-
* **NEW:** Customizable size for indent guides, eg. skinny guides (soft-tabs only).
11-
* **NEW:** Customizable start indent level.
10+
* Customizable size for indent guides, eg. skinny guides (soft-tabs only).
11+
* Customizable start indent level.
12+
* **NEW:** Highlight support for files with a mixture of tab and space indent styles.
1213

1314
## Requirements
1415
* Vim 7.2+
@@ -34,18 +35,23 @@ Here's an example of how to define custom colors instead of using the ones the p
3435
autocmd VimEnter,Colorscheme * :hi IndentGuidesOdd guibg=red ctermbg=3
3536
autocmd VimEnter,Colorscheme * :hi IndentGuidesEven guibg=green ctermbg=4
3637

38+
Alternatively you can add the following lines to your colorscheme file.
39+
40+
hi IndentGuidesOdd guibg=red ctermbg=3
41+
hi IndentGuidesEven guibg=green ctermbg=4
42+
3743
### Terminal Vim
3844
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`.
3945

4046
When `set background=dark` is used, the following highlight colors will be defined:
4147

42-
hi IndentGuidesEven ctermbg=darkgrey
4348
hi IndentGuidesOdd ctermbg=black
49+
hi IndentGuidesEven ctermbg=darkgrey
4450

4551
Alternatively, when `set background=light` is used, the following highlight colors will be defined:
4652

47-
hi IndentGuidesEven ctermbg=lightgrey
4853
hi IndentGuidesOdd ctermbg=white
54+
hi IndentGuidesEven ctermbg=lightgrey
4955

5056
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:
5157

@@ -62,4 +68,3 @@ Alternatively you can manually setup the highlight colors yourself, see `:help i
6268
<img src="http://i.imgur.com/7tMBl.png" width="448" height="448" alt="" />
6369
<img src="http://i.imgur.com/EvrqK.png" width="448" height="448" alt="" />
6470
<img src="http://i.imgur.com/hHqp2.png" width="448" height="448" alt="" />
65-

doc/indent_guides.txt

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99

1010

1111
Author: Nate Kane <nathanaelkane AT gmail DOT com>
12-
Version: 1.5 (pending release)
13-
Last Change: 21 Feb 2011
12+
Version: 1.5
13+
Last Change: 13 Mar 2011
1414

1515
==============================================================================
1616
CONTENTS *indent-guides-contents*
@@ -41,6 +41,7 @@ Features:~
4141
though).
4242
* Customizable size for indent guides, eg. skinny guides (soft-tabs only).
4343
* Customizable start indent level.
44+
* Highlight support for files with a mixture of tab and space indent styles.
4445

4546
==============================================================================
4647
2. COMMANDS *indent-guides-commands*
@@ -90,6 +91,12 @@ in an autocmd.
9091
autocmd VimEnter,Colorscheme * :hi IndentGuidesEven guibg=green ctermbg=4
9192
<
9293

94+
Alternatively you can add the following lines to your colorscheme file.
95+
>
96+
hi IndentGuidesOdd guibg=red ctermbg=3
97+
hi IndentGuidesEven guibg=green ctermbg=4
98+
<
99+
93100
------------------------------------------------------------------------------
94101
*'indent_guides_color_change_percent'*
95102
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
162169
When `set background=dark` is used, the following highlight colors will be
163170
defined:
164171
>
165-
hi IndentGuidesEven ctermbg=darkgrey
166172
hi IndentGuidesOdd ctermbg=black
173+
hi IndentGuidesEven ctermbg=darkgrey
167174
<
168175

169176
Alternatively, when `set background=light` is used, the following highlight
170177
colors will be defined:
171178
>
172-
hi IndentGuidesEven ctermbg=lightgrey
173179
hi IndentGuidesOdd ctermbg=white
180+
hi IndentGuidesEven ctermbg=lightgrey
174181
<
175182

176183
If for some reason it's incorrectly defining light highlight colors instead of
@@ -212,15 +219,14 @@ Bug reports, feedback, suggestions etc are welcomed.
212219
==============================================================================
213220
7. CHANGELOG *indent-guides-changelog*
214221

215-
1.5 (pending release)~
216-
* Added highlight support for files with a mixture of soft-tabs and hard-
217-
tabs (thanks to graywh).
222+
1.5~
223+
* Added highlight support for files with a mixture of tab and space indent
224+
styles (thanks graywh).
218225
* Added -bar to all the :commands so they can chain with other :commands
219226
(thanks to graywh).
220-
* No longer overriding pre-defined custom highlight colors (thanks to
221-
graywh).
227+
* No longer overriding pre-defined custom highlight colors (thanks graywh).
222228
* Using str2float to work around a float bug in some versions of Vim 7.2
223-
(thanks to voidus).
229+
(thanks voidus).
224230

225231
1.4~
226232
* Added the new plugin option g:|indent_guides_enable_on_vim_startup|.

0 commit comments

Comments
 (0)