git.oblomov.eu Git - ikiwiki/blob - doc/todo/wikitrails/discussion.mdwn

   1 (This mainly discusses the original implementation (chrysn's). --[[smcv]])
   2
   3 ----
   4
   5 This is a nice idea, I do have my gripes about the imeplementation.
   6
   7 Assuming that the index's list is in mdwn format is not ideal. I guess the
   8 other way to do it would be to make the index be a directive, something
   9 like: \[[!trail pages="foo bar baz"]]. Assuming that a flat trail structure
  10 is enough, otherwise you'd have to get more fancy.
  11
  12 The trailinclude seems a bit redundant with inline, and wanting to inline
  13 together all pages in a trail for printing or whatever seems like an
  14 unusual use case anyway?
  15
  16 The !trail directive could be simplified to just \[[!trail my_indexpage]].
  17 But I wonder if needing to add this directive to every page is the best
  18 approach. Alternate approach would be to make the trail index cause
  19 breadcrums to be automatically inserted at the top of every page on the
  20 trail. (You'd have to use a directive to define the index for that to work.)
  21
  22 --[[Joey]]
  23
  24 ----
  25
  26 Revisiting this, after effectively reimplementing a small version of it
  27 in [[plugins/contrib/album]]: it occurs to me that might be a more
  28 "ikiwiki-like" way we could get this functionality.
  29
  30 In the index page, you either want an [[ikiwiki/directive/inline]], or
  31 a list of links. In the former case, maybe we could extend inline like
  32 this:
  33
  34     \[[!inline ... blah blah ... trail=yes]]
  35
  36 to make it remember the pages it inlined, in order, in the pagestate;
  37 in the latter case, we could replace the wikilinks with a directive,
  38 an operation something like this in diff notation:
  39
  40     - \[[one]] - the unit
  41     - \[[two]] - the base of binary
  42     - \[[three|3]] - is a crowd
  43     + \[[!trailitem one]] - the unit
  44     + \[[!trailitem two]] - the base of binary
  45     + \[[!trailitem three|3]] - is a crowd
  46
  47 and have that directive remember the pages in order.
  48
  49 In both cases, a scan() hook could clear the list before starting to
  50 scan, then the inline or trailitem preprocessor directive could run in
  51 the scan stage as well as the render stage (in the case of inline,
  52 there'd be a very early return if trail=yes was not given, and
  53 an early return after collecting and sorting the pages if not
  54 actually rendering).
  55
  56 This would mean that the contents of the trail, and a list of
  57 trails in which each page can be found, would already be in
  58 the pagestate by the time any page was rendered, so we'd be able
  59 to use them for output, either in a pagetemplate() hook or
  60 a \[[!trail]] preprocessor directive.
  61
  62 This way, my album plugin could be turned inside out: instead
  63 of precomputing the pages to be inlined, then using
  64 [[pagenames|todo/inline plugin: specifying ordered page names]]
  65 to get them into the inline, it could just do the inline, then
  66 incorporate the output of \[[!trail]] into the template rendered
  67 for \[[!albumimage]] on each viewer page. (Also, the viewers
  68 wouldn't necessarily need to reference the album, only the other
  69 way round.)
  70
  71 Using a pagetemplate() hook to stuff the next/previous links
  72 into page.tmpl would actually be a bit unfortunate for \[[!album]],
  73 because that plugin definitely wants to style the next/previous
  74 links as a thumbnail, which means there'd have to be a way to
  75 affect the style - perhaps by arranging for album's pagetemplate
  76 hook to run *after* trail's, or perhaps by having trail's
  77 pagetemplate hook disable itself for pages that contain
  78 a \[[!trail]] directive.
  79
  80 I have now implemented this at [[plugins/contrib/trail]].
  81 What do you think? I'm still not sure how it would relate
  82 to [[plugins/contrib/album]], but if trail is reviewed
  83 and approved in principle, I'll try to adapt album as
  84 outlined above. --[[smcv]]