Merge branch 'master' into autoconfig

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

diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 271d8d64167cf8e0c6e3e16e8e64977af061a5e3..686f7e518850febee6b47acde5951027f63c1281 100644 (file)
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -376,7 +376,6 @@ describing the option. For example:
                 return
                        option_foo => {
                                type => "boolean",
                 return
                        option_foo => {
                                type => "boolean",

-                               default => 0,

                                description => "enable foo",
                                safe => 1,
                                rebuild => 1,
                                description => "enable foo",
                                safe => 1,
                                rebuild => 1,


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

-* `type` can be "boolean", "string", "integer", or `undef` (use for complex
-  types). Note that the type is the type of the leaf values; the `%config`
-  option may be an array or hash of these.
-* `default` should be set to the default value of the option, if any.
-* `example` can be set to an example value, which will not be used by default.
+* `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.
+* `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
   configuration methods, such as the web interface. Anything that specifies
 * `description` is a short description of the option.
 * `safe` should be false if the option should not be displayed in unsafe
   configuration methods, such as the web interface. Anything that specifies