summaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-08-01 15:45:57 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-08-01 16:45:04 -0400
commitbb394fdae8ba488f1031d6f053f1544c689a3628 (patch)
tree760791186780419e0b0428435b00cdd25a481609 /doc/plugins
parent4324746bea58784ad82a2de7832cafad2a25ed63 (diff)
admin prefs move to setup file, stage 1
The locked pages configuration is moving to a locked_pages option in the setup file, and the allowed attachments configuration to allowed_attachments. The admin prefs page can still be used for these, but that's depreacted and will only be shown if there's currently a value.
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/attachment.mdwn6
-rw-r--r--doc/plugins/write.mdwn3
2 files changed, 5 insertions, 4 deletions
diff --git a/doc/plugins/attachment.mdwn b/doc/plugins/attachment.mdwn
index 524a233fa..b04a04ad2 100644
--- a/doc/plugins/attachment.mdwn
+++ b/doc/plugins/attachment.mdwn
@@ -20,9 +20,9 @@ Bear in mind that if you let anyone upload a particular kind of file
contains html as a web page; including running any malicious javascript
embedded in that page.
-If you enable this plugin, be sure to lock that down, by entering an
-[[enhanced_PageSpec|ikiwiki/pagespec/attachment]] in the "Allowed
-Attachments" field of the wiki admin's preferences page.
+If you enable this plugin, be sure to lock it down, via the
+`allowed_attachments` setup file option. This is a special
+[[enhanced_PageSpec|ikiwiki/pagespec/attachment]].
This plugin will use the [[!cpan File::MimeInfo::Magic]] perl module, if
available, for mimetype checking.
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 77210d35c..255be4207 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -396,11 +396,12 @@ describing the option. For example:
rebuild => 0,
},
-* `type` can be "boolean", "string", "integer", "pagespec", or "internal"
+* `type` can be "boolean", "string", "integer", or "internal"
(used for values that are not user-visible). The type is the type of
the leaf values; the `%config` option may be an array or hash of these.
* `example` can be set to an example value.
* `description` is a short description of the option.
+* `description_html` is an optional short description, that can contain html
* `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.