urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

some doc updates for websetup 

warning about old style setup files
master
Joey Hess 2008-08-05 20:20:24 -04:00
parent bf8558f346
commit 1d5ba6cf51
2 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/plugins/websetup.mdwn
View File

@ -5,6 +5,12 @@ 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 rather than editing the setup file directly. A "Wiki Setup" button is added
to the admins' preferences page. to the admins' preferences page.
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.
Most settings can be modified using the web interface. Plugins 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 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, enough to be manipulated over the web; these are still shown, by default,
@ -14,3 +20,7 @@ configured via the web.
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. 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.

2
doc/todo/online_configuration.mdwn
View File

@ -25,4 +25,4 @@ writing to a subsidiary setup file. However, this would mean that any
comments in the file would be lost, and that it couldn't be used if the comments in the file would be lost, and that it couldn't be used if the
setup file had weird stuff (perl code, etc). setup file had weird stuff (perl code, etc).
[[!tag wishlist]] [[!tag wishlist done]]