%title%

*vimwiki.txt* A Personal Wiki for Vim __ __ ___ __ __ _ _ ___ ___ _ ___ ~ | | | || | | |_| || | _ | || | | | | || | ~ | |_| || | | || || || || | | |_| || | ~ | || | | || || | | _|| | ~ | || | | || || | | |_ | | ~ | | | | | ||_|| || _ || | | _ || | ~ |___| |___| |_| |_||__| |__||___| |___| |_||___| ~ Version: 2.5 ============================================================================== CONTENTS *vimwiki* 1. Intro |vimwiki-intro| 2. Prerequisites |vimwiki-prerequisites| 3. Mappings |vimwiki-mappings| 3.1. Global mappings |vimwiki-global-mappings| 3.2. Local mappings |vimwiki-local-mappings| 3.3. Text objects |vimwiki-text-objects| 4. Commands |vimwiki-commands| 4.1. Global commands |vimwiki-global-commands| 4.2. Local commands |vimwiki-local-commands| 5. Wiki syntax |vimwiki-syntax| 5.1. Typefaces |vimwiki-syntax-typefaces| 5.2. Links |vimwiki-syntax-links| 5.3. Headers |vimwiki-syntax-headers| 5.4. Paragraphs |vimwiki-syntax-paragraphs| 5.5. Lists |vimwiki-syntax-lists| 5.6. Tables |vimwiki-syntax-tables| 5.7. Preformatted text |vimwiki-syntax-preformatted| 5.8. Mathematical formulae |vimwiki-syntax-math| 5.9. Blockquotes |vimwiki-syntax-blockquotes| 5.10. Comments |vimwiki-syntax-comments| 5.11. Horizontal line |vimwiki-syntax-hr| 5.12. Tags |vimwiki-syntax-tags| 6. Folding/Outline |vimwiki-folding| 7. Placeholders |vimwiki-placeholders| 8. Lists |vimwiki-lists| 9. Tables |vimwiki-tables| 10. Diary |vimwiki-diary| 11. Anchors |vimwiki-anchors| 12. Options |vimwiki-options| 12.1. Registered Wiki |vimwiki-register-wiki| 12.2. Temporary Wiki |vimwiki-temporary-wiki| 12.3. Per-Wiki Options |vimwiki-local-options| 12.4. Global Options |vimwiki-global-options| 13. Getting help |vimwiki-help| 14. Contributing & Bug reports |vimwiki-contributing| 15. Development |vimwiki-development| 16. Changelog |vimwiki-changelog| 17. License |vimwiki-license| ============================================================================== 1. Intro *vimwiki-intro* Vimwiki makes it very easy for you create a personal wiki using the Vim text editor. A wiki is a collection of text documents linked together and formatted with wiki or markdown syntax that can be highlighted for readability using Vim's syntax highlighting feature. With Vimwiki you can: - organize notes and ideas - manage todo-lists - write documentation - maintain a diary - export your documents to HTML Getting started with Vimwiki is easy. Once intalled, simply type `vim` into your terminal to launch Vim and then type ww (the key is `\` by default) to create or open the index wiki file, the "top" page in your hierarchical collection of wiki pages. By default, this page will be located at ~/vimwiki/index.wiki. Now add the following example lines to the document: = My knowledge base = * Tasks -- things to be done _yesterday_!!! * Project Gutenberg -- good books are power. * Scratchpad -- various temporary stuff. Next, move your cursor to the word 'Tasks' and press `Enter`. This will create a Vimwiki link by surrounding 'Tasks' with double square brackets: '[[Tasks]]'. Pressing `Enter` a second time will generate a new blank buffer in Vim where you can input your tasks. After you add some tasks and save the new file, you can hit `Backspace` to jump back to the index document. A Vimwiki link can contain multiple words by entering Vim's "visual" mode (the "v" key, by default) and selecting the words to be linked. Once selected, press `Enter`. Try this now by selecting 'Project Gutenberg' in visual mode and hitting `Enter`. The sample text should now look something like this: = My knowledge base = * [[Tasks]] -- things to be done _yesterday_!!! * [[Project Gutenberg]] -- good books are power. * Scratchpad -- various temporary stuff. By continuing this way and creating sub pages with links to even more sub pages, you can create an unlimited number of neatly structured, interconnected documents to help you organize your notes, documenation, and tasks. ============================================================================== 2. Prerequisites *vimwiki-prerequisites* Make sure you have these settings in your vimrc file: > set nocompatible filetype plugin on syntax on Without them Vimwiki will not work properly. ============================================================================== 3. Mappings *vimwiki-mappings* There are global and local mappings in Vimwiki. ------------------------------------------------------------------------------ 3.1. Global mappings *vimwiki-global-mappings* Below is a list of all default global key mappings provided by Vimwiki. As global settings, they work in all vim sessions no matter what filetype you have open. Vimwiki respects pre-existing global mappings created by you or other plugins and will not overwrite them. If a conflict exists between Vimwiki and pre-existing maps or if you wish to customize these default mappings, you can remap them with: > :nmap {map} {command} where `{map}` is the new key sequence of your choosing `{command}` is the Vimwiki command you are remapping So, for example, to remap the |:VimwikiIndex| mapping, you'd do something like: > :nmap wx VimwikiIndex Note that the recursive version of "map" command is needed to expand the right hand side to retrieve the definition. "noremap" will not work. is required and considered to be part of the command. You can also place remappings in your vimrc file, without the leading colon, of course. *vimwiki_ww* [count]ww Open index file of the [count]'s wiki. ww opens the first wiki from |g:vimwiki_list| if no wiki is open. Otherwise the index of the currently active wiki is opened. 1ww opens the first wiki from |g:vimwiki_list|. 2ww opens the second wiki from |g:vimwiki_list|. 3ww opens the third wiki from |g:vimwiki_list|. etc. Remap command: `VimwikiIndex` See also |:VimwikiIndex| *vimwiki_wt* [count]wt Open index file of the [count]'s wiki in a new tab. wt tabopens the first wiki from |g:vimwiki_list|. 1wt as above tabopens the first wiki from |g:vimwiki_list|. 2wt tabopens the second wiki from |g:vimwiki_list|. 3wt tabopens the third wiki from |g:vimwiki_list|. etc. Remap command: `VimwikiTabIndex` See also |:VimwikiTabIndex| *vimwiki_ws* ws List and select available wikis. Remap command: `VimwikiUISelect` See also |:VimwikiUISelect| *vimwiki_wi* [count]wi Open diary index file of the [count]'s wiki. wi opens diary index file of the current wiki. 1wi opens diary index file of the first wiki from |g:vimwiki_list|. 2wi opens diary index file of the second wiki from |g:vimwiki_list|. etc. Remap command: `VimwikiDiaryIndex` See also |:VimwikiDiaryIndex| *vimwiki_ww* [count]ww Open diary wiki-file for today of the [count]'s wiki. ww opens diary wiki-file for today in the current wiki 1ww opens diary wiki-file for today in the first wiki from |g:vimwiki_list|. 2ww opens diary wiki-file for today in the second wiki from |g:vimwiki_list|. 3ww opens diary wiki-file for today in the third wiki from |g:vimwiki_list|. etc. Remap command: `VimwikiMakeDiaryNote` See also |:VimwikiMakeDiaryNote| *vimwiki_wt* [count]wt Open diary wiki-file for today of the [count]'s wiki in a new tab. wt tabopens diary wiki-file for today in the current wiki 1wt tabopens diary wiki-file for today in the first wiki from |g:vimwiki_list|. 2wt tabopens diary wiki-file for today in the second wiki from |g:vimwiki_list|. 3wt tabopens diary wiki-file for today in the third wiki from |g:vimwiki_list|. etc. Remap command: `VimwikiTabMakeDiaryNote` See also |:VimwikiTabMakeDiaryNote| *vimwiki_wy* [count]wy Open diary wiki-file for yesterday of the [count]'s wiki. wy opens diary wiki-file for yesterday in the current wiki 1wy opens diary wiki-file for yesterday in the first wiki from |g:vimwiki_list|. 2wy opens diary wiki-file for yesterday in the second wiki from |g:vimwiki_list|. 3wy opens diary wiki-file for yesterday in the third wiki from |g:vimwiki_list|. etc. Remap command: `VimwikiMakeYesterdayDiaryNote` See also |:VimwikiMakeYesterdayDiaryNote| *vimwiki_wm* [count]wm Open diary wiki-file for tomorrow of the [count]'s wiki. wm opens diary wiki-file for tomorrow in the current wiki 1wm opens diary wiki-file for tomorrow in the first wiki from |g:vimwiki_list|. 2wm opens diary wiki-file for tomorrow in the second wiki from |g:vimwiki_list|. 3wm opens diary wiki-file for tomorrow in the third wiki from |g:vimwiki_list|. etc. Remap command: `VimwikiMakeTomorrowDiaryNote` See also |:VimwikiMakeTomorrowDiaryNote| ------------------------------------------------------------------------------ 3.2. Local mappings *vimwiki-local-mappings* Below is a listing of all local key mappings provided by Vimwiki. As local settings, they are available when |FileType| is set to "vimwiki". These mappings may overwrite pre-existing mappings, but they can be remapped or disabled (see |g:vimwiki_key_mappings|). To remap commands that begin with , you should do the following: :{mode}map {map} {command} For commands that do not begin with , do: :{mode}noremap {map} {command} where `{mode}` is set to `n` for "normal" mode, `v` for "visual", and `i` for "insert" `{map}` is the new key sequence of your choosing `{command}` is the Vimwiki command you are remapping Examples: > :nmap tl VimwikiToggleListItem :vmap tl VimwikiToggleListItem :nnoremap glo :VimwikiChangeSymbolTo a) The first two lines remap "\tl" to the |:VimwikiToggleListItem| command in both normal and visual modes. || is set to "\" by default. Use `:echo mapleader` to determine if it is set to another value. The third map listed above, which does not contain , maps directly to an |Ex| mode command. Note that |map| is needed for commands beginning with . This recursive version of the "map" command is needed to expand the right hand side to retrieve the definition. "noremap" will not work. is required and considered to be part of the command. It is recommended that you place your local mappings into a file at ftplugin/vimwiki.vim within your .vim configuration directory. Create this file if it doesn't already exist. Or, if you prefer, you can set up a FileType |autocmd| in your vimrc. Note: it may be desirable to add ` ` to mapped commands but this should only be done if the mappings are placed in ftplugin or in a Filetype based autocommand. See the Vim help for a description of these options. MAP MODE *vimwiki_wh* wh n Convert current wiki page to HTML. Maps to |:Vimwiki2HTML| Remap command: `Vimwiki2HTML` *vimwiki_whh* whh n Convert current wiki page to HTML and open it in the webbrowser. Maps to |:Vimwiki2HTMLBrowse| Remap command: `Vimwiki2HTMLBrowse` *vimwiki_wi* wi n Update diary section (delete old, insert new) Only works from the diary index. Maps to |:VimwikiDiaryGenerateLinks| Remap command: `VimwikiDiaryGenerateLinks` *vimwiki_* n Follow/create wiki link (create target wiki page if needed). Maps to |:VimwikiFollowLink|. Remap command: `VimwikiFollowLink` *vimwiki_* n Split and follow (create target wiki page if needed). May not work in some terminals. Remapping could help. Maps to |:VimwikiSplitLink|. Remap command: `VimwikiSplitLink` *vimwiki_* n Vertical split and follow (create target wiki page if needed). May not work in some terminals. Remapping could help. Maps to |:VimwikiVSplitLink|. Remap command: `VimwikiVSplitLink` *vimwiki_* *vimwiki_* , n Follow wiki link (create target wiki page if needed), opening in a new tab. May not work in some terminals. Remapping could help. Maps to |:VimwikiTabnewLink|. Remap command: `VimwikiTabnewLink` *vimwiki_* n Go back to previously visited wiki page. Maps to |:VimwikiGoBackLink|. Remap command: `VimwikiGoBackLink` *vimwiki_* n Find next link in the current page. Maps to |:VimwikiNextLink|. Remap command: `VimwikiNextLink` *vimwiki_* n Find previous link in the current page. Maps to |:VimwikiPrevLink|. Remap command: `VimwikiPrevLink` *vimwiki_wn* wn n Goto or create new wiki page. Maps to |:VimwikiGoto|. Remap command: `VimwikiGoto` *vimwiki_wd* wd n Delete wiki page you are in. Maps to |:VimwikiDeleteFile|. Remap command: `VimwikiDeleteFile` *vimwiki_wr* wr n Rename wiki page you are in. Maps to |:VimwikiRenameFile|. Remap command: `VimwikiRenameFile` *vimwiki_=* = n Add header level. Create if needed. There is nothing to indent with '==' command in Vimwiki, so it should be ok to use '=' here. Remap command: `VimwikiAddHeaderLevel` *vimwiki_-* - n Remove header level. Remap command: `VimwikiRemoveHeaderLevel` *vimwiki_[[* [[ n Go to the previous header in the buffer. Remap command: `VimwikiGoToPrevHeader` *vimwiki_]]* ]] n Go to the next header in the buffer. Remap command: `VimwikiGoToNextHeader` *vimwiki_[=* [= n Go to the previous header which has the same level as the header the cursor is currently under. Remap command: `VimwikiGoToPrevSiblingHeader` *vimwiki_]=* ]= n Go to the next header which has the same level as the header the cursor is currently under. Remap command: `VimwikiGoToNextSiblingHeader` *vimwiki_]u* *vimwiki_[u* ]u [u n Go one level up -- that is, to the parent header of the header the cursor is currently under. Remap command: `VimwikiGoToParentHeader` *vimwiki_+* + n v Create and/or decorate links. Depending on the context, this command will: convert words into wikilinks; convert raw URLs into wikilinks; and add placeholder description text to wiki- or weblinks that are missing descriptions. Can be activated in normal mode with the cursor over a word or link, or in visual mode with the selected text. Remap commands: `VimwikiNormalizeLink` (normal mode) `VimwikiNormalizeLinkVisual` (visual mode) *vimwiki_* n Toggle checkbox of a list item on/off. Maps to |:VimwikiToggleListItem|. See |vimwiki-todo-lists|. Remap command: `VimwikiToggleListItem` *vimwiki_gnt* gnt n Find next unfinished task in the current page. Maps to |:VimwikiNextTask| Remap command: `VimwikiNextTask` *vimwiki_gl* *vimwiki_gL* gl n Remove checkbox from list item. Remap command: `VimwikiRemoveSingleCB` gL Remove checkboxes from all sibling list items. Remap command: `VimwikiRemoveCBInList` *vimwiki_gln* *vimwiki_glp* gln n v Increase the "done" status of a list checkbox, i.e. from [ ] to [.] to [o] etc. See |vimwiki-todo-lists|. glp Decrease the "done" status. Remap command: `VimwikiIncrementListItem` *vimwiki_gll* *vimwiki_gLl* gll n Increase the level of a list item. Remap commnad: `VimwikiIncreaseLvlSingleItem` gLl Increase the level of a list item and all child items. Remap command: `VimwikiIncreaseLvlWholeItem` *vimwiki_glh* *vimwiki_gLh* glh n Decrease the level of a list item. Remap command: `VimwikiDecreaseLvlSingleItem` gLh Decrease the level of a list item and all child items. Remap command: `VimwikiDecreaseLvlWholeItem` *vimwiki_glr* *vimwiki_gLr* glr n Renumber list items if the cursor is on a numbered list item. Remap command: `VimwikiRenumberList` gLr Renumber list items in all numbered lists in the whole file. Also readjust checkboxes. Remap command: `VimwikiRenumberAllLists` *vimwiki_glstar* *vimwiki_gLstar* gl* n Make a list item out of a normal line or change the symbol of the current item to *. gL* Change the symbol of the current list to *. Remap command: `:VimwikiChangeSymbolTo *` noremap glO :VimwikiChangeSymbolInListTo * *vimwiki_gl#* *vimwiki_gL#* gl# n Make a list item out of a normal line or change the symbol of the current item to #. gL# Change the symbol of the current list to #. Remap command: `:VimwikiChangeSymbolTo #` Remap command: `:VimwikiChangeSymbolInListTo #` *vimwiki_gl-* *vimwiki_gL-* gl- n Make a list item out of a normal line or change the symbol of the current item to -. Remap command: `:VimwikiChangeSymbolTo -` gL- Change the symbol of the current list to -. Remap command: `:VimwikiChangeSymbolInListTo -` *vimwiki_gl1* *vimwiki_gL1* gl1 n Make a list item out of a normal line or change the symbol of the current item to 1., the numbering is adjusted according to the surrounding list items. Remap command: `:VimwikiChangeSymbolTo 1.` gL1 Change the symbol of the current list to 1. 2. 3. ... Remap command: `:VimwikiChangeSymbolInListTo 1.` *vimwiki_gla* *vimwiki_gLa* gla n Make a list item out of a normal line or change the symbol of the current item to a), the numbering is adjusted according to the surrounding list items. Remap command: `:VimwikiChangeSymbolTo a)` gLa Change the symbol of the current list to a) b) c) ... Remap command: `:VimwikiChangeSymbolInListTo a)` *vimwiki_glA* *vimwiki_gLA* glA n Make a list item out of a normal line or change the symbol of the current item to A), the numbering is adjusted according to the surrounding list items. Remap command: `:VimwikiChangeSymbolTo A)` gLA Change the symbol of the current list to A) B) C) ... Remap command: `:VimwikiChangeSymbolInListTo A)` *vimwiki_gli* *vimwiki_gLi* gli n Make a list item out of a normal line or change the symbol of the current item to i), the numbering is adjusted according to the surrounding list items. Remap command: `:VimwikiChangeSymbolTo i)` gLi Change the symbol of the current list to i) ii) iii) ... Remap command: `:VimwikiChangeSymbolInListTo i)` *vimwiki_glI* *vimwiki_gLI* glI n Make a list item out of a normal line or change the symbol of the current item to I), the numbering is adjusted according to the surrounding list items. Remap command: `:VimwikiChangeSymbolTo I)` gLI Change the symbol of the current list to I) II) III) ... Remap command: `:VimwikiChangeSymbolInListTo I)` *vimwiki_glx* glx n Toggle checkbox of a list item disabled/off. Maps to |:VimwikiToggleRejectedListItem|. See |vimwiki-todo-lists|. Remap command: `VimwikiToggleRejectedListItem` *vimwiki_gqq* *vimwiki_gww* gqq n Reformats table after making changes. or Remap command: `VimwikiTableAlignQ` gww Remap command: `VimwikiTableAlignW` *vimwiki_gq1* *vimwiki_gw1* gq1 n Fast format table. The same as the previous, except or that only a few lines above the current line are tested. If the alignment of the current line differs, then the whole table gets reformatted. Remap command: `VimwikiTableAlignQ1` gw1 Remap command:`VimwikiTableAlignW1` *vimwiki_* n Move current table column to the left. See |:VimwikiTableMoveColumnLeft| Remap command: `VimwikiTableMoveColumnLeft` *vimwiki_* n Move current table column to the right. See |:VimwikiTableMoveColumnRight| Remap command: `VimwikiTableMoveColumnRight` *vimwiki_* n Open the previous day's diary link if available. See |:VimwikiDiaryPrevDay| Remap command: `VimwikiDiaryPrevDay` *vimwiki_* n Open the next day's diary link if available. See |:VimwikiDiaryNextDay| Remap command: `VimwikiDiaryNextDay` Mouse mappings *vimwiki_mouse* These mappings are disabled by default. See |g:vimwiki_key_mappings| to enable. <2-LeftMouse> Follow wiki link (create target wiki page if needed). Split and follow wiki link (create target wiki page if needed). Vertical split and follow wiki link (create target wiki page if needed). Go back to previous wiki page. Note: <2-LeftMouse> is just left double click. TABLE MAPPINGS, INSERT MODE *vimwiki-table-mappings* *vimwiki_i__table* Go to the table cell beneath the current one, create a new row if on the last one. *vimwiki_i__table* Go to the next table cell, create a new row if on the last cell. LIST MAPPINGS, INSERT MODE *vimwiki-list-mappings* *vimwiki_i_* In a list item, insert a new bullet or number in the next line, numbers are incremented. In an empty list item, delete the item symbol. This is useful to end a list, simply press twice. See |vimwiki-lists| for details and for how to configure the behavior. *vimwiki_i_* Does not insert a new list item, useful to create multilined list items. See |vimwiki-lists| for details and for how to configure the behavior. The default map may not work in all terminals and may need to be remapped. *vimwiki_i_* Increase the level of a list item. Remap command: `VimwikiIncreaseLvlSingleItem` *vimwiki_i_* Decrease the level of a list item. Remap command: `VimwikiDecreaseLvlSingleItem` *vimwiki_i__*

Change the symbol of the current list item to the next available. From - to 1. to * to I) to a). Remap command: `VimwikiListNextSymbol` *vimwiki_i__*

Change the symbol of the current list item to the prev available. From - to a) to I) to * to 1. Remap command: `VimwikiListPrevSymbol` *vimwiki_i__*

Create/remove a symbol from a list item. Remap command: `VimwikiListToggle` ------------------------------------------------------------------------------ 3.3. Text objects *vimwiki-text-objects* 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). 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. ac A column in a table. ic An inner column in a table. al A list item plus its children. il A single list item. These key mappings can be modified by replacing the default keys: > omap ah VimwikiTextObjHeader vmap ah VimwikiTextObjHeaderV omap ih VimwikiTextObjHeaderContent vmap ih VimwikiTextObjHeaderContentV omap aH VimwikiTextObjHeaderSub vmap aH VimwikiTextObjHeaderSubV omap iH VimwikiTextObjHeaderSubContent vmap iH VimwikiTextObjHeaderSubContentV omap a\ VimwikiTextObjTableCell vmap a\ VimwikiTextObjTableCellV omap i\ VimwikiTextObjTableCellInner vmap i\ VimwikiTextObjTableCellInnerV omap ac VimwikiTextObjColumn vmap ac VimwikiTextObjColumnV omap ic VimwikiTextObjColumnInner vmap ic VimwikiTextObjColumnInnerV omap al VimwikiTextObjListChildren vmap al VimwikiTextObjListChildrenV omap il VimwikiTextObjListSingle vmap il VimwikiTextObjListSingleV ============================================================================== 4. Commands *vimwiki-commands* ------------------------------------------------------------------------------ 4.1. Global Commands *vimwiki-global-commands* *:VimwikiIndex* [count] Open index file of the current wiki. If a [count] is given the corresponding wiki from |g:vimwiki_list| is opened instead. *:VimwikiTabIndex* [count] Open index file of the current wiki in a new tab. If a [count] is given the corresponding wiki from |g:vimwiki_list| is opened instead. *:VimwikiUISelect* Displays a list of registered wikis and opens the index file of the selected wiki. *:VimwikiDiaryIndex* [count] Open diary index file of the current wiki. If a [count] is given the corresponding wiki from |g:vimwiki_list| is opened instead. *:VimwikiMakeDiaryNote* [count] Open diary wiki-file for today of the current wiki. If a [count] is given a diary wiki-file for the corresponding wiki from |g:vimwiki_list| is opened instead. *:VimwikiTabMakeDiaryNote* [count] Open diary wiki-file for today of the current wiki in a new tab. If a [count] is given a diary wiki-file for the corresponding wiki from |g:vimwiki_list| is opened instead. *:VimwikiMakeYesterdayDiaryNote* [count] Open diary wiki-file for yesterday of the current wiki. If a [count] is given a diary wiki-file for the corresponding wiki from |g:vimwiki_list| is opened instead. *:VimwikiMakeTomorrowDiaryNote* [count] Open diary wiki-file for tomorrow of the current wiki. If a [count] is given a diary wiki-file for the corresponding wiki from |g:vimwiki_list| is opened instead. ------------------------------------------------------------------------------ 4.2. Local commands *vimwiki-local-commands* These commands are only available (and meaningful) when you are currently in a Vimwiki file. *:VimwikiFollowLink* Follow wiki link (or create target wiki page if needed). *:VimwikiGoBackLink* Go back to the wiki page you came from. *:VimwikiSplitLink* [reuse] [move_cursor] 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. *: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). *:VimwikiNextLink* Find next link on the current page. *:VimwikiPrevLink* Find previous link on the current page. *:VimwikiGoto* Goto link provided by an argument. For example: > :VimwikiGoto HelloWorld < opens/creates HelloWorld wiki page. Supports |cmdline-completion| for link name. If name is not specified, a prompt will be shown. *:VimwikiDeleteFile* Delete the wiki page you are in. *:VimwikiRenameFile* Rename the wiki page you are in. *:VimwikiNextTask* Jump to the next unfinished task in the current wiki page. *:Vimwiki2HTML* Convert current wiki page to HTML using Vimwiki's own converter or a user-supplied script (see |vimwiki-option-custom_wiki2html|). *:Vimwiki2HTMLBrowse* Convert current wiki page to HTML and open it in the webbrowser. *:VimwikiAll2HTML[!]* Convert all wiki pages to HTML. Default CSS file (style.css) is created if there is no one. By default, only converts wiki pages which have not already been converted or have been modified since their last conversion. With !, convert all pages, regardless of whether or not they are out-of-date. *:VimwikiToggleListItem* 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 one of the syntax-specific bullets: "*", "#", "1.", "-". See |vimwiki-todo-lists|. *:VimwikiSearch* /pattern/ *:VWS* /pattern/ Search for /pattern/ in all files of current wiki. To display all matches use |:lopen| command. 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 complete description of the search pattern format, see |:vimgrep|. For example, to perform a case-insensitive search, use > :VWS /\cpattern/ *:VimwikiBacklinks* *:VWB* Search for wikilinks to the current wiki page in all files of current wiki. To display all matches use |:lopen| command. To display next match use |:lnext| command. To display previous match use |:lprevious| command. *:VimwikiTable* Create a table with 5 cols and 2 rows. :VimwikiTable cols rows Create a table with the given cols and rows :VimwikiTable cols Create a table with the given cols and 2 rows *:VimwikiTableMoveColumnLeft* , *:VimwikiTableMoveColumnRight* Move current column to the left or to the right: Example: > | head1 | head2 | head3 | head4 | head5 | |--------|--------|--------|--------|--------| | value1 | value2 | value3 | value4 | value5 | Cursor is on 'head1'. :VimwikiTableMoveColumnRight | head2 | head1 | head3 | head4 | head5 | |--------|--------|--------|--------|--------| | value2 | value1 | value3 | value4 | value5 | Cursor is on 'head3'. :VimwikiTableMoveColumnLeft | head2 | head3 | head1 | head4 | head5 | |--------|--------|--------|--------|--------| | value2 | value3 | value1 | value4 | value5 | < Commands are mapped to and respectively. *:VimwikiGenerateLinks* [pattern] Insert a list of links to all available wiki files into the current buffer. If an optional 'pattern' is given as argument, the files will be searched in the wiki root folder according to the 'pattern' as |globpath| *:VimwikiDiaryGenerateLinks* Delete old, insert new diary section into diary index file. *:VimwikiDiaryNextDay* Open next day diary link if available. Mapped to . *:VimwikiDiaryPrevDay* Open previous day diary link if available. Mapped to . *:VimwikiTOC* Create or update the Table of Contents for the current wiki file. See |vimwiki-toc|. *:VimwikiCheckLinks* Search through all wiki files and check if the targets of all wiki links and links to external files actually exist. Check also if all wiki files are reachable from the index file. The results are shown in the quickfix window. *:VimwikiRebuildTags* Rebuilds the tags metadata file for all wiki files newer than the metadata file. Necessary for all tags related commands: |vimwiki-syntax-tags|. :VimwikiRebuildTags! does the same for all files. *:VimwikiSearchTags* Searches over the pages in current wiki and finds all locations of a given tag. Supports |cmdline-completion|. *:VimwikiGenerateTagLinks* tagname1 tagname2 ... Creates or updates an overview on all tags of the wiki with links to all their instances. Supports |cmdline-completion|. If no arguments (tags) are specified, outputs all tags. To make this command work properly, make sure the tags have been built (see |vimwiki-build-tags|). ============================================================================== 5. Wiki syntax *vimwiki-syntax* There are a lot of different wikis out there. Most of them have their own syntax and Vimwiki is not an exception here. Vimwiki has evolved its own syntax that closely resembles Google's wiki markup. This syntax is described in detail below. Vimwiki also supports alternative syntaxes, like Markdown and MediaWiki, to varying degrees; see |vimwiki-option-syntax|. Static elements like headers, quotations, and lists are customized in syntax/vimwiki_xxx.vim, where xxx stands for the chosen syntax. Interactive elements such as links and Vimwiki commands are supported by definitions and routines in syntax/vimwiki_xxx_custom.vim and autoload/vimwiki/xxx_base.vim. Currently, only Markdown includes this level of support. Vimwiki2HTML is currently functional only for the default syntax. ------------------------------------------------------------------------------ 5.1. Typefaces *vimwiki-syntax-typefaces* There are a few typefaces that give you a bit of control over how your text is decorated: > *bold text* _italic text_ _*bold italic text*_ *_bold italic text _* ~~strikeout text~~ `code (no syntax) text` super^script^ sub,,script,, For Markdown syntax these variations are used: > **bold text** or __bold text__ *italic text* or _italic text_ ***bold_italic text*** or ___italic_bold text___ Furthermore, there are a number of words which are highlighted extra flashy: TODO, DONE, STARTED, FIXME, FIXED, XXX. When rendered as HTML, code blocks containing only a hash prefixed 6 digit hex number will be colored as themselves. For example > `#ffe119` Becomes > #ffe119 ------------------------------------------------------------------------------ 5.2. Links *vimwiki-syntax-links* Wikilinks~ Plain link: > [[This is a link]] With description: > [[This is a link source|Description of the link]] Wiki files don't need to be in the root directory of your wiki, you can put them in subdirectories as well: > [[projects/Important Project 1]] To jump from that file back to the index file, use this link: > [[../index]] or: > [[/index]] The latter works because wiki links starting with "/" are considered to be absolute to the wiki root directory, that is, the link [[/index]] always opens the file /path/to/your/wiki/index.wiki, no matter in which subdirectory you are currently in. Links to subdirectories inside the wiki directory are also supported. They end with a "/": > [[a subdirectory/|Other files]] Use |g:vimwiki_dir_link| to control the behavior when opening directories. Typing wikilinks can be simplified by using Vim's omni completion (see |compl-omni|) like so: > [[ind

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~ 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: > [[wiki1:This is a link]] or: > [[wiki1:This is a link source|Description of the link]] The number behind "wiki" is in the range 0..N-1 and identifies the destination wiki in |g:vimwiki_list|. Named interwiki links are also supported in the format "wn.name:link" > [[wn.My Name:This is a link]] or: > [[wn.MyWiki:This is a link source|Description of the link]] See |vimwiki-option-name| to set a per wiki name. Diary~ The "diary:" scheme is used to link to diary entries: > [[diary:2012-03-05]] Anchors~ A wikilink, interwiki link or diary link can be followed by a '#' and the name of an anchor. When opening a link, the cursor jumps to the anchor. > [[Todo List#Tomorrow|Tasks for tomorrow]] To jump inside the current wiki file you can omit the file: > [[#Tomorrow]] See |vimwiki-anchors| for how to set an anchor. Raw URLs~ Raw URLs are also supported: > https://github.com/vimwiki/vimwiki.git mailto:habamax@gmail.com ftp://vim.org External files~ The "file:" and "local:" schemes allow you to directly link to arbitrary resources using absolute or relative paths: > [[file:/home/somebody/a/b/c/music.mp3]] [[file:C:/Users/somebody/d/e/f/music.mp3]] [[file:~/a/b/c/music.mp3]] [[file:../assets/data.csv|Important Data]] [[local:C:/Users/somebody/d/e/f/music.mp3]] [[file:/home/user/documents/|Link to a directory]] These links are opened with the system command, i.e. !xdg-open (Linux), !open (Mac), or !start (Windows). To customize this behavior, see |VimwikiLinkHandler|. In Vim, "file:" and "local:" behave the same, i.e. you can use them with both relative and absolute links. When converted to HTML, however, "file:" links will become absolute links, while "local:" links become relative to the HTML output directory. The latter can be useful if you copy your HTML files to another computer. To customize the HTML conversion of links, see |VimwikiLinkConverter|. Transclusion (Wiki-Include) Links~ Links that use "{{" and "}}" delimiters signify content that is to be included into the HTML output, rather than referenced via hyperlink. Wiki-include URLs may use any of the supported schemes, may be absolute or relative, and need not end with an extension. The primary purpose for wiki-include links is to include images. Transclude from a local URL: > {{file:../../images/vimwiki_logo.png}} or from a universal URL: > {{http://vimwiki.googlecode.com/hg/images/vimwiki_logo.png}} Transclude image with alternate text: > {{http://vimwiki.googlecode.com/hg/images/vimwiki_logo.png|Vimwiki}} in HTML: > Vimwiki

Transclude image with alternate text and some style: > {{http://.../vimwiki_logo.png|cool stuff|style="width:150px;height:120px;"}} in HTML: >

Transclude image _without_ alternate text and with a CSS class: > {{http://.../vimwiki_logo.png||class="center flow blabla"}} in HTML: >

A trial feature allows you to supply your own handler for wiki-include links. See |VimwikiWikiIncludeHandler|. Thumbnail links~ > Thumbnail links are constructed like this: > [[http://someaddr.com/bigpicture.jpg|{{http://someaddr.com/thumbnail.jpg}}]] in HTML: >

 def hello(world):
     for x in range(10):
         print("Hello {0} number {1}".format(world, x))

): > ---- < ------------------------------------------------------------------------------ 5.12. Tags *vimwiki-syntax-tags* You can tag a wiki file, a header or an arbitrary place in a wiki file. Then, you can use Vim's built-in tag search functionality (see |tagsrch.txt|) or Vimwiki's tag related commands to quickly jump to all occurrences of the tag. A tag is a sequence of non-space characters between two colons: > :tag-example: < It is allowed to concatenate multiple tags in one line: > :tag-one:tag-two: < If placed in the first two lines of a file, the whole file is tagged. If placed under a header, within the 2 lines below it, the header is then tagged with this tag, and the tag search commands will jump to this specific header. Otherwise, the tag stands of its own and the search command jumps directly to it. Typing tags can be simplified by using Vim's omni completion (see |compl-omni|) like so: > :ind

. Note that the mapping is not available in all terminals. Furthermore, and behave differently when the cursor is behind an empty list item. See the table below. To customize the behavior you should use an autocmd or place the mappings in `~/.vim/after/ftplugin/vimwiki.vim`. This is necessary to avoid an error that the command `VimwikiReturn` doesn't exist when editing non Vimwiki files.: > autocmd FileType vimwiki inoremap \ :VimwikiReturn 3 5 autocmd FileType vimwiki inoremap

and

%content%

Page created on %date%