]> sipb.mit.edu Git - ikiwiki.git/blob - doc/wishlist/do_not_make_links_backwards.mdwn
add results of my research and a roadmap
[ikiwiki.git] / doc / wishlist / do_not_make_links_backwards.mdwn
1 I understand this may be a bit provocative, but I strongly feel that ikiwiki linking rules are backwards. I come from the world of wikis like MoinMoin and [[plugins/contrib/mediawiki]], where you use `\[[link|description]]`. The defacto wiki markup "[[plugins/creole]]" also uses that convention, as does raw HTML (href comes first!). Ikiwiki doesn't: here we need to use `\[[description|link]]`.
2
3 Everytime i come back to ikiwiki, i need to bend my mind backwards to create *proper* links. I understand that `\[[description|link]]` is more inline with Markdown's `[description](link)` approach, but in my mind it is too much of a problem for third part plugins to be a proper justification. For example, the [[plugins/creole]] plugin works pretty much as expected *expect* for links, because it can't override ikiwiki's internal link parser. For me that's a huge inconsistency that should be fixed.
4
5 If there is an agreement within the community that we can change that, I am ready to work on a migration script or even a configuration variable... -- [[anarcat]]
6
7 Dev notes
8 ---------
9
10 I started looking into this, after encouraging words from Joey ("very long term roadmap", AKA "if someone does it"). It turns out it is less deeply rooted than i thought in the core of ikiwiki; everything being a plugin and all, this is also a plugin ([[plugins/link]]).
11
12 The following needs to be done:
13
14  1. the `link_regexp` variable needs to be turned backwards (or frontwards, if you like :P)
15  2. a config setting need to be added to the `link` plugin so that we can choose if we want backwards links or not
16  3. a (solid!) parser needs to be written for [[ikiwiki-transition]] to change the actual links (if necessary)