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

Cleanup of the documentation. Mostly superfluous whitespaces

Browse Source
This commit is contained in:
EinfachToll 2014-01-06 14:16:37 +01:00
parent 74c3372c44
commit 976c39140a
1 changed files with 64 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
doc/vimwiki.txt
View File

@ -40,14 +40,14 @@ CONTENTS *vimwiki-contents*
5.14. Thumbnails |vimwiki-syntax-thumbnails| 5.14. Thumbnails |vimwiki-syntax-thumbnails|
6. Folding/Outline |vimwiki-folding| 6. Folding/Outline |vimwiki-folding|
7. Placeholders |vimwiki-placeholders| 7. Placeholders |vimwiki-placeholders|
8. Todo lists |vimwiki-todo-lists| 8. Lists |vimwiki-lists|
9. Tables |vimwiki-tables| 9. Tables |vimwiki-tables|
10. Diary |vimwiki-diary| 10. Diary |vimwiki-diary|
11. Options |vimwiki-options| 11. Options |vimwiki-options|
11.1. Registered Wiki |vimwiki-register-wiki| 11.1. Registered Wiki |vimwiki-register-wiki|
11.2. Temporary Wiki |vimwiki-temporary-wiki| 11.2. Temporary Wiki |vimwiki-temporary-wiki|
11.3. Per-Wiki Options |vimwiki-local-options| 11.3. Per-Wiki Options |vimwiki-local-options|
11.4. Global Options |viwmiki-global-options| 11.4. Global Options |vimwiki-global-options|
12. Help |vimwiki-help| 12. Help |vimwiki-help|
13. Developers |vimwiki-developers| 13. Developers |vimwiki-developers|
14. Changelog |vimwiki-changelog| 14. Changelog |vimwiki-changelog|
@ -315,7 +315,10 @@ NORMAL MODE *vimwiki-local-mappings*
descriptions. Can be activated in normal mode with descriptions. Can be activated in normal mode with
the cursor over a word or link, or in visual mode with the cursor over a word or link, or in visual mode with
the selected text. the selected text.
To remap: >
:nmap ++ <Plug>VimwikiNormalizeLink
:vmap ++ <Plug>VimwikiNormalizeLinkVisual
<
*vimwiki_<C-Space>* *vimwiki_<C-Space>*
<C-Space> Toggle checkbox of a list item on/off <C-Space> Toggle checkbox of a list item on/off
Maps to |:VimwikiToggleCheckbox|. Maps to |:VimwikiToggleCheckbox|.
@ -449,11 +452,15 @@ gww will reformat it.
*vimwiki_<C-Up>* *vimwiki_<C-Up>*
<C-Up> Open the previous day's diary link if available. <C-Up> Open the previous day's diary link if available.
See |:VimwikiDiaryPrevDay| See |:VimwikiDiaryPrevDay|
To remap: >
:nmap <Leader>k <Plug>VimwikiDiaryPrevDay
<
*vimwiki_<C-Down>* *vimwiki_<C-Down>*
<C-Down> Open the next day's diary link if available. <C-Down> Open the next day's diary link if available.
See |:VimwikiDiaryNextDay| See |:VimwikiDiaryNextDay|
To remap: >
:nmap <Leader>j <Plug>VimwikiDiaryNextDay
<
Works only if |g:vimwiki_use_mouse| is set to 1. Works only if |g:vimwiki_use_mouse| is set to 1.
<2-LeftMouse> Follow wiki link (create target wiki page if needed). <2-LeftMouse> Follow wiki link (create target wiki page if needed).
@ -739,7 +746,7 @@ or: >
Links to directories (ending with a "/") are also supported: > Links to directories (ending with a "/") are also supported: >
[[/home/somebody/|Home Directory]] [[/home/somebody/|Home Directory]]
Use |g:vimwiki_dir_link| to control the behaviour when opening directories. Use |g:vimwiki_dir_link| to control the behavior when opening directories.
Raw URLs~ Raw URLs~
@ -1564,7 +1571,7 @@ There are global options and local (per-wiki) options available to tune
vimwiki. vimwiki.
Global options are configured via global variables. For a complete list of Global options are configured via global variables. For a complete list of
them, see |viwmiki-global-options|. them, see |vimwiki-global-options|.
Local options for multiple independent wikis are stored in a single global Local options for multiple independent wikis are stored in a single global
variable |g:vimwiki_list|. The per-wiki options can be registered in advance, variable |g:vimwiki_list|. The per-wiki options can be registered in advance,
@ -1957,7 +1964,7 @@ is used. This affects the appearance of the generated links (see
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
11.4 Global Options *viwmiki-global-options* 11.4 Global Options *vimwiki-global-options*
Global options are configured using the following pattern: > Global options are configured using the following pattern: >
@ -2153,7 +2160,7 @@ Vimwiki's opening of links. Each recognized link, whether it is a wikilink,
wiki-include link or a weblink, is first passed to |VimwikiLinkHandler| to see wiki-include link or a weblink, is first passed to |VimwikiLinkHandler| to see
if it can be handled. The return value 1/0 indicates success. if it can be handled. The return value 1/0 indicates success.
If the link is not handled successfully, the behaviour of Vimwiki depends on If the link is not handled successfully, the behavior of Vimwiki depends on
the scheme. Wiki:, diary: or schemeless links are opened in Vim. All others, the scheme. Wiki:, diary: or schemeless links are opened in Vim. All others,
including local: and file: schemes, are opened with a system default handler; including local: and file: schemes, are opened with a system default handler;
i.e. Linux (!xdg-open), Mac (!open), and Windows (!start). i.e. Linux (!xdg-open), Mac (!open), and Windows (!start).
@ -2201,7 +2208,7 @@ similar to 'local:' and 'file:' schemes, but are always opened with Vim: >
----------------------------------------------------------------------------- -----------------------------------------------------------------------------
*VimwikiWikiIncludeHandler*~ *VimwikiWikiIncludeHandler*
Vimwiki includes the contents of a wiki-include URL as an image by default. Vimwiki includes the contents of a wiki-include URL as an image by default.
@ -2392,7 +2399,7 @@ they would not be deleted after |:VimwikiAll2HTML|.
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
*g:vimwiki_conceallevel* *g:vimwiki_conceallevel*
In vim73 |conceallevel| is local to window, thus if you open viwmiki buffer in In vim73 |conceallevel| is local to window, thus if you open vimwiki buffer in
a new tab or window, it would be set to default value. a new tab or window, it would be set to default value.
Vimwiki sets |conceallevel| to g:vimwiki_conceallevel everytime vimwiki buffer Vimwiki sets |conceallevel| to g:vimwiki_conceallevel everytime vimwiki buffer
@ -2566,7 +2573,7 @@ http://code.google.com/p/vimwiki/issues/list
* Issue 70: Table spanning cell support. * Issue 70: Table spanning cell support.
* Issue 72: Do not convert again for unchanged file. |:VimwikiAll2HTML| * Issue 72: Do not convert again for unchanged file. |:VimwikiAll2HTML|
converts only changed wiki files. converts only changed wiki files.
* Issue 117: |VimwikiDiaryIndex| command that opens diary index wiki page. * Issue 117: |:VimwikiDiaryIndex| command that opens diary index wiki page.
* Issue 120: Links in headers are not highlighted in vimwiki but are * Issue 120: Links in headers are not highlighted in vimwiki but are
highlighted in HTML. highlighted in HTML.
* Issue 138: Added possibility to remap table-column move bindings. See * Issue 138: Added possibility to remap table-column move bindings. See