aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/write/external.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/write/external.mdwn')
-rw-r--r--doc/plugins/write/external.mdwn5
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