diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/plugins/websetup.mdwn | 21 | ||||
| -rw-r--r-- | doc/plugins/write.mdwn | 19 |
2 files changed, 24 insertions, 16 deletions
diff --git a/doc/plugins/websetup.mdwn b/doc/plugins/websetup.mdwn index 1e4ed4d0c..11cc6ad1e 100644 --- a/doc/plugins/websetup.mdwn +++ b/doc/plugins/websetup.mdwn @@ -2,18 +2,15 @@ [[!tag type/useful]] This plugin allows wiki admins to configure the wiki using a web interface, -rather than editing the setup file directly. A "Wiki Setup" button is added to the -admins' preferences page. +rather than editing the setup file directly. A "Wiki Setup" button is added +to the admins' preferences page. -Most settings can be modified using the web interface. Some settings are -not considered safe enough to be manipulated over the web; these are still -shown, by default, but cannot be modified. To hide them, set `websetup_show_unsafe` -to false in the setup file. A few settings have too complex a data type -to be configured via the web. +Most settings can be modified using the web interface. Plugins can be +enabled and disabled using it too. Some settings are not considered safe +enough to be manipulated over the web; these are still shown, by default, +but cannot be modified. To hide them, set `websetup_show_unsafe` to false +in the setup file. A few settings have too complex a data type to be +configured via the web. -The web interface can also be used to enable and disable plugins, with -limitations. The plugin for the [[revision_control_system|rcs]] being used -cannot be enabled/disabled, and no other rcs plugins can be enabled. A few -problematic/unsafe plugins are also blacklisted from being enabled. Other -plugins that should not be enabled/disabled via the web interface can be +Plugins that should not be enabled/disabled via the web interface can be listed in `websetup_force_plugins` in the setup file. diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index fc4b778db..67f1cf2ba 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -379,12 +379,13 @@ 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: +describing the option. There can also be an item named "plugin", which +describes the plugin as a whole. For example: return option_foo => { type => "boolean", - description => "enable foo", + description => "enable foo?", advanced => 1, safe => 1, rebuild => 1, @@ -392,10 +393,15 @@ describing the option. For example: option_bar => { type => "string", example => "hello", - description => "what to say", + description => "option bar", safe => 1, rebuild => 0, }, + plugin => { + description => "description of this plugin", + safe => 1, + rebuild => 1, + }, * `type` can be "boolean", "string", "integer", "pagespec", or "internal" (used for values that are not user-visible). The type is @@ -410,7 +416,12 @@ describing the option. For example: * `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. -* `rebuild` should be true if changing the option will require a wiki rebuild. + If a plugin is marked as unsafe, that prevents it from being + enabled/disabled. +* `rebuild` should be true if changing the option (or enabling/disabling + the plugin) will require a wiki rebuild, false if no rebuild is needed, + and undef if a rebuild could be needed in some circumstances, but is not + strictly required. ## Plugin interface |