add
authorJoey Hess <joey@kodama.kitenet.net>
Sun, 3 Aug 2008 03:54:19 +0000 (23:54 -0400)
committerJoey Hess <joey@kodama.kitenet.net>
Sun, 3 Aug 2008 03:54:19 +0000 (23:54 -0400)
doc/plugins/websetup.mdwn [new file with mode: 0644]

diff --git a/doc/plugins/websetup.mdwn b/doc/plugins/websetup.mdwn
new file mode 100644 (file)
index 0000000..1e4ed4d
--- /dev/null
@@ -0,0 +1,19 @@
+[[!template id=plugin name=websetup core=0 author="[[Joey]]"]]
+[[!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.
+
+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.
+
+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
+listed in `websetup_force_plugins` in the setup file.