From 055179cb4cc9b8bc9b204e1a9f83b1f59e13824e Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Sat, 8 Dec 2007 17:40:50 -0500 Subject: * Finally implemented a simple per-page data storage mechanism for plugins, via the %pagestate hash. * Use pagestate in meta to detect potential redir loops. --- doc/plugins/write/external.mdwn | 5 +++++ 1 file changed, 5 insertions(+) (limited to 'doc/plugins/write') diff --git a/doc/plugins/write/external.mdwn b/doc/plugins/write/external.mdwn index 0abc9b0a0..a1a3811dc 100644 --- a/doc/plugins/write/external.mdwn +++ b/doc/plugins/write/external.mdwn @@ -49,6 +49,11 @@ to access any such global hash. To get the "url" configuration value, call `getvar("config", "url")`. To set it, call `setvar("config", "url", "http://example.com/)`. +The `%pagestate` is a special hash with a more complex format. To access +it, external plugins can use the `getstate` and `setstate` RPCs. To access +stored state, call `getstate("page", "id", "key")`, and to store state, +call `setstate("page", "id", "key", "value")`. + ## Notes on function parameters The [[plugin_interface_documentation|write]] talks about functions that take -- cgit v1.2.3