Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info
commit
246ca5ab0a
|
@ -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.
|
||||
|
|
|
@ -0,0 +1,47 @@
|
|||
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]]
|
Loading…
Reference in New Issue