doc/todo/transient_pages.mdwn

   1 On [[todo/auto-create_tag_pages_according_to_a_template]], [[chrysn]]
   2 suggests:
   3
   4 > Instead of creating a file that gets checked in into the RCS, the
   5 > source files could be left out and the output files be written as
   6 > long as there is no physical source file (think of a virtual underlay).
   7 > Something similar would be required to implement alias directive,
   8 > which couldn't be easily done by writing to the RCS as the page's
   9 > contents can change depending on which other pages claim it as an alias.
  10
  11 `add_autofile` could be adapted to do this, or a similar API could be
  12 added.
  13
  14 This would also be useful for autoindex, as suggested on
  15 [[plugins/autoindex/discussion]]. I'd also like to use it for
  16 [[plugins/contrib/album]].
  17
  18 One refinement I'd suggest is that if the transient page is edited,
  19 its transient contents are evaluated and used as the initial
  20 content for the edit box; after that, it'd become a static page. --[[smcv]]
  21
  22 --------------------------
  23
  24 [[!template id=gitbranch branch=smcv/transient author="[[smcv]]"]]
  25 [[!tag patch]]
  26
  27 I had a look at implementing this. It turns out to be harder than I thought
  28 to have purely in-memory pages (several plugins want to be able to access the
  29 source file as a file), but I did get this proof-of-concept branch
  30 to write tag and autoindex pages into an underlay.
  31
  32 This loses the ability to delete the auto-created pages (although they don't
  33 clutter up git this way, at least), and a lot of the code in autoindex is
  34 probably now redundant, so this is probably not quite ready for merge, but
  35 I'd welcome opinions.
  36
  37 Usage: set `tag_underlay` and/or `autoindex_underlay` to an absolute path,
  38 which you must create beforehand. I suggest *srcdir* + `/.ikiwiki/transient`.
  39
  40 Refinements that could be made if this approach seems reasonable:
  41
  42 * make these options boolean, and have the path always be `.ikiwiki/transient`
  43 * improve the `remove` plugin so it also deletes from this special underlay
  44
  45 >> Perhaps it should be something more generic, so that other plugins could use it (such as "album" mentioned above).
  46 >> The `.ikiwiki/transient` would suit this, but instead of saying "tag_underlay" or "autoindex_underlay" have "use_transient_underlay" or something like that?
  47 >> Or to make it more flexible, have just one option "transient_underlay" which is set to an absolute path, and if it is set, then one is using a transient-underlay.
  48 >> --[[KathrynAndersen]]
  49
  50 >>> What I had in mind was more like `tag_autocreate_transient => 1` or
  51 >>> `autoindex_transient => 1`; you might conceivably want tags to be
  52 >>> checked in but autoindices to be transient, and it's fine for each
  53 >>> plugin to make its own decision. Going from that to one boolean
  54 >>> (or just always-transient if people don't think that's too
  55 >>> astonishing) would be trivial, though.
  56 >>>
  57 >>> I don't think relocating the transient underlay really makes sense,
  58 >>> except for prototyping: you only want one, and `.ikiwiki` is as good
  59 >>> a place as any (ikiwiki already needs to be able to write there).
  60 >>>
  61 >>> For [[plugins/contrib/album]] I think I'd just make the photo viewer
  62 >>> pages always-transient - you can always make a transient page
  63 >>> permanent by editing it, after all.
  64 >>>
  65 >>> Do you think this approach has enough potential that I should
  66 >>> continue to hack on it? Any thoughts on the implementation? --[[smcv]]
  67
  68 >>>> Ah, now I understand what you're getting at. Yes, it makes sense to put transient pages under `.ikiwiki`.
  69 >>>> I haven't looked at the code, but I'd be interested in seeing whether it's generic enough to be used by other plugins (such as `album`) without too much fuss.
  70 >>>> The idea of a transient underlay gives us a desirable feature for free: that if someone edits the transient page, it is made permanent and added to the repository.
  71 >>>>
  72 >>>> I think the tricky thing with removing these transient underlay pages is the question of how to prevent whatever auto-generated the pages in the first place from generating them again - or, conversely, how to force whatever auto-generated those pages to regenerate them if you've changed your mind.
  73 >>>> I think you'd need something similar to `will_render` so that transient pages would be automatically removed if whatever auto-generated them is no longer around.
  74 >>>> -- [[KathrynAndersen]]