I'm writing a plugin and I'd like to force all the pages that include a directive which my plugin defines to be rebuilt when the wiki is refreshed (whether or not those pages have changed).
I've found the "needsbuild" hook which I could use to get pages to be rebuilt. But how can I work out which pages include my directive? And will needsbuild get called for every occurrence of my directive? I only need to rebuild those pages once (obviously). When the needsbuild hook gets called, is it because the directive match its 'id' hook() parameter has been encountered? And does needsbuild know what page is being processed?
Or is there some other way of doing this?
Something you can do is storing the list of pages containing your directive somewhere (I'll get back at it later). Then, at the next refresh of your wiki, the
needsbuildhook will mark those pages as to be rebuilt, and reset the variable storing the page to be rebuild.I see two ways so store this information:
%wikistatevariable: you would have a$wikistate{yourPlugin}{rebuild}containing the list of pages to rebuild;%pagestatevariable: if a page contains your directive, set$pagestate{$page}{yourPlugin}{rebuild}to 1.I think the second solution would be easier to implement. In either case, do not forget to reset them in the
needsbuildhook. Otherwise, a page containing your directive would be rebuilt at each refresh, forever, even if it no longer contain this directive.To answer your other questions about
needsbuild(): it is called only once (not once per page: once per ikiwiki call). It get as argument the list of pages to be rebuild. You append to it the pages you want to rebuild (according to the%wikistateor%pagestatevalue I described), and you return it.Five months old… I do not know if this answer will be useful…
-- Louis