urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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.
master
Joey Hess 2008-06-01 12:59:33 -04:00
parent c1289de1ef
commit 5e9e72b735
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/plugins/write.mdwn
View 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.