]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - doc/tips/follow_wikilinks_from_inside_vim.mdwn
added tip about page navigation from within vim
[git.ikiwiki.info.git] / doc / tips / follow_wikilinks_from_inside_vim.mdwn
1 The [ikiwiki-nav](http://www.vim.org/scripts/script.php?script_id=2968) plugin
2 for vim eases the editing of IkiWiki wikis, by letting you "follow" the
3 wikilinks on your file (page), and loading the file associated with a given
4 wikilink in vim. The plugin takes care of following the ikiwiki linking rules
5 to figure out which file a wikilink points to 
7 The plugin also includes commands (and mappings) to make the cursor jump to the
8 previous/next wikilink in the current file 
10 ##  Jumping to pages 
12 To open the file associated to a wikilink, place the cursor over its text, and
13 hit Enter (`<CR>`). This functionality is also available through the
14 `:IkiJumpToPage` command 
16 ## Moving to next/previous wikilink in current file 
18 `Ctrl-j` will move the cursor to the next wikilink. `Ctrl-k` will move it to the
19 previous wikilink. This functionality is also available through the
20 `:IkiNextWikiLink` command. This command takes one argument, the direction to
21 move into 
23   * `:IkiNextWikiLink 0` will look forward for the wikilink 
24   * `:IkiNextWikiLink 1` will look backwards for the wikilink 
26 ## Current issues: 
28   * The plugin only works for wikilinks contained in a single text line;
29     multiline wikilinks are not (yet) seen as such 
31 ## Notes 
33 The official releases of the plugin are in the
34 [vim.org script page](http://www.vim.org/scripts/script.php?script_id=2968)
36 The latest version of this script can be found in the following location 
38 <http://git.devnull.li/cgi-bin/gitweb.cgi?p=ikiwiki-nav.git;a=blob;f=ftplugin/ikiwiki_nav.vim;hb=HEAD>
40 Any feedback you can provide is appreciated; the contact details can be found
41 inside the plugin
43 [[!tag vim]]