From: Joey Hess <joey@kodama.kitenet.net>
Date: Sun, 1 Jun 2008 16:59:33 +0000 (-0400)
Subject: document that pagestate values can be anything Storable handles
X-Git-Tag: 2.49~41
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=5e9e72b7356b39711ccf72f6b44b883b7d65ea3e;hp=c1289de1eff4c0b4b2cd47e61b2273970e327009;p=ikiwiki.git

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.
---

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.