DOKK Library

Vimwiki 1.1.1 Quick Reference

Authors T. Pospíchal

License CC-BY-SA-3.0

Plaintext
                  Vimwiki 1.1.1 Quick Reference                                             Text styles                                                                          [inline]     Placeholders affecting HTML output                                                                      [inline]
                                                                                            *text* . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . bold text      %toc Text . . . . . . . . . . . table of contents with optional title
Open, convert or search wiki                        [normal and cmdline mode]               _text_ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . italic text    %title Text . . . . . . . . use this title instead of the filename
\ww / n\ww . . . . . . open index file of the main/the n-th wiki                            ~~text~~ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . strikeout text           %nohtml . . . . . . . . . . . . . . . . . . . . . . . do not convert to HTML
                                                                                            ,,sub,,text^super^ . . . . . . . . . . . . . . . . . . . . subtextsuper
 :VimwikiIndex                                           (for the current wiki)
                                                                                            ‘code‘ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . monospaced code                  Folding, text objects and operators                                                       [normal mode]
\wt / n\wt . . . . . open the main/n-th index file in a new tab
 :VimwikiTabIndex                                        (for the current wiki)                                                                                                               zo / zc / [z / ]z . . open/close current fold/go to start/end
\ws . . . . . . . . . . . . . . . . . . . list and select from available wikis              Headings and breaks                                                                  [inline]
                                                                                                                                                                                              zR / zM / zr . . . . . .open/close all folds/reduce by one level
   :VimwikiUISelect                                                                         = text = . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . header level 1
:Vimwiki2HTML . . . . . . . . . convert current page to HTML                                == text == . . . . . . . . . . . . . . . . . . . . . . . . . . . . . header level 2               ah / ih . a section segment with/without trailing empty lines
                                                                                            :                                                                                             :   a\ / i\ . . . . . . . . . . . . . . . . . . . . . . . . . a cell/inner cell in a table
:VimwikiAll2HTML . . . . . . . . . convert all pages to HTML
                                                                                            ====== text ====== . . . . . . . . . . . . . . . . . . header level 6                             ac / ic . . . . . . . . . . . . . . . . . . a column/inner column in a table
:VWS /pattern/ . . . . . . . . . . . . . . . . . . . . . search current wiki
                                                                                              . . . . . . . . . . . . . . . . . . . . . . . . . . . . (empty_line) paragraph break            vah / yah / cah / dah . select/yank/change/delete section
   :VimwikiSearch /pattern/
                                                                                            <br> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . line break
                                                                                            ---- . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . horizontal line      Vimwiki options and additional wikis                                                                   [.vimrc]
Follow or modify wiki links                         [normal and cmdline mode]
                                                                                                                                                                                              let   g:vimwiki_folding=0 / 1 . . . . . . . . folding disabled/enabled
Enter . . . . . . . . . . . . . . . . . . . . . . . follow (or create) wiki link            Lists, tables, quotations and code blocks                                        [multiline]      let   g:vimwiki_camel_case=0 / 1 . . WikiWord auto-links off/on
   :VimwikiFollowLink                                                                       * item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . bulleted list      let   g:vimwiki_table_auto_fmt=0 / 1 . table auto-format off/on
Shift+Enter / Ctrl+Enter split/vert. split and follow                                       - item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . bulleted list      let   g:vimwiki_html_header_numbering=0 / 1 / 2
   :VimwikiSplitLink / :VimwikiVSplitLink                                                   # item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . numbered list             . . numbering of headers in HTML off/on from level 1/on from level 2
Backspace . . . . . . . . . . . . go back to the previous wiki link                         term:: definition . . . . . . . . . . . . . . . . . . . . definition list                         let g:vimwiki_file_exts=’ext1,. . . ’ . . . . . . . . . recognized
   :VimwikiGoBackLink                                                                       |text|text|. . . |text| . . . . . . . . . . . . . . . . . . . . table row                           extensions of local file links: pdf,txt,doc,rtf,xls,php,zip,rar,7z,html,gz
Tab / Shift+Tab . . . . . . . . . . . . . . . find next/previous link                       |--+--+--| . . . . . . . . . . . . . . . . . . . . . table header separator                       let g:vimwiki_valid_html_tags=’tag1,. . . ’
   :VimwikiNextLink / :VimwikiPrevLink                                                      <!-- text --> . . . . . . . . . comment, not shown in HTML                                           . . . . . . . . . . . . . . . recognized HTML tags: b,i,s,u,sub,sup,kbd,br,hr
\wd / \wr . . . . . . . . . . . delete/rename the current wiki page                             text . . . . . . . . . . . . . (four_spaces) block of quoted text                             Other g:vimwiki_opt with opt: hl_headers, hl_cb_checked, global_ext,
   :VimwikiDeleteLink / :VimwikiRenameLink                                                  {{{ code code . . . code }}} . . . . . . . . . . block of code                                      upper, lower, auto_checkbox, menu, stripsym, badsyms, listsyms, use_mouse,

                                                                                                                                                                                                fold_lists, fold_trailing_empty_lines, list_ignore_newline, use_calendar,

Headers, lists, tables, diary                       [normal and cmdline mode]               Internal links, external links and images                                            [inline]       browsers, w32_dir_enc, CJK_length, dir_link, conceallevel,


= / - . . . . . . . . . . . . . . . . . . . . . . increase/decrease header level            TextText . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . WikiWord link                let g:vimwiki_list=[{},                                                        . . . . . . . default wiki
                                                                                            !TextText . . . . . . . . . . . . . . . . . . . . . . . . not a WikiWord link                       \ {’opt1’:’val1’, ’opt2’:’val2’,                                     . . . }, . . . ] . . more wikis
Ctrl+Space . . . . . . . . . . . . . . . toggle a todo-list item on/off
                                                                                            [[Text text]] . . . . . . . . . . . . . link with an arbitrary name                                  ’path’ / ’path_html’:’path’ . . . . location of wiki/HTML files
   :VimwikiToggleListItem
                                                                                            [[Text| Desc]] / [[Text][Desc]] . . . with descr.                                                    ’html_header’ / ’html_footer’:’file’ . templates for HTML
:VimwikiGenerateLinks .insert all available links here                                      [[file:///C:/book.pdf]] . . . . . . . . link to a local file                                         ’css_name’:’file’ . . . . . . . . . . . . . . . . . . . . . stylesheet: style.css
:VimwikiTable cols rows . . . . . . . . . . . . . . . . create table                        http://abc.org/page.html . . . . . plain link to a URL                                               More: auto_export, index, ext, syntax, maxhi, nested_syntaxes,
gqq / gww . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . align table   [http://. . . /hp.htm My Home Page] . . . with descr.                                                Diary: diary_rel_path, diary_index, diary_header, diary_link_count,
Alt+Left / Alt+Right . . . . . . . . . shift column left/right                              [[images/pic.png]] . . . . . . . . . . . . . . . . . . . . local image
 :VimwikiTableMoveColumnLeft / . . . Right                                                  URL/pic.jpg / [[URL/pic.jpg]] . external image                                                    Help and information                                                     [cmdline mode and web]
\w\w / n\w\w . open today’s diary page for main/n-th wiki                                   [[URL/pic.jpg| desc]] . . . . . image with description                                            :he vimwiki . . . . . . . . . . . . . . . . . . . . . . . . . . . Vimwiki help
 :VimwikiMakeDiaryNote                  (for the current wiki)                              [[URL/pic.jpg| comment|]] . . . . with alternate text                                             www.vim.org/scripts/script.php?script_id=2226 Script
\w\t / n\w\t . . . open today’s diary in a tab /for n-th wiki                               [[URL/pic.jpg| text|width:150px;]] with alt. text and size                                        http://code.google.com/p/vimwiki/ . . Vimwiki
 :VimwikiTabMakeDiaryNote               (for the current wiki)                              [[URL/pic.jpg||height:120px;]] . . . . . without alternate text                                     project pages: wiki, issues tracker, sources and development
Ctrl+Down / Ctrl+Up . . open next/previous day’s diary                                      [URL/pic.jpg URL/thumb.jpg] . . . . . . . . . . . . . thumbnail link
                                                                                                                                                                                              © 2011 T. Pospíchal      Vimwiki 1.1.1 Quick Reference is licensed under the Creative Commons Attribution–ShareAlike
   :VimwikiDiaryNextDay / :VimwikiDiaryPrevDay                                              [[URL/pic.jpg| URL/thumb.jpg]] . . . . . . . . . . thumbnail link                                 3.0 Unported Licence (CC BY-SA). TEX source is available at http://vimwiki.googlecode.com/hg/misc/Vimwiki1.1.1QR.tex