diff options
Diffstat (limited to 'doc/plugins')
| -rw-r--r-- | doc/plugins/attachment.mdwn | 13 | ||||
| -rw-r--r-- | doc/plugins/filecheck.mdwn | 16 |
2 files changed, 19 insertions, 10 deletions
diff --git a/doc/plugins/attachment.mdwn b/doc/plugins/attachment.mdwn index b04a04ad2..2aa8490ed 100644 --- a/doc/plugins/attachment.mdwn +++ b/doc/plugins/attachment.mdwn @@ -22,13 +22,6 @@ Bear in mind that if you let anyone upload a particular kind of file 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. - -The `virusfree` [[PageSpec|ikiwiki/pagespec/attachment]] requires that -ikiwiki be configured with a virus scanner program via the `virus_checker` -option in the setup file. If using `clamav`, with `clamd`, set it to -"clamdscan -". Or to use clamav without the `clamd` daemon, you -could set it to "clamscan -". +[[enhanced_PageSpec|ikiwiki/pagespec/attachment]] using tests provided by +the [[filecheck]] plugin. That plugin will be automatically enabled when +this plugin is enabled. diff --git a/doc/plugins/filecheck.mdwn b/doc/plugins/filecheck.mdwn new file mode 100644 index 000000000..f4563d58e --- /dev/null +++ b/doc/plugins/filecheck.mdwn @@ -0,0 +1,16 @@ +[[!template id=plugin name=filecheck core=0 author="[[Joey]]"]] +[[!tag type/useful]] + +This plugin enhances the regular [[ikiwiki/PageSpec]] syntax with +some additional tests, for things like file size, mime type, and virus +status. These tests are mostly useful for the [[attachment]] plugin, and +are documented [[here|ikiwiki/pagespec/attachment]]. + +This plugin will use the [[!cpan File::MimeInfo::Magic]] perl module, if +available, for mimetype checking. + +The `virusfree` [[PageSpec|ikiwiki/pagespec/attachment]] requires that +ikiwiki be configured with a virus scanner program via the `virus_checker` +option in the setup file. If using `clamav`, with `clamd`, set it to +"clamdscan -". Or to use clamav without the `clamd` daemon, you +could set it to "clamscan -". |