summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-06-01 12:59:33 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-06-01 12:59:33 -0400
commit5e9e72b7356b39711ccf72f6b44b883b7d65ea3e (patch)
tree2e8a2efcf2be9162f79a5af41598cc13d2806fc2
parentc1289de1eff4c0b4b2cd47e61b2273970e327009 (diff)
document that pagestate values can be anything Storable handles
This only started being true by accident when the index was changed to use Storable, but it's a nice feature.
-rw-r--r--doc/plugins/write.mdwn9
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 508dd83dc..606031cf2 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -361,10 +361,11 @@ next time ikiwiki is run. The hash holds per-page state, so to set a value,
use `%pagestate{$page}{$id}{$key}=$value`, and to retrieve the value,
use `%pagestate{$page}{$id}{$key}`.
-`$key` can be any string you like, but `$id` must be the same as the "id"
-parameter passed to `hook()` when registering the plugin. This is so
-ikiwiki can know when to delete pagestate for plugins that are no longer
-used.
+The `$value` can be anything that perl's Storable module is capable of
+serializing. `$key` can be any string you like, but `$id` must be the same
+as the "id" parameter passed to `hook()` when registering the plugin. This
+is so ikiwiki can know when to delete pagestate for plugins that are no
+longer used.
When pages are deleted, ikiwiki automatically deletes their pagestate too.