git.oblomov.eu Git - ikiwiki/blob - 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), by 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
   6
   7 The plugin also includes commands (and mappings) to make the cursor jump to the
   8 previous/next wikilink in the current file
   9
  10 ##  Jumping to pages
  11
  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
  15
  16 ## Moving to next/previous wikilink in current file
  17
  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
  22
  23   * `:IkiNextWikiLink 0` will look forward for the wikilink
  24   * `:IkiNextWikiLink 1` will look backwards for the wikilink
  25
  26 ## Installation
  27
  28 Copy the `ikiwiki_nav.vim` file to your `.vim/ftplugin` directory.
  29
  30 ## Current issues:
  31
  32   * The plugin only works for wikilinks contained in a single text line;
  33     multiline wikilinks are not (yet) seen as such
  34
  35 ## Notes
  36
  37 The official releases of the plugin are in the
  38 [vim.org script page](http://www.vim.org/scripts/script.php?script_id=2968)
  39
  40 The latest version of this script can be found in the following location
  41
  42 <http://git.devnull.li/cgi-bin/gitweb.cgi?p=ikiwiki-nav.git;a=blob;f=ftplugin/ikiwiki_nav.vim;hb=HEAD>
  43
  44 Any feedback you can provide is appreciated; the contact details can be found
  45 inside the plugin
  46
  47 [[!tag vim]]