diff options
| author | Joey Hess <joey@kitenet.net> | 2007-12-08 17:40:50 -0500 |
|---|---|---|
| committer | Joey Hess <joey@kitenet.net> | 2007-12-08 17:40:50 -0500 |
| commit | 055179cb4cc9b8bc9b204e1a9f83b1f59e13824e (patch) | |
| tree | 1a48f2f93684238180b355df67f2aa48dcfb1be4 /doc/plugins/write | |
| parent | 2fbca21390d2752a89a2e1167fe33d4d201359cf (diff) | |
* Finally implemented a simple per-page data storage mechanism for plugins,
via the %pagestate hash.
* Use pagestate in meta to detect potential redir loops.
Diffstat (limited to 'doc/plugins/write')
| -rw-r--r-- | doc/plugins/write/external.mdwn | 5 |
1 files changed, 5 insertions, 0 deletions
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 |