]> sipb.mit.edu Git - ikiwiki.git/commitdiff
document that pagestate values can be anything Storable handles
authorJoey Hess <joey@kodama.kitenet.net>
Sun, 1 Jun 2008 16:59:33 +0000 (12:59 -0400)
committerJoey Hess <joey@kodama.kitenet.net>
Sun, 1 Jun 2008 16:59:33 +0000 (12:59 -0400)
This only started being true by accident when the index was changed to
use Storable, but it's a nice feature.

doc/plugins/write.mdwn

index 508dd83dc102dfaad6ac99024e1a04f594b91f63..606031cf2b37d53595b4bae5917bd21c120c46e1 100644 (file)
@@ -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.