ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / todo / do_not_make_links_backwards.mdwn
1 [[!template  id=gitbranch branch=anarcat/backwards_links author="[[anarcat]]"]]
2
3 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]]`.
4
5 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.
6
7 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]]
8
9 Dev notes
10 ---------
11
12 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]]).
13
14 The following needs to be done:
15
16  1. the `link_regexp` variable needs to be turned backwards (or frontwards, if you like :P) (./) added an option for this, working!
17  2. a config setting need to be added to the `link` plugin so that we can choose if we want backwards links or not (./) `links_direction`, how does that sound? I have changed that from `backwards_links` to be more neutral. 'rtl' means `\[[link|text]]` and 'ltr' means `\[[text|link]]`
18  3. a (solid!) parser needs to be written for [[ikiwiki-transition]] to change the actual links (if necessary) (./) done!
19  4. rewrite tests to take into account the two syntaxes (!) would be done when we migrate to the syntax
20  5. deal with underlays (./) i wrote a script to convert it to markdown
21
22 Discussion
23 ----------
24
25 > It's not at all obvious to me that `rtl` should mean "link before description"
26 > and not the other way round. Perhaps `wikilink_text_first` => `1` for the historical
27 > IkiWiki syntax or `0` for the Creole/Mediawiki syntax? --[[smcv]]
28 >
29 > > A friend made the argument that it is more natural for a human to read the `text` then `link`, as the link is less important. Since we (occidental languages) read left to right, I felt this was appropriate. I also blindly assumed that it would "feel" also appropriate for right to left languages (arabic, hebrew, etc) to have those links backwards, and those languages are generally named "right to left".
30 > > 
31 > > Originally, I named that parameter `backwards_links`, but then it wouldn't make sense in the long term, and isn't exactly neutral: it assume the current way is backwards! Your suggestion is interesting however, but I don't think the rtl/ltr nomenclature is problematic, with proper documentation of course... --[[anarcat]]
32
33 There's a caveat: we can't have a per-wiki backwards_links option, because of the underlay, common to all wikis, which needs to be converted. So the option doesn't make much sense. Not sure how to deal with this... Maybe this needs to be at the package level? --[[anarcat]]
34
35 > I've thought about adding a direction-neutral `\[[!link]]` directive -
36 > see [[link plugin perhaps too general?]] for details. The basewiki
37 > could use `\[[!link to=b desc=a]]` whenever it needs `\[[a|b]]`-style
38 > links, maybe? --[[smcv]]
39
40 >> It could, but it would be a pain to remember to do that.
41 >> 
42 >> I feel that this should probably be a flag day transition because
43 >> otherwise there will be a lot of variation between how different
44 >> ikiwikis handle links, which is even worse than the current variation
45 >> between ikiwiki and other wikis!
46 >>
47 >> There are quite likely ikiwiki page generators that build wikilinks
48 >> too. One that's part of ikiwiki itself is `change.tmpl`. There may be
49 >> others... --[[Joey]]
50
51 >>> Agreed that it would be cleaner to just change everything, even though the transition might be painful.
52
53 >>> Another interim option might be to change the basewiki links to be just \[[link to whatever]] without having a description.
54 >>> That style of link would work whether the link style was "backwards" or "forwards".  Unfortunately it could make some links less readable; after all, there is a reason why one wants to be able to change the link text!  But I don't know what proportion of the links are like that.  It's a thought, anyway.
55 >>> --[[KathrynAndersen]]
56
57 >>>> I dislike placing such requirements on the underlay, which is after
58 >>>> all, just a subset of pages in this wiki, which many of the people
59 >>>> editing may not even realize are part of the underlay. --[[Joey]]
60
61 >>> Another option for internal links is to just use the regular markdown links instead of `\[[text|link]]` markup, that way it works regardless. Then the documentation for the link plugin just has to state both syntaxes in a safe manner.
62 >>> I also agree that we should just switch in one shot, although I am worried this means this could be postponed indefinitely.--[[anarcat]]
63
64 >>>> I have done just that in my branch: now the underlay only uses wikilinks in the wikilink page, elsewhere regular markdown links are used. I haven't converted the whole of the doc/ directory however, that would be left to the migration. I have written a ikiwik-transition tool to migrate from wikilink to markdown while i was there. --[[anarcat]]
65
66 >>>>> No, that is *not* an option. Relative markdown links **break** when
67 >>>>> page A, containing a link, is inlined into page B. --[[Joey]]
68
69 ----
70
71 FWIW, I think this change may well be painful, but is a good idea. I can never remember which way around it should be.
72 Rather like USB plugs, I invariably have to try both ways. — [[Jon]]
73
74 The bikeshed color should be ...
75 --------------------------------
76
77 ...[blue](http://blue.bikeshed.org/) of course. :) Just to make things clear here, the "bikeshedding" potential is absolutely huge here. right to left? left to right? who's right? how could we even decide this?
78
79 I think we can approach this rationnally:
80
81  1. left to right (text then link) can be considered more natural, and should therefore be supported
82  2. it is supported in markdown using regular markdown links. in the proposed branch, the underlay wikilinks are converted to use regular markdown links
83  3. ikiwiki links break other markup plugins, like mediawiki and creole, as those work right to left.
84  4. those are recognized "standards" used by other popular sites, like Wikipedia, or any wiki supporting the Creole markup, which is [most wikis](http://www.wikicreole.org/wiki/Engines)
85
86 Therefore, to respect interoperability and [POLA](https://en.wikipedia.org/wiki/Principle_of_least_astonishment), ikiwiki should respect that convention and reverse the way links are parsed by the link plugin, or move that functionality into creole/mediawiki modules, and out of the main core, which I do not think can be an option.
87
88 So here's a roadmap to deploy this change:
89
90  1. the code in the backwards_links branch i am working on is tested and proven, then merged in
91  2. a release of the 3.x branch is published with the possibility for wikis to convert to the new markup, with the notion that the older markup is deprecated
92  3. this wiki is converted to the new markup
93  4. 4.0 is released with the new markup enabled by default and runs ikiwiki-transition on your wiki on upgrade
94
95 Note that ikiwiki-transition can be ran multiple and will convert your markup to and from rtl/ltr, without issues, so this is pretty sturdy. I think the configuration variable can be kept throughout 4.x, with the notion that it will be completely removed eventually. --[[anarcat]]