need to adjust goodstuff for 3.0

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

diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 255be4207c54ed5bc05062d421696719919c2b5d..fc4b778db8b8000a724af77be6e04a5749290e73 100644 (file)
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -385,6 +385,7 @@ describing the option. For example:
                        option_foo => {
                                type => "boolean",
                                description => "enable foo",
                        option_foo => {
                                type => "boolean",
                                description => "enable foo",

+                               advanced => 1,

                                safe => 1,
                                rebuild => 1,
                        },
                                safe => 1,
                                rebuild => 1,
                        },


@@ -396,12 +397,16 @@ describing the option. For example:
                                rebuild => 0,
                        },
 
                                rebuild => 0,
                        },
 

-* `type` can be "boolean", "string", "integer", 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.
+* `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.
 * `example` can be set to an example value.
 * `description` is a short description of the option.

-* `description_html` is an optional short description, that can contain html
+* `link` is a link to further information about the option. This can either
+  be a wikilink, or an url.
+* `advanced` can be set to true if the option is more suitable for advanced
+  users.

 * `safe` should be false if the option should not be displayed in unsafe
   configuration methods, such as the web interface. Anything that specifies
   a command to run, a path on disk, or a regexp should be marked as unsafe.
 * `safe` should be false if the option should not be displayed in unsafe
   configuration methods, such as the web interface. Anything that specifies
   a command to run, a path on disk, or a regexp should be marked as unsafe.