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

Update folding documentation to match current behaviour

Browse Source 
Ref #297
Ref #117
This commit is contained in:
EinfachToll 2017-02-19 21:50:35 +01:00
parent 3a87437005
commit 2eed86813d
1 changed files with 34 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
doc/vimwiki.txt
View File

@ -1281,40 +1281,50 @@ Tags-related commands and options:
6. Folding/Outline *vimwiki-folding* 6. Folding/Outline *vimwiki-folding*
Vimwiki can fold or outline sections using headers and preformatted blocks. Vimwiki can fold or outline sections using headers and preformatted blocks.
Alternatively, one can fold list subitems instead. Alternatively, one can fold list subitems instead. Folding is not enabled
by default, and requires the |g:vimwiki_folding| variable to be set.
Example for list folding with |g:vimwiki_folding| set to 'list':
Example for list folding:
= My current task = = My current task =
* [ ] Do stuff 1 * [ ] Do stuff 1
* [ ] Do substuff 1.1 * [ ] Do substuff 1.1
* [ ] Do substuff 1.2 * [ ] Do substuff 1.2
* [ ] Do substuff 1.2.1 * [ ] Do substuff 1.2.1
* [ ] Do substuff 1.2.2 * [ ] Do substuff 1.2.2
* [ ] Do substuff 1.3 * [ ] Do substuff 1.3
* [ ] Do stuff 2 * [ ] Do stuff 2
* [ ] Do stuff 3 * [ ] Do stuff 3
Hit |zM| : Hit |zM| :
= My current task = [8] --------------------------------------~ = My current task =
* [ ] Do stuff 1 [6] --------------------------------------~
* [ ] Do stuff 2
* [ ] Do stuff 3
Hit |zr| : Hit |zr| :
= My current task =~ = My current task =
* [ ] Do stuff 1 [5] --------------------------------------~ * [ ] Do stuff 1
* [ ] Do stuff 2~ * [ ] Do substuff 1.1
* [ ] Do stuff 3~ * [ ] Do substuff 1.2 [3] -------------------------------~
* [ ] Do substuff 1.3
* [ ] Do stuff 2
* [ ] Do stuff 3
Hit |zr| one more time: Hit |zr| one more time :
= My current task =~ = My current task =
* [ ] Do stuff 1~ * [ ] Do stuff 1
* [ ] Do substuff 1.1~ * [ ] Do substuff 1.1
* [ ] Do substuff 1.2 [2] -------------------------------~ * [ ] Do substuff 1.2
* [ ] Do substuff 1.3~ * [ ] Do substuff 1.2.1
* [ ] Do stuff 2~ * [ ] Do substuff 1.2.2
* [ ] Do stuff 3~ * [ ] Do substuff 1.3
* [ ] Do stuff 2
* [ ] Do stuff 3
Note: If you use the default Vimwiki syntax, folding on list items will work Note: If you use the default Vimwiki syntax, folding on list items will work
properly only if all of them are indented using the current 'shiftwidth'. properly only if all of them are indented using the current 'shiftwidth'.
For MediaWiki, * or # should be in the first column. For MediaWiki syntax, * or # should be in the first column.
To turn folding on/off check |g:vimwiki_folding|. To turn folding on/off check |g:vimwiki_folding|.