y0rune/vimwiki
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Clarify the description of hl_cb_checked in the doc

Browse Source 
Ref #605
This commit is contained in:
EinfachToll 2019-02-04 21:48:18 +01:00
parent e16dc41a50
commit 1b2643ea19
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/vimwiki.txt
View File

@ -2321,7 +2321,7 @@ Global options are configured using the following pattern: >
Highlight headers with =Reddish=, ==Greenish==, ===Blueish=== colors.
Value Description~
1 Use VimwikiHeader1-VimwikiHeader6 group colors to highlight
1 Use VimwikiHeader1 - VimwikiHeader6 group colors to highlight
different header levels.
0 Use |hl-Title| color for headers.
Default: 0
@ -2338,11 +2338,13 @@ Highlight checked list items with a special color:
Value Description~
0 Don't highlight anything.
1 Highlight checked [X] list item with |group-name| "Comment".
2 Highlight checked [X] list item and all its child items.
1 Highlight only the first line of a checked [X] list item.
2 Highlight a complete checked list item and all its child items.
Default: 0
The |group-name| "Comment" is used for highlighting.
Note: Option 2 does not work perfectly. Specifically, it might break if the
list item contains preformatted text or if you mix tabs and spaces for
indenting. Also, indented headers can be highlighted erroneously.