X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/2de20bf48b4a0c215c58b28b2ec789d65a4fb4e8..afad77a7e06072609956d19d6bdf7fdd24a5293c:/doc/todo/transient_pages.mdwn diff --git a/doc/todo/transient_pages.mdwn b/doc/todo/transient_pages.mdwn index f4cbdfc8b..fe2259b40 100644 --- a/doc/todo/transient_pages.mdwn +++ b/doc/todo/transient_pages.mdwn @@ -12,20 +12,42 @@ suggests: added. This would also be useful for autoindex, as suggested on -[[plugins/autoindex/discussion]]. I'd also like to use it for -[[plugins/contrib/album]]. +[[plugins/autoindex/discussion]] and [[!debbug 544322]]. I'd also like +to use it for [[plugins/contrib/album]]. It could also be used for an [[todo/alias_directive]]. --[[smcv]] +> All [[merged|done]] --[[Joey]] + -------------------------- [[!template id=gitbranch branch=smcv/ready/transient author="[[smcv]]"]] -[[!template id=gitbranch branch=smcv/ready/transient-recentchanges author="[[smcv]]"]] -[[!template id=gitbranch branch=smcv/ready/transient-tag author="[[smcv]]"]] [[!tag patch]] +Related branches: + +* `ready/tag-test`: an extra regression test for tags + > merged --[[Joey]] +* either `transient-relative` or `transient-relative-api`: avoid using `Cwd` + on initialization + > merged the latter --[[Joey]] +* `ready/transient-aggregate`: use for aggregate + > merged --[[Joey]] +* `ready/transient-autoindex`: optionally use for autoindex, + which is [[!debbug 544322]] (includes autoindex-autofile from + [[todo/autoindex should use add__95__autofile]]) + > merged. I do note that this interacts badly with ikiwiki-hosting's + > backup/restore/branch handling, since that does not back up the + > transientdir by default, and so autoindex will not recreate the + > "deleted" pages. I'll probably have to make it back up the transientdir + > too. --[[Joey]] +* `ready/transient-recentchanges`: use for recentchanges + > merged --[[Joey]] +* `ready/transient-tag`: optionally use for tag (includes tag-test) + > merged --[[Joey]] + I think this branch is now enough to be useful. It adds the following: If the `transient` plugin is loaded, `$srcdir/.ikiwiki/transient` is added @@ -83,13 +105,21 @@ is blocked by working out what the desired behaviour is, on >> which aren't checked in and never have been? I've split the >> branch up in the hope that *some* of it can get merged. >> +>>> I will be happy to merge transient-recentchanges when it's ready. +>>> I see no obstacle to merging transient-tag either, and am not +>>> really against using it for autoindex or aggregate either +>>> once they get completed. +>>> I just wanted to think through why configurability is needed. +>>> --[[Joey]] +>> >> One potentially relevant point is that configuration clutter only >> affects the site admin whereas commit clutter is part of the whole >> wiki's history. --[[smcv]] > Anyway, the configurability > appears subtly broken; the default is only 1 if a new setup file is -> generated. With an existing setup file, the 'default' values in +> generated. (Correction: It was not even the default then --[[Joey]]) +> With an existing setup file, the 'default' values in > `getsetup` don't take effect, so it will default to undef, which > is treated the same as 0. --[[Joey]] @@ -97,6 +127,17 @@ is blocked by working out what the desired behaviour is, on >> defaults take effect whenever the setup file doesn't set a value, btw? >> It seems pretty astonishing to have them work as they do at the moment.) --s +>>> Well, note that default is not actually a documented field in +>>> getsetup hooks at all! (It is used in IkiWiki.pm's own `getsetup()`, and +>>> the concept may have leaked out into one or two plugins (comments, +>>> transient)). +>>> +>>> Running getsetup at plugin load time is something I have considered +>>> doing. It would simplify some checkconfig hooks that just set hardcoded +>>> defaults. Although since dying is part of the getsetup hook's API, it +>>> could be problimaric. +>>> --[[Joey]] + autoindex ignores pages in the transient underlay when deciding whether to generate an index. @@ -117,6 +158,9 @@ Not done yet (in that branch, at least): >> you could give. Note that my branch wasn't meant to enable either >> by default, and now hopefully doesn't. --[[smcv]] + >>> Opened a new bug for this, [[bugs/removal_of_transient_pages]] + >>> --[[Joey]] + * Transient tags that don't match any pages aren't deleted: I'm not sure that that's a good idea anyway, though. Similarly, transient autoindexes of directories that become empty aren't deleted. @@ -129,6 +173,9 @@ Not done yet (in that branch, at least): transient underlay too (they'll naturally migrate over time). I haven't tested this yet, it's just a proof-of-concept. + > Now renamed to `ready/transient-aggregate`; it does seem to work fine. + > --s + > I can confirm that the behavior of autoindex, at least, is excellent. > Haven't tried tag. Joey, can you merge transient and autoindex? --JoeRayhawk @@ -150,6 +197,8 @@ Not done yet (in that branch, at least): >> > Is an unlink() really that expensive? But, OK, fixed in the >> > `ready/transient-recentchanges` branch. --s +>> >> It's not, but it's easy. :) --[[Joey]] + >> * Similarly it's a bit worrying for performance that it >> needs to pull in and use `Cwd` on every ikiwiki startup now. >> I really don't see the need; `wikistatedir` should @@ -171,6 +220,27 @@ Not done yet (in that branch, at least): >> > there's only any point in avoiding `Cwd` for runs that don't >> > actually refresh, like simple uses of the CGI. --s +>> >> Oh, right, I'd forgotten about the horrificness of File::Find +>> >> that required a chdir for security. Ugh. Can we just avoid +>> >> it for those simple cases then? (demand-calculate wikistatedir) +>> >> --[[Joey]] + +>> >>> The reason that transientdir needs to be absolute is that it's +>> >>> added as an underlay. +>> >>> +>> >>> We could avoid using `Cwd` by taking the extra commit from either +>> >>> `smcv/transient-relative` or `smcv/transient-relative-api`; +>> >>> your choice. I'd personally go for the latter. +>> >>> +>> >>> According to git grep, [[plugins/po]] already wants to look at +>> >>> the underlaydirs in its checkconfig hook, so I don't think +>> >>> delaying calculation of the underlaydir is viable. (I also noticed +>> >>> a bug, +>> >>> [[bugs/po:_might_not_add_translated_versions_of_all_underlays]].) +>> >>> +>> >>> `underlaydirs` certainly needs to have been calculated by the +>> >>> time `refresh` hooks finish, so `find_src_files` can use it. --s + >> * Unsure about the use of `default_pageext` in the `change` >> hook. Is everything in the transientdir really going >> to use that pageext? Would it be better to look up the @@ -187,6 +257,13 @@ Not done yet (in that branch, at least): >> > viewer pages optionally be `html`, for better performance >> > when there's a very large number of photos. --s +>> >> Oh, ugh, more File::Find... Couldn't it just assume that the +>> >> transient page has the same extension as its replacement? +>> >> --[[Joey]] + +>> >>> Good idea, that'll be true for web edits at least. +>> >>> Commit added. --s + -------------------------- ## An earlier version