]> sipb.mit.edu Git - ikiwiki.git/blob - doc/forum/navigation_of_wiki_pages_on_local_filesystem_with_vim.mdwn
response
[ikiwiki.git] / doc / forum / navigation_of_wiki_pages_on_local_filesystem_with_vim.mdwn
1 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.
2
3 This function takes into account the ikiwiki linking rules when deciding which file to go to.
4
5 > 'gf' gets in the way when there are directories with the same name of a wiki page. The 
6 > function below doesn't implement the linking rules properly (test the link (ignoring case),
7 > if there is no match ascend the dir. hierarchy and start over, until we reach the root of
8 > the wiki). I'm rewriting it to follow these rules properly
9
10 > I think the page for [[LinkingRules|ikiwiki/subpage/linkingrules]] should say that ikiwiki **ascends**
11 > the dir. hierarchy when looking for a wikilink, not that it **descends** it. Am I correct? --[[jerojasro]]
12
13 >> Conventionally, the root directory is considered to be lower than other
14 >> directories, so I think the current wording is correct. --[[Joey]]
15
16 let me know what you think
17
18 >         " NOTE: the root of the wiki is considered the first directory that contains a
19 >         " .ikiwiki folder, except $HOME/.ikiwiki (the usual ikiwiki libdir)
20
21 > That's not going to work in all situations; for example, with an ikiwiki which uses git as the backend, the normal setup is that one has
22
23 > * a bare git repository
24 > * a git repository which ikiwiki builds the wiki from (which has a .ikiwiki directory in it)
25 > * an *additional* git repository cloned from the bare repository, which is used for making changes from the command-line rather than the web.  It is this repository in which one would be editing files with vim, and *this* repository does not have a .ikiwiki directory in it.  It does have a .git directory in the root, however, so I suppose you could use that as a method of detection of a root directory, but of course that would only work for git repositories.
26
27 > -- [[KathrynAndersen]]
28
29 >> You are completely right; all of my wikis are compiled both locally and
30 >> remotely, and so the local repo also has a `.ikiwiki` folder. And that's not the
31 >> "usual" setup.
32 >> 
33 >> checking for a `.git` dir would not work when the wiki's source files aren't
34 >> located at the root of the repo.
35 >> 
36 >> So, besides of doing a `touch .ikiwiki` at the root of the wiki in your local
37 >> repo, do you see any alternative?
38 >> 
39 >> -- [[jerojasro]]
40
41 well. I've rewritten the whole thing, to take into account:
42   
43   * file matching ignoring case (MyPage matches mypage.mdwn)
44   * checking all the way down (up) to the root of the wiki (if there is a link `\[[foo]]` on `a/b/page`),
45   try `a/b/page/foo`, then `a/b/foo`, and so on, up to `foo`
46   * the alternate name for a page: when looking for the file for `\[[foo]]`, try both `foo.mdwn` and `foo/index.mdwn`
47
48 you can find the file [here](http://git.devnull.li/cgi-bin/gitweb.cgi?p=vim-jerojasro.git;a=blob;f=.vim/ftplugin/ikiwiki_nav.vim;hb=HEAD). To use it, place it in `$HOME/.vim/ftplugin`. After that, hitting `<CR>` (Enter) in normal mode over a wikilink will take you to that page, if it exists.
49
50 the plugin has, as of now, two problems:
51  
52   * doesn't work with wikilinks that take more than one line (though this isn't really that bad)
53   * it assumes that the root of the wiki is the first directory down the filesystem hierarchy that 
54   has a `.ikiwiki` folder on it. If your copy of the wiki doesn't have it, you must create it for 
55   the plugin to work
56
57 -- [[jerojasro]]
58
59 > Interesting. I was at one point looking at "potwiki.vim", which implements a local wiki and follows CamelCase links, creating new files where necessary etc., to see if it could be adapted for ikiwiki (See [[tips/vim syntax highlighting/discussion]]). I didn't get anywhere. -- [[Jon]]
60
61 >> when I wrote the plugin I also considered the possibility of creating files (and their dirs, if necessary) 
62 >> from new wikilinks; the changes needed to get that working are fairly small -- [[jerojasro]]
63
64 > Seems about ready for me to think about pulling it into ikiwiki
65 > alongside [[tips/vim_syntax_highlighting/ikiwiki.vim]]. If you'll
66 > please slap a license on it. :) --[[Joey]] 
67 >
68 >> GPL version 2 or later (if that doesn't cause any problems here). I'll add it
69 >> to the file --[[jerojasro]]
70
71 > Also, I have a possible other approach for finding ikiwiki's root. One
72 > could consider that any subdirectory of an ikiwiki wiki is itself
73 > a standalone wiki, though probably one missing a toplevel index page.
74 > The relative wikilinks work such that this assumption makes sense;
75 > you can build any subdirectory with ikiwiki and probably get something
76 > reasonable with links that work, etc.
77
78 > So, if that's the case, then one could say that the directory that the
79 > user considers to be the toplevel of their wiki is really also a subwiki,
80 > enclosed in a succession of parents that go all the way down to the root
81 > directory (or alternatively, to the user's home directory). I think that
82 > logically makes some sense.
83
84 > And if that's the case, you can resolve an absolute link by looking for
85 > the page closest to the root that matches the link.
86 >
87 >> I like your idea; it doesn't alter the matching of the relative links, and
88 >> should work fine with absolute links too. I'll implement it, though I see
89 >> some potential (but small) issues with it --[[jerojasro]]
90
91 > It may even make sense to change ikiwiki's own handling of "absolute"
92 > links to work that way. But even without changing ikiwiki, I think it
93 > would be a reasonable thing for vim to do. It would only fail in two
94 > unusual circumstances:
95
96 > 1. There is a file further down, outside what the user considers
97 >    the wiki, that matches. Say a `$HOME/index.mdwn`
98 > 2. An absolute link is broken in that the page linked to does
99 >    not exist in the root of the wiki. But it does exist in a subdir, 
100 >    and vim would go to that file.
101
102 > --[[Joey]] 
103 >
104 >> your approach will add more noise when the plugin grows the page-creation
105 >> feature, since there will be no real root to limit the possible locations for
106 >> the new page. But it is far better than demanding for a `.ikiwiki` dir --[[jerojasro]]