summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-08-25 19:52:34 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-08-25 19:52:34 -0400
commit78e34fbdc255fd3f71f5b43ce1acd1fa0678e1ce (patch)
tree0988142ac8168c6b317a7cdc8262c92467579cc0 /doc
parentc013f0a8bc7f5969e21db06228d3618a9c7e4960 (diff)
filecheck: New plugin factoring out the PageSpec additions that were originally part of the attachment plugin.
Diffstat (limited to 'doc')
-rw-r--r--doc/ikiwiki/pagespec/attachment.mdwn2
-rw-r--r--doc/ikiwiki/pagespec/attachment/discussion.mdwn2
-rw-r--r--doc/plugins/attachment.mdwn13
-rw-r--r--doc/plugins/filecheck.mdwn16
4 files changed, 22 insertions, 11 deletions
diff --git a/doc/ikiwiki/pagespec/attachment.mdwn b/doc/ikiwiki/pagespec/attachment.mdwn
index de7c7417f..6b86c510b 100644
--- a/doc/ikiwiki/pagespec/attachment.mdwn
+++ b/doc/ikiwiki/pagespec/attachment.mdwn
@@ -13,7 +13,7 @@ check all attachments for virii, something like this could be used:
virusfree() and ((user(joey) and podcast/*.mp3 and mimetype(audio/mpeg) and maxsize(15mb)) or (!ispage() and maxsize(50kb)))
-The regular [[ikiwiki/PageSpec]] syntax is expanded with thw following
+The regular [[ikiwiki/PageSpec]] syntax is expanded with the following
additional tests:
* maxsize(size)
diff --git a/doc/ikiwiki/pagespec/attachment/discussion.mdwn b/doc/ikiwiki/pagespec/attachment/discussion.mdwn
index ab9cb0653..373242b3f 100644
--- a/doc/ikiwiki/pagespec/attachment/discussion.mdwn
+++ b/doc/ikiwiki/pagespec/attachment/discussion.mdwn
@@ -11,3 +11,5 @@ I am interested for [[todo/mbox]] --[[DavidBremner]]
>> I don't think `ip()` and `user()` necessarily make sense for a mail box
>> that is already on the disk, so no, I don't think I'll miss
>> them. --[[DavidBremner]]
+
+>>> Done, [[plugins/filecheck]] --[[Joey]]
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 -".