X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/137624775407e433935f68b9ee282723adca1513..b0f5f37317242721765d463ad7785b995caee490:/doc/plugins/websetup.mdwn?ds=sidebyside diff --git a/doc/plugins/websetup.mdwn b/doc/plugins/websetup.mdwn index 1e4ed4d0c..f1756ba8f 100644 --- a/doc/plugins/websetup.mdwn +++ b/doc/plugins/websetup.mdwn @@ -1,19 +1,26 @@ [[!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, -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. +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. + +Plugins that should not be enabled/disabled via the web interface can be 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 setip +changes take effect.