doc/tips/follow_wikilinks_from_inside_vim.mdwn

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