Skip to content

Commit c28e193

Browse files
committed
Updated the readme and help file with details about the new start level option
1 parent 67398b8 commit c28e193

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

README.markdown

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Indent Guides is a plugin for visually displaying indent levels in Vim.
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).
1010
* Customizable size for indent guides, eg. skinny guides (soft-tabs only).
11+
* Customizable start indent level.
1112

1213
## Requirements
1314
* Vim 7.2+

doc/indent_guides.txt

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
Author: Nate Kane <nathanaelkane AT gmail DOT com>
1212
Version: 1.2
13-
Last Change: 5 Jan 2011
13+
Last Change: 9 Jan 2011
1414

1515
==============================================================================
1616
CONTENTS *indent-guides-contents*
@@ -40,6 +40,7 @@ Features:~
4040
* Seems to work on Windows gVim 7.3 (haven't done any extensive tests
4141
though).
4242
* Customizable size for indent guides, eg. skinny guides (soft-tabs only).
43+
* Customizable start indent level.
4344

4445
==============================================================================
4546
2. COMMANDS *indent-guides-commands*
@@ -94,13 +95,13 @@ in an autocmd.
9495
Use this option to control the percent at which the highlight colors will be
9596
lightened or darkened.
9697

97-
Default: 0.05. Values: between 0 and 1.
98+
Default: 5 (5%). Values: between 0 and 100.
9899
>
99-
let g:indent_guides_color_change_percent = 0.05
100+
let g:indent_guides_color_change_percent = 5
100101
<
101102

102103
------------------------------------------------------------------------------
103-
*'indent_guides_indent_guide_size'*
104+
*'indent_guides_guide_size'*
104105
Use this option to customize the size of the indent guide. By default the
105106
value is set to 0, which will set the guide size to be the same as the
106107
|shiftwidth|. Setting this value to be larger than the |shiftwidth| is essentially
@@ -109,11 +110,20 @@ the same as setting it to 0.
109110
A common use of this setting is to create skinny indent guides, which look
110111
great with a |shiftwidth| of 4 or more.
111112

112-
NOTE: This option only works for soft-tabs (spaces) and not for hard-tabs.
113+
NOTE: This option only works for soft-tabs (spaces) and not hard-tabs.
113114

114115
Default: 0. Values: between 0 and |shiftwidth|.
115116
>
116-
let g:indent_guides_indent_guide_size = 1
117+
let g:indent_guides_guide_size = 1
118+
<
119+
120+
------------------------------------------------------------------------------
121+
*'indent_guides_start_level'*
122+
Use this option to control which indent level to start showing guides from.
123+
124+
Default: 1. Values: between 1 and g:|indent_guides_indent_levels|.
125+
>
126+
let g:indent_guides_start_level = 2
117127
<
118128

119129
==============================================================================
@@ -195,6 +205,7 @@ Bug reports, feedback, suggestions etc are welcomed.
195205

196206
1.2~
197207
* Customizable size for indent guides, eg. skinny guides (soft-tabs only).
208+
* Customizable start indent level.
198209
* Refactored some internal logic.
199210
1.1~
200211
* Added basic support for Terminal Vim. See |indent-guides-terminal-vim| for

0 commit comments

Comments
 (0)