summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-07-30 00:20:11 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-07-30 00:20:11 +0000
commitab75c0323bc584203a2b4a507c2a2012523354d0 (patch)
treeff4f82fd125bb7976b74d88520bd3cb847fc814d /doc
parent584fe78075793b2b5dc2992125e88188cae0d1c7 (diff)
* Add a run_hooks function for the common task of running all hooks of a
given type. * Add a savestate hook. * Don't put blog post forms on pages if there's no cgiurl set. * Reformat front page.
Diffstat (limited to 'doc')
-rw-r--r--doc/index.mdwn18
-rw-r--r--doc/plugins/write.mdwn8
-rw-r--r--doc/todo/aggregation.mdwn7
3 files changed, 28 insertions, 5 deletions
diff --git a/doc/index.mdwn b/doc/index.mdwn
index 23e60c00b..1e2ec44e5 100644
--- a/doc/index.mdwn
+++ b/doc/index.mdwn
@@ -4,15 +4,23 @@ into html pages suitable for publishing on a website. Unlike a traditional
wiki, ikiwiki does not have its own means of storing page history.
Instead it can use [[Subversion]] (or [[Git]]).
-* [[News]] is a blog (built using ikiwiki) of news items about ikiwiki. It's the best way to find out when there's a new version to [[Download]].
+* [[News]] is a blog (built using ikiwiki) of news items about ikiwiki.
+ It's the best way to find out when there's a new version to [[Download]].
-* See [[Features]] for a list of ikiwiki's features. [[RoadMap]], [[TODO]] and [[bugs]] might also be of interest. Feel free to post your thoughts about ikiwiki to [[Discussion]].
+* See [[Features]] for a list of ikiwiki's features. [[RoadMap]], [[TODO]]
+ and [[bugs]] might also be of interest. Feel free to post your thoughts
+ about ikiwiki to [[Discussion]].
-* [[Setup]] has a tutorial for setting up ikiwiki, and [[Usage]] documents the parameters and usage of the ikiwiki program. If you use ikiwiki, please add your wiki to [[IkiWikiUsers]].
+* [[Setup]] has a tutorial for setting up ikiwiki, and [[Usage]] documents
+ the parameters and usage of the ikiwiki program. If you use ikiwiki,
+ please add your wiki to [[IkiWikiUsers]].
-* [[Security]] lists potential security problems. ikiwiki is still being developed, and is being written with security as a priority, so don't expect things to stay in this list for long.
+* [[Security]] lists potential security problems. ikiwiki is still being
+ developed, and is being written with security as a priority, so don't
+ expect things to stay in this list for long.
-* Developers, please document any ikiwiki patches you have in the [[PatchQueue]].
+* Developers, please document any ikiwiki patches you have in the
+ [[PatchQueue]].
All wikis are supposed to have a [[SandBox]], so this one does too.
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 93c6d1d5c..025a242a6 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -157,6 +157,14 @@ called in turn, and passed a CGI object. The hook should examine the
parameters, and if it will handle this CGI request, output a page and
terminate the program.
+## savestate
+
+ IkiWiki::hook(type => "savestate", id => "foo", call => \&savestate);
+
+This hook is called wheneven ikiwiki normally saves its state, just before
+the state is saved. The function can save other state, modify values before
+they're saved, etc.
+
# Wiki configuration
A plugin can access the wiki's configuration via the `%IkiWiki::config`
diff --git a/doc/todo/aggregation.mdwn b/doc/todo/aggregation.mdwn
index ce8143fa2..7d765f9e9 100644
--- a/doc/todo/aggregation.mdwn
+++ b/doc/todo/aggregation.mdwn
@@ -15,3 +15,10 @@ poor-man's news aggregator.
better would be to use preprocessor directives in a wiki page, probably
the same page that inlines all the pages together.
* Where to store when a feed was last pulled?
+
+So I need:
+
+* A way to store info from the preprocessor directives about what pages
+ to pull and expiry.
+* A way to store info on last pull time, guids, etc.
+* Switch for a mode that a) pulls b) expires old c) rebuilds wiki (for cron)