From 06a56ea9d51d472175cb9279d92f9fb7a62fdf46 Mon Sep 17 00:00:00 2001 From: Javier Rojas Date: Mon, 8 Feb 2010 23:32:05 -0500 Subject: added tip about page navigation from within vim --- doc/tips/follow_wikilinks_from_inside_vim.mdwn | 43 ++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 doc/tips/follow_wikilinks_from_inside_vim.mdwn (limited to 'doc/tips') 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 (``). 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 + + + +Any feedback you can provide is appreciated; the contact details can be found +inside the plugin + +[[!tag vim]] -- cgit v1.2.3 From 59868bce02f10e1ed378f5625618198daca58d3a Mon Sep 17 00:00:00 2001 From: Javier Rojas Date: Mon, 8 Feb 2010 23:37:24 -0500 Subject: more notes about the ikiwiki-nav plugin added installation notes added pointer in the forum page to the created tip --- doc/forum/navigation_of_wiki_pages_on_local_filesystem_with_vim.mdwn | 4 ++++ doc/tips/follow_wikilinks_from_inside_vim.mdwn | 4 ++++ 2 files changed, 8 insertions(+) (limited to 'doc/tips') diff --git a/doc/forum/navigation_of_wiki_pages_on_local_filesystem_with_vim.mdwn b/doc/forum/navigation_of_wiki_pages_on_local_filesystem_with_vim.mdwn index 0497b66b6..980b92740 100644 --- a/doc/forum/navigation_of_wiki_pages_on_local_filesystem_with_vim.mdwn +++ b/doc/forum/navigation_of_wiki_pages_on_local_filesystem_with_vim.mdwn @@ -1,3 +1,7 @@ +**UPDATE** I have created a [[page|tips/follow_wikilinks_from_inside_vim]] in +the tips section about the plugin, how to get it, install it and use it. Check +that out. --[[jerojasro]] + I wrote a vim function to help me navigate the wiki when I'm editing it. It extends the 'gf' (goto file) functionality. Once installed, you place the cursor on a wiki page name and press 'gf' (without the quotes); if the file exists, it gets loaded. This function takes into account the ikiwiki linking rules when deciding which file to go to. diff --git a/doc/tips/follow_wikilinks_from_inside_vim.mdwn b/doc/tips/follow_wikilinks_from_inside_vim.mdwn index 93a95bc7a..df8145a51 100644 --- a/doc/tips/follow_wikilinks_from_inside_vim.mdwn +++ b/doc/tips/follow_wikilinks_from_inside_vim.mdwn @@ -23,6 +23,10 @@ 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; -- cgit v1.2.3 From f48e98a2ac0325f3e17b2c25151aa6af4ba93b20 Mon Sep 17 00:00:00 2001 From: Javier Rojas Date: Mon, 8 Feb 2010 23:39:06 -0500 Subject: redaction --- doc/tips/follow_wikilinks_from_inside_vim.mdwn | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/tips') diff --git a/doc/tips/follow_wikilinks_from_inside_vim.mdwn b/doc/tips/follow_wikilinks_from_inside_vim.mdwn index df8145a51..015a4ecee 100644 --- a/doc/tips/follow_wikilinks_from_inside_vim.mdwn +++ b/doc/tips/follow_wikilinks_from_inside_vim.mdwn @@ -1,6 +1,6 @@ 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 +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 -- cgit v1.2.3