despam

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

diff --git a/doc/plugins/websetup.mdwn b/doc/plugins/websetup.mdwn
index 1e4ed4d0c73ba3c019fdd6e6db5cf071304554c0..387c90b75bdf54d56d24b92a74b3b8f409d58f4b 100644 (file)
--- a/doc/plugins/websetup.mdwn
+++ b/doc/plugins/websetup.mdwn
@@ -1,19 +1,27 @@
 [[!template id=plugin name=websetup core=0 author="[[Joey]]"]]
 [[!template id=plugin name=websetup core=0 author="[[Joey]]"]]

-[[!tag type/useful]]
+[[!tag type/web]]

 
 This plugin allows wiki admins to configure the wiki using a web interface,
 
 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 "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.
+Warning: This plugin rewrites your setup file. Any comments or unusual
+things (such as perl code) in the setup file will not be preserved. Also,
+it will only work correctly with new format setup files, as introduced in
+ikiwiki 2.60. Older setup files have a "wrappers" section, which will not
+be properly preserved if this plugin is used.

 
 

-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
+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. To mark additional settings as unsafe, you can
+list them in `websetup_unsafe`.
+
+Plugins that should not be enabled/disabled via the web interface can be

 listed in `websetup_force_plugins` in the setup file.
 listed in `websetup_force_plugins` in the setup file.

+
+When the setup is saved, the setup file will be rewritten with the new
+settings, and the wiki will be refreshed, or rebuilt, to make the setup
+changes take effect.