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

table align - catch up to dev

Browse Source
This commit is contained in:
Steven Schmeiser
2018-07-09 13:51:18 -04:00
parent 23d273d547 44a1f3a6f3
commit 10f502a698
22 changed files with 3673 additions and 3099 deletions
Download Patch File Download Diff File Expand all files Collapse all files

309
doc/vimwiki.txt
View File

@ -9,7 +9,7 @@
|___| |___| |_| |_||__| |__||___| |___| |_||___| ~
Version: 2.3
Version: 2.4
==============================================================================
CONTENTS *vimwiki*
@ -47,10 +47,11 @@ CONTENTS *vimwiki*
12.2. Temporary Wiki |vimwiki-temporary-wiki|
12.3. Per-Wiki Options |vimwiki-local-options|
12.4. Global Options |vimwiki-global-options|
13. Contributing |vimwiki-contributing|
14. Development |vimwiki-development|
15. Changelog |vimwiki-changelog|
16. License |vimwiki-license|
13. Getting help |vimwiki-help|
14. Contributing & Bug reports |vimwiki-contributing|
15. Development |vimwiki-development|
16. Changelog |vimwiki-changelog|
17. License |vimwiki-license|
==============================================================================
@ -213,6 +214,22 @@ See also |:VimwikiTabMakeDiaryNote|
<
See also |:VimwikiMakeYesterdayDiaryNote|
[count]<Leader>w<Leader>m or <Plug>VimwikiMakeTomorrowDiaryNote
Open diary wiki-file for tomorrow of the [count]'s wiki.
<Leader>w<Leader>m opens diary wiki-file for tomorrow in the first
wiki from |g:vimwiki_list|.
1<Leader>w<Leader>m as above opens diary wiki-file for tomorrow in
the first wiki from |g:vimwiki_list|.
2<Leader>w<Leader>m opens diary wiki-file for tomorrow in the second
wiki from |g:vimwiki_list|.
3<Leader>w<Leader>m opens diary wiki-file for tomorrow in the third
wiki from |g:vimwiki_list|.
etc.
To remap: >
:nmap <Leader>dm <Plug>VimwikiMakeTomorrowDiaryNote
<
See also |:VimwikiMakeTomorrowDiaryNote|
------------------------------------------------------------------------------
3.2. Local mappings
@ -222,7 +239,7 @@ To remap one of these keys, either put it in your .vimrc like this >
or, the better way, put it in a file .vim/ftplugin/vimwiki.vim like this >
:nmap <silent><buffer> <Leader>wc <Plug>Vimwiki2HTML
The latter has the advantage that the mapping is local to viwiki buffers in
The latter has the advantage that the mapping is local to Vimwiki buffers in
every case.
Also note that some keys work in normal mode as well as in visual mode. If you
@ -324,6 +341,34 @@ NORMAL MODE *vimwiki-local-mappings*
- Remove header level.
To remap: >
:nmap -- <Plug>VimwikiRemoveHeaderLevel
<
*vimwiki_[[*
[[ Go to the previous header in the buffer.
To remap: >
:nmap <- <Plug>VimwikiGoToPrevHeader
<
*vimwiki_]]*
]] Go to the next header in the buffer.
To remap: >
:nmap -> <Plug>VimwikiGoToNextHeader
<
*vimwiki_[=*
[= Go to the previous header which has the same level as
the header the cursor is currently under.
To remap: >
:nmap <= <Plug>VimwikiGoToPrevSiblingHeader
<
*vimwiki_]=*
]= Go to the next header which has the same level as the
header the cursor is currently under.
To remap: >
:nmap => <Plug>VimwikiGoToNextSiblingHeader
<
*vimwiki_]u* *vimwiki_[u*
]u [u Go one level up -- that is, to the parent header of
the header the cursor is currently under.
To remap: >
:nmap -^ <Plug>VimwikiGoToParentHeader
<
*vimwiki_+*
+ Create and/or decorate links. Depending on the
@ -455,6 +500,13 @@ gLI Change the symbol of the current list to
To remap: >
noremap glo :VimwikiChangeSymbolTo I)<CR>
noremap glO :VimwikiChangeSymbolInListTo I)<CR>
<
*vimwiki_glx*
glx Toggle checkbox of a list item disabled/off.
Maps to |:VimwikiToggleRejectedListItem|.
See |vimwiki-todo-lists|.
To remap: >
:map <Leader>tx <Plug>VimwikiToggleRejectedListItem
<
*vimwiki_gqq* *vimwiki_gww*
gqq Format table. If you made some changes to a table
@ -557,12 +609,22 @@ INSERT MODE *vimwiki-list-mappings*
------------------------------------------------------------------------------
3.3. Text objects *vimwiki-text-objects*
ah A section segment (the area between two consecutive
headings) including trailing empty lines.
ih A section segment without trailing empty lines.
ah A header including its content up to the next header.
ih The content under a header (like 'ah', but excluding
the header itself and trailing empty lines).
You can type 'vah' to select a section segment with its contents or 'dah' to
delete it or 'yah' to yank it or 'cah' to change it.
aH A header including all of its subheaders. When [count]
is 2, include the parent header, when [count] is 3,
the grandparent and so on.
iH Like 'aH', but excluding the header itself and
trailing empty lines.
Examples:
- type 'cih' to change the content under the current header
- 'daH' deletes an entire header plus its content including the content of all
of its subheaders
- 'v2aH' selects the parent header of the header the cursor is under plus all
of the content of all of its subheaders
a\ A cell in a table.
i\ An inner cell in a table.
@ -600,6 +662,8 @@ il A single list item.
*:VimwikiMakeYesterdayDiaryNote*
Open diary wiki-file for yesterday of the current wiki.
*:VimwikiMakeTomorrowDiaryNote*
Open diary wiki-file for tomorrow of the current wiki.
------------------------------------------------------------------------------
4.2. Local commands *vimwiki-local-commands*
@ -613,12 +677,24 @@ Vimwiki file.
*:VimwikiGoBackLink*
Go back to the wiki page you came from.
*:VimwikiSplitLink*
*:VimwikiSplitLink* [reuse] [move_cursor]
Split and follow wiki link (create target wiki page if needed).
*:VimwikiVSplitLink*
If the argument 'reuse' is given and nonzero, the link is opened in a
possibly existing split window instead of making a new split.
If 'move_cursor' is given and nonzero, the cursor moves to the window with
the opened link, otherwise, it stays in the window with the link.
*:VimwikiVSplitLink* [reuse] [move_cursor]
Vertical split and follow wiki link (create target wiki page if needed).
If the argument 'reuse' is given and nonzero, the link is opened in a
possibly existing split window instead of making a new split.
If 'move_cursor' is given and nonzero, the cursor moves to the window with
the opened link, otherwise, it stays in the window with the link.
*:VimwikiTabnewLink*
Follow wiki link in a new tab (create target wiki page if needed).
@ -656,6 +732,10 @@ Vimwiki file.
Toggle checkbox of a list item on/off.
See |vimwiki-todo-lists|.
*:VimwikiToggleRejectedListItem*
Toggle checkbox of a list item disabled/off.
See |vimwiki-todo-lists|.
*:VimwikiListChangeLevel* CMD
Change the nesting level, or symbol, for a single-line list item.
CMD may be ">>" or "<<" to change the indentation of the item, or
@ -669,6 +749,11 @@ Vimwiki file.
To display next match use |:lnext| command.
To display previous match use |:lprevious| command.
Hint: this feature is simply a wrapper around |:lvimgrep|. For a
description of how the pattern can look like, see |:vimgrep|. For example,
to do a case insensitive search, use >
:VWS /\cpattern/
*:VimwikiBacklinks*
*:VWB*
Search for wikilinks to the current wiki page in all files of current
@ -756,35 +841,6 @@ Vimwiki file.
are specified, outputs all tags. To make this command work properly, make
sure the tags have been built (see |vimwiki-build-tags|).
------------------------------------------------------------------------------
4.3. Functions *vimwiki-functions*
Functions to interact with Vimwiki. (It's intended that most commands will be
replaced with corresponding function calls in the future.)
Warning: this is currently unstable and likely to change.
To map them to a key, use >
nnoremap <C-K> :call vimwiki#base#function_name(arg1, arg2)<CR>
<
*vimwiki-follow_link*
vimwiki#base#follow_link({split}, {reuse}, {move_cursor})
Open the link under the cursor. {split} can have the following values:
'nosplit' open the link in the current window
'vsplit' open in a vertically split window
'hsplit' open in a horizontally split window
'tab' open in a new tab
If {reuse} is 1 and {split} one of 'vsplit' or 'hsplit', open the link in
a possibly existing split window instead of making a new split.
If {move_cursor} is 1 the cursor moves to the window or tab with the
opened link, otherwise, it stays in the window or tab with the link.
For example, <CR> is per default mapped to
vimwiki#base#follow_link('nosplit', 0, 1)
==============================================================================
5. Wiki syntax *vimwiki-syntax*
@ -821,6 +877,8 @@ is decorated: >
super^script^
sub,,script,,
Furthermore, there are a number of words which are highlighted extra flashy:
TODO, DONE, STARTED, FIXME, FIXED, XXX.
------------------------------------------------------------------------------
5.2. Links *vimwiki-syntax-links*
@ -857,7 +915,7 @@ which opens up a popup menu with all the wiki files starting with "ind".
When |vimwiki-option-maxhi| equals 1, a distinct highlighting style is used to
identify wikilinks whose targets are not found.
Interwiki:~
Interwiki~
If you maintain more than one wiki, you can create interwiki links between
them by adding a numbered prefix "wikiX:" in front of a link: >
@ -868,15 +926,11 @@ or: >
The number behind "wiki" is in the range 0..N-1 and identifies the destination
wiki in |g:vimwiki_list|.
Diary:~
Diary~
The "diary:" scheme is used to concisely link to diary entries: >
The "diary:" scheme is used to link to diary entries: >
[[diary:2012-03-05]]
This scheme precludes explicit inclusion of |vimwiki-option-diary_rel_path|,
and is most useful on subwiki pages to avoid links such as: >
[[../../diary/2012-03-05]]
Anchors~
A wikilink, interwiki link or diary link can be followed by a '#' and the name
@ -1233,14 +1287,9 @@ LaTeX code).
Note: the highlighting in Vim is automatic. For the rendering in HTML, you
have two alternative options:
1. using the MathJax server for rendering (needs internet connection).
Add to your HTML template the following line:
<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
2. installing MathJax locally (faster, no internet required). Choose a
folder on your hard drive and save MathJax in it. Then add to your HTML
template the following line:
1. installing MathJax locally (Recommended: faster, no internet required).
Choose a folder on your hard drive and save MathJax in it. Then add to your
HTML template the following line:
<script type="text/javascript" src="<mathjax_folder>/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
@ -1255,6 +1304,11 @@ template folder. For instance, a sensible folder structure could be:
In this case, <mathjax_folder> would be "../mathjax" (without quotes).
2. Loading MathJax from a CDN-server (needs internet connection).
Add to your HTML template the following line:
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/config/TeX-AMS-MML_HTMLorMML.js"></script>
------------------------------------------------------------------------------
5.9. Blockquotes *vimwiki-syntax-blockquotes*
@ -1621,6 +1675,9 @@ Use gl<Space> (see |vimwiki_gl<Space>|) to remove a single checkbox and
gL<Space> (see |vimwiki_gL<Space>|) to remove all checkboxes of the list the
cursor is in.
You can mark an item as rejected ("won't do") with
|vimwiki_glx|. A rejected item will not influence the status of its parents.
==============================================================================
9. Tables *vimwiki-tables*
@ -1793,6 +1850,12 @@ as described in |vimwiki-register-wiki|, or may be registered on the fly as
described in |vimwiki-temporary-wiki|. For a list of per-wiki options, see
|vimwiki-local-options|.
A note for Vim power users:
If you have an elaborated Vim setup, where you e.g. load plugins
conditionally, make sure the settings are set before Vimwiki loads (that is,
before plugin/vimwiki.vim is sourced). If this is not possible, try this
command after the Vimwiki settings are (re-) set: >
:call vimwiki#vars#init()
------------------------------------------------------------------------------
12.1 Registered Wiki *g:vimwiki_list* *vimwiki-register-wiki*
@ -2201,15 +2264,15 @@ be located at https://github.com/vimwiki-backup/vimwiki/issues/384
To use the internal wiki2html converter, use an empty string (the default).
vimwiki-option-custom_wiki2html_args
*vimwiki-option-custom_wiki2html_args*
-----------------------------------------------------------------------------
Key Default value~
custom_wiki2html_args ''
Description
Description~
If a custom script is called with |vimwiki-option-custom_wiki2html|, additional
parameters can be passed by setting them using 'custom_wiki2html_args' in
|g:vimwiki_list|.
parameters can be passed using this option: >
let g:vimwiki_list = [{'path': '~/path/', 'custom_wiki2html_args': 'stuff'}]
*vimwiki-option-list_margin*
@ -2354,6 +2417,19 @@ You can set it to some more fancy symbols like this:
let g:vimwiki_listsyms = '✗○◐●✓'
------------------------------------------------------------------------------
*g:vimwiki_listsym_rejected*
Character that is used to show that an item of a todo list will not be done.
Default value is '-'.
The character used here must not be part of |g:vimwiki_listsyms|.
You can set it to a more fancy symbol like this:
>
let g:vimwiki_listsym_rejected = '✗'
------------------------------------------------------------------------------
*g:vimwiki_use_mouse*
@ -2388,6 +2464,8 @@ Limitations:
- 'list' is intended to work with lists nicely indented with 'shiftwidth'.
- 'syntax' is only available for the default syntax so far.
The options above can be suffixed with ':quick' (e.g.: 'expr:quick') in order
to use some workarounds to make folds work faster.
------------------------------------------------------------------------------
*g:vimwiki_list_ignore_newline*
@ -2717,8 +2795,12 @@ Default: 2
------------------------------------------------------------------------------
*g:vimwiki_autowriteall*
In Vim 'autowriteall' is a global setting. With g:vimwiki_autowriteall Vimwiki
makes it local to its buffers.
Automatically save a modified wiki buffer when switching wiki pages. Has the
same effect like setting the Vim option 'autowriteall', but it works for wiki
files only, while the Vim option is global.
Hint: if you're just annoyed that you have to save files manually to switch
wiki pages, consider setting the Vim option 'hidden' which makes that modified
files don't need to be saved.
Value Description~
0 autowriteall is off
@ -2810,9 +2892,17 @@ Value Description~
Default: 0
==============================================================================
13. Getting help *vimwiki-help*
For questions, discussions, praise or rants there is a mailing list:
https://groups.google.com/forum/#!forum/vimwiki
Also, there is the IRC channel #vimwiki on Freenode which can be accessed via
webchat: https://webchat.freenode.net/?channels=#vimwiki
==============================================================================
13. Contributing *vimwiki-contributing*
14. Contributing & Bug reports *vimwiki-contributing*
Your help in making Vimwiki better is really appreciated!
Any help, whether it is a spelling correction or a code snippet to patch --
@ -2827,12 +2917,8 @@ Issues can be filed at https://github.com/vimwiki/vimwiki/issues/.
If you want to provide a pull request on GitHub, please start from the dev
branch, not from the master branch.
For questions, discussions, praise or rants there is a mailing list:
https://groups.google.com/forum/#!forum/vimwiki
==============================================================================
14. Development *vimwiki-development*
15. Development *vimwiki-development*
Homepage: http://vimwiki.github.io/
Github: https://github.com/vimwiki/vimwiki/
@ -2863,10 +2949,37 @@ Contributors and their Github usernames in roughly chronological order:
- @wangzq
- Jinzhou Zhang (@lotabout)
- Michael Riley (@optik-aper)
- Irfan Sharif (@irfansharif)
- John Conroy (@jconroy77)
- Christian Rondeau (@christianrondeau)
- Alex Thorne (@thornecc)
- Shafqat Bhuiyan (@priomsrb)
- Bradley Cicenas (@bcicen)
- Michael Thessel (@MichaelThessel)
- Michael F. Schönitzer (@nudin)
- @sqlwwx
- Guilherme Salazar (@salazar)
- Daniel Trnka (@trnila)
- Yuchen Pei (@ycpei)
- @maqiv
- @dpc
- Drew Hays (@Dru89)
- Daniel Etrata (@danetrata)
- Keith Haber (@kjhaber)
- @beuerle
- Silvio Ricardo Cordeiro (@silvioricardoc)
- @blyoa
- Jonathan McElroy (@jonathanmcelroy)
- @PetrusZ
- Brian Gianforcaro (@bgianfo)
- Ben Burrill (@benburrill)
- Zhuang Ma (@mzlogin)
- Huy Le (@huynle)
- Nick Borden (@hcwndbyw)
==============================================================================
15. Changelog *vimwiki-changelog*
16. Changelog *vimwiki-changelog*
Issue numbers starting with '#' are issues from
@ -2875,14 +2988,61 @@ http://code.google.com/p/vimwiki/issues/list. They may be accessible from
https://github.com/vimwiki-backup/vimwiki/issues.
2.4 (not yet released)~
New:~
* Add the option |g:vimwiki_text_ignore_newline|.
* |g:vimwiki_listsyms| can have fewer or more than 5 symbols.
* glx on a list item marks a checkbox as won't do, see |vimwiki_glx|.
* Add the option |g:vimwiki_listsym_rejected| to set the character used
for won't-do list items.
* gln and glp change the "done" status of a checkbox, see |vimwiki_gln|.
* |:VimwikiSplitLink| and |:VimwikiVSplitLink| can now reuse an existing
split window and not move the cursor.
* Add 'aH' and 'iH' text objects, see |vimwiki-text-objects|.
* Add the keys |vimwiki_[[|, |vimwiki_]]|, |vimwiki_[=|, |vimwiki_]=| and
|vimwiki_]u| for navigating between headers.
* Add the command |:VimwikiMakeTomorrowDiaryNote|.
* |g:vimwiki_folding| has a new option 'custom'.
* Add the ':quick' option for faster folding, see |g:vimwiki_folding|.
* Add the %date placeholder, see |vimwiki-date|.
* Add the option |vimwiki-option-custom_wiki2html_args|.
* Add support for HTML-style comments when using markdown syntax.
Removed:~
* Remove the undocumented and buggy command :VimwikiReadLocalOptions
which allowed to store Vimwiki related settings in a local file.
* Remove the undocumented command :VimwikiPrintWikiState.
* For complicated reasons, Vimwiki doesn't clean up its settings anymore
if you change the filetype of a wiki buffer.
Fixed:~
* Make |vimwiki-option-automatic_nested_syntaxes| work also for markdown.
* Issue #236: Highlight math blocks as TeX math, not TeX.
* Issue #264: Don't overwrite mappings to i_<CR> from other plugins.
* Fix an error where <BS> sometimes didn't work under Windows.
* Issue #302: |:VimwikiDiaryGenerateLinks| had issues with markdown.
* Issue #445: Better handling of |'autowriteall'| and |'hidden'|.
* Improve 'ah' and 'ih' text objects, see |vimwiki-text-objects|.
* Allow opening of links using Powershell.
* Allow any visual mode to be used with |vimwiki_+|.
* Markdown syntax for |vimwiki-toc| is used, when appropriate.
* Wikis can now be in subfolders of other wikis.
* Issue #482: |:VimwikiMakeDiaryNote| now uses the diary of the current wiki.
* Opening the diary and wikis from the menu works correctly now.
* Issue #497: Make |:VimwikiMakeDiaryNote| work outside a wiki buffer.
* Use markdown syntax in the diary when appropriate.
* Various other minor fixes.
2.3 (2016-03-31)~
New:
New:~
* Add |:VimwikiMakeYesterdayDiaryNote| command
* Issue #128: add option |vimwiki-option-automatic_nested_syntaxes|
* Issue #192: Sort links in the list generated by |:VimwikiGenerateTags|
Fixed:
Fixed:~
* Issue #176: Fix issue when the wiki path contains spaces
* Also look for tags in wiki files in subdirectories
* Locate the .tags file correctly on Windows
@ -3108,12 +3268,13 @@ http://code.google.com/p/vimwiki/issues/list
* First public version.
==============================================================================
16. License *vimwiki-license*
17. License *vimwiki-license*
The MIT Licence
The MIT License
http://www.opensource.org/licenses/mit-license.php
Copyright (c) 2008-2010 Maxim Kim
2013-2017 Daniel Schemala
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal