Merge commit 'origin/master'

[git.ikiwiki.info.git] / doc / todo / recentchanges.mdwn

diff --git a/doc/todo/recentchanges.mdwn b/doc/todo/recentchanges.mdwn
index bdd7948e4e5d448b3b6490a910a103f526d097d0..25a8ea4dbf973e365357b670f54bc0f3a333439b 100644 (file)
--- a/doc/todo/recentchanges.mdwn
+++ b/doc/todo/recentchanges.mdwn
@@ -92,7 +92,7 @@ your pages. --Ethan
 Here's a full design for redoing recentchanges, based on Ethan's ideas:
 
 * Add a recentchanges plugin that has a preprocessor directive:
 Here's a full design for redoing recentchanges, based on Ethan's ideas:
 
 * Add a recentchanges plugin that has a preprocessor directive:

-       \[[recentchanges num=100 pages=* template=recentchanges.tmpl]]
+       \[[!recentchanges num=100 pages=* template=recentchanges.tmpl]]

   If put on the [[recentchanges]] page, this would result in up to 100
   recentchanges/change_$id.mdwn files being created.
 * Which means the plugin has to store state and use a checkconfig hook
   If put on the [[recentchanges]] page, this would result in up to 100
   recentchanges/change_$id.mdwn files being created.
 * Which means the plugin has to store state and use a checkconfig hook


@@ -107,11 +107,8 @@ Here's a full design for redoing recentchanges, based on Ethan's ideas:
   aggregator, or they can set up their own page that uses the recentchanges
   directive for only the pages they want.
 * The `rcs_notify` functions will be removed.
   aggregator, or they can set up their own page that uses the recentchanges
   directive for only the pages they want.
 * The `rcs_notify` functions will be removed.

-* `rcs_getchange` is passed a change id (as returned from rcs_recentchanges)
-  and a partially filled out HTML::Template and fills out the remainer of the
-  template. So if a template is used that includes diffs, it will need to run
-  some expensive diffing operation, wikis with less resources can use a
-  template that doesn't include diffs and avoid that overhead.
+* To add diffs, another plugin can add a pagetemplate hook that calls
+  a `rcs_diff`. (optional)

 * So to update the changes files, just call `rcs_recentchanges`, create
   files for each new id, and delete files for each id that is no longer
   included.
 * So to update the changes files, just call `rcs_recentchanges`, create
   files for each new id, and delete files for each id that is no longer
   included.


@@ -143,3 +140,5 @@ page later gets deleted. I think that's acceptable. It could link to
 `ikiwiki.cgi?do=redir&page=foo`, but that's probably overkill.
 
 --[[Joey]]
 `ikiwiki.cgi?do=redir&page=foo`, but that's probably overkill.
 
 --[[Joey]]

+
+[[done]] !! (in this branch at least :-)