aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJavier Rojas <jerojasro@devnull.li>2010-02-08 23:32:05 -0500
committerJavier Rojas <jerojasro@devnull.li>2010-02-08 23:32:05 -0500
commit06a56ea9d51d472175cb9279d92f9fb7a62fdf46 (patch)
tree57e3f6b4da1782fc7d0cc8dc5c91d8a757012535
parent4ce14aa621be4c6b8551555395b80b68fbcc1ffe (diff)
downloadikiwiki-06a56ea9d51d472175cb9279d92f9fb7a62fdf46.tar
ikiwiki-06a56ea9d51d472175cb9279d92f9fb7a62fdf46.tar.gz
added tip about page navigation from within vim
-rw-r--r--doc/tips/follow_wikilinks_from_inside_vim.mdwn43
1 files changed, 43 insertions, 0 deletions
diff --git a/doc/tips/follow_wikilinks_from_inside_vim.mdwn b/doc/tips/follow_wikilinks_from_inside_vim.mdwn
new file mode 100644
index 000000000..93a95bc7a
--- /dev/null
+++ b/doc/tips/follow_wikilinks_from_inside_vim.mdwn
@@ -0,0 +1,43 @@
+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), and 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
+
+## 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]]