aboutsummaryrefslogtreecommitdiff
path: root/doc/tips/follow_wikilinks_from_inside_vim.mdwn
blob: e7258f42d9cb3104fe9d0e121a0b9f065213e4cd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
[[!meta date="2010-02-08 23:32:05 -0500"]]

The [ikiwiki-nav](http://www.vim.org/scripts/script.php?script_id=2968) plugin
for vim eases the editing of IkiWiki wikis, by letting you "follow" the
wikilinks on your file (page), by loading the file associated with a given
wikilink in vim. The plugin takes care of following the ikiwiki linking rules
to figure out which file a wikilink points to 

The plugin also includes commands (and mappings) to make the cursor jump to the
previous/next wikilink in the current file 

##  Jumping to pages 

To open the file associated to a wikilink, place the cursor over its text, and
hit Enter (`<CR>`). This functionality is also available through the
`:IkiJumpToPage` command 

## Moving to next/previous wikilink in current file 

`Ctrl-j` will move the cursor to the next wikilink. `Ctrl-k` will move it to the
previous wikilink. This functionality is also available through the
`:IkiNextWikiLink` command. This command takes one argument, the direction to
move into 

  * `:IkiNextWikiLink 0` will look forward for the wikilink 
  * `:IkiNextWikiLink 1` will look backwards for the wikilink 

## Installation

Copy the `ikiwiki_nav.vim` file to your `.vim/ftplugin` directory.

## Current issues: 

  * The plugin only works for wikilinks contained in a single text line;
    multiline wikilinks are not (yet) seen as such 

## Notes 

The official releases of the plugin are in the
[vim.org script page](http://www.vim.org/scripts/script.php?script_id=2968)

The latest version of this script can be found in the following location 

<http://git.devnull.li/cgi-bin/gitweb.cgi?p=ikiwiki-nav.git;a=blob;f=ftplugin/ikiwiki_nav.vim;hb=HEAD>

Any feedback you can provide is appreciated; the contact details can be found
inside the plugin

[[!tag vim]]