fix cgiurl check

[git.ikiwiki.info.git] / doc / plugins / write.mdwn

diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 896b988270914e47faa9b714ac036f6a3da9fd7b..04b6ea8e9d4528291ffeac1791a993d7f3e0c87c 100644 (file)
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -367,8 +367,8 @@ configuration options.
 
 The hook is passed no parameters. It returns data about the configuration
 options added by the plugin. It can also check if the plugin is usable, and
 
 The hook is passed no parameters. It returns data about the configuration
 options added by the plugin. It can also check if the plugin is usable, and

-die if the plugin is not available, which will cause the plugin to not be
-offered in the configuration interface.
+die if not, which will cause the plugin to not be offered in the configuration
+interface.

 
 The data returned is a list of `%config` options, followed by a hash
 describing the option. For example:
 
 The data returned is a list of `%config` options, followed by a hash
 describing the option. For example:


@@ -388,9 +388,9 @@ describing the option. For example:
                                rebuild => 0,
                        },
 
                                rebuild => 0,
                        },
 

-* `type` can be "boolean", "string", "integer", "internal" (used for values
-  that are not user-visible). The type is the type of the leaf values; 
-  the `%config` option may be an array or hash of these.
+* `type` can be "boolean", "string", "integer", "pagespec", or "internal" 
+  (used for values that are not user-visible). The type is the type of
+  the leaf values;  the `%config` option may be an array or hash of these.

 * `example` can be set to an example value.
 * `description` is a short description of the option.
 * `safe` should be false if the option should not be displayed in unsafe
 * `example` can be set to an example value.
 * `description` is a short description of the option.
 * `safe` should be false if the option should not be displayed in unsafe


@@ -417,7 +417,7 @@ it's not exported, the wise choice is to not use it.
 
 A plugin can access the wiki's configuration via the `%config`
 hash. The best way to understand the contents of the hash is to look at
 
 A plugin can access the wiki's configuration via the `%config`
 hash. The best way to understand the contents of the hash is to look at

-[[ikiwiki.setup]], which sets the hash content to configure the wiki.
+your ikiwiki setup file, which sets the hash content to configure the wiki.

 
 ### %pagestate
 
 
 ### %pagestate
 


@@ -769,15 +769,15 @@ IkiWiki::FailReason object if the match fails.
 
 ### Setup plugins
 
 
 ### Setup plugins
 

-The ikiwiki setup file is loaded using a pluggable mechanism. If you
-look at the top of [[ikiwiki.setup]], it starts with 
-'use IkiWiki::Setup::Standard', and the rest of the file is passed to
-that module's import method.
+The ikiwiki setup file is loaded using a pluggable mechanism. If you look
+at the top of a setup file, it starts with 'use IkiWiki::Setup::Standard',
+and the rest of the file is passed to that module's import method.

 
 It's possible to write other modules in the `IkiWiki::Setup::` namespace that
 can be used to configure ikiwiki in different ways. These modules should,
 when imported, populate `$IkiWiki::Setup::raw_setup` with a reference
 
 It's possible to write other modules in the `IkiWiki::Setup::` namespace that
 can be used to configure ikiwiki in different ways. These modules should,
 when imported, populate `$IkiWiki::Setup::raw_setup` with a reference

-to a hash containing all the config items.
+to a hash containing all the config items. They should also implement a
+`gendump` function.

 
 By the way, to parse a ikiwiki setup file, a program just needs to
 do something like:
 
 By the way, to parse a ikiwiki setup file, a program just needs to
 do something like: