]> sipb.mit.edu Git - ikiwiki.git/blob - doc/todo/Pagination_next_prev_links.mdwn
(no commit message)
[ikiwiki.git] / doc / todo / Pagination_next_prev_links.mdwn
1 I've observed people just seem to get into a dead end whilst reading my ikiwiki instances.
2
3 They don't want to back out of post to an index. They want an easy button to click next or previous post, like what you find on Wordpress sites.
4
5 <http://codex.wordpress.org/Next_and_Previous_Links>
6
7 [Jekyll](http://jekyllrb.com/)'s implementation looks rather neat:
8
9 * <https://github.com/mojombo/jekyll/wiki/template-data>
10 * <https://github.com/mojombo/jekyll/blob/master/lib/jekyll/generators/pagination.rb>
11
12
13
14 > This is a perfect use for [[todo/wikitrails]], of which my
15 > [[plugins/contrib/trail]] plugin is an implementation. Code review on that
16 > plugin would be welcome; it might even get merged one day.
17 >
18 > Unfortunately, IkiWiki blogs use a [[ikiwiki/PageSpec]] to define the set of
19 > "posts" in the blog (through which the next/prev trail should range), and
20 > the current implementation of [[plugins/contrib/trail]] in terms of typed
21 > links would have a circular dependency if used with a PageSpec: typed links
22 > have to be added before PageSpecs are evaluated, because "A links to B" is
23 > something that can be in a PageSpec; but if you want to add typed links
24 > ("A is part of trail B" in this case) based on a PageSpec, then the PageSpec
25 > must be evaluated before the typed links can be added. Chicken/egg.
26 >
27 > One solution would be to make the trail plugin use its own data
28 > structure, like [[plugins/contrib/album]] used to do, instead of typed
29 > links: at scan time, the trail plugin would just record what the PageSpec
30 > was, and delay actually *evaluating* the PageSpec until the beginning
31 > of the `render` stage (after all pages have been scanned). This
32 > reduces the generic usefulness of typed links, though - in particular
33 > you can no longer use "is part of trail A" in a PageSpec. --[[smcv]]
34
35 >> Version 3 of [[plugins/contrib/trail]] now does this. For `traillink`
36 >> and `trailitem` it additionally adds a typed link, which it does not
37 >> itself consume; for `trailinline` and `trail` it doesn't. --[[smcv]]
38
39 >>> Indeed, I know the problem; I ran into the same kind of thing with my [[plugins/contrib/report]] plugin and its `trail` concept.
40 >>> I simply had to declare that one couldn't use "trail" and "maketrail" options within the same report. That way, "maketrail" will add links in the "scan" pass, and "trail" will test for links in the "build" pass.  That usually works. --[[KathrynAndersen]]
41
42 >>>> I'm not sure that even that is *quite* right: if your `trail` takes
43 >>>> pagespecs as arguments, then it's potentially evaluating those pagespecs
44 >>>> before all pages have been scanned, which could mean it lists pages
45 >>>> which matched the spec before a recent change, or doesn't list pages
46 >>>> which didn't previously match the spec but do now.
47 >>>>
48 >>>> In version 3 of [[plugins/contrib/trail]] I ended up storing
49 >>>> uninterpreted pagespecs and links at scan time, and evaluating them the
50 >>>> first time a page is built. I *think* that's sufficiently lazy to give
51 >>>> the right answer... --[[smcv]]
52
53 >> Do you have an example? --[[hendry]]
54
55 >>> Now linked on the plugin's page - it doesn't pretend to be a blog, but
56 >>> [the second demo](http://demo.hosted.pseudorandom.co.uk/trail2/)
57 >>> is a `trailinline`, so you could do that with blog posts just as well.
58 >>> Making [[plugins/contrib/album]] require `trail` v3, and trying it out
59 >>> on my blog, are next on the list.
60 >>> --[[smcv]]
61
62 >>>> Sorry thank link <http://demo.hosted.pseudorandom.co.uk/trail2/> doesn't work. I get a forbidden. --[[hendry]]