3.20161229.1~bpo8+1

[git.ikiwiki.info.git] / doc / ikiwiki / pagespec / attachment.mdwn

diff --git a/doc/ikiwiki/pagespec/attachment.mdwn b/doc/ikiwiki/pagespec/attachment.mdwn
index 40de917658f69e47320e84bfd57e61e6a42df711..868fb2310d250da5e493a179b3e47fac263628e3 100644 (file)
--- a/doc/ikiwiki/pagespec/attachment.mdwn
+++ b/doc/ikiwiki/pagespec/attachment.mdwn
@@ -4,49 +4,35 @@
      else="This wiki has attachments **disabled**."]]
 
 If attachments are enabled, the wiki admin can control what types of
      else="This wiki has attachments **disabled**."]]
 
 If attachments are enabled, the wiki admin can control what types of

-attachments will be accepted, by entering a [[ikiwiki/PageSpec]] in the
-"Allowed Attachments" field of their preferences page.
+attachments will be accepted, via the `allowed_attachments`
+configuration setting.

 
 

-For example, to limit arbitrary files to 50 kilobytes, but allow
-larger mp3 files to be uploaded by joey, a something like this could be
+For example, to limit most users to uploading small images, and nothing else,
+while allowing larger mp3 files to be uploaded by joey into a specific
+directory, and check all attachments for viruses, something like this could be

 used:
   
 used:
   

-       (user(joey) and *.mp3 and mimetype(audio/mpeg) and maxsize(15mb)) or (!ispage() and maxsize(50kb))
+       virusfree() and ((user(joey) and podcast/*.mp3 and mimetype(audio/mpeg) and maxsize(15mb)) or ((mimetype(image/jpeg) or mimetype(image/png)) 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:
 
 additional tests:
 

-* maxsize(size)
-
-  Tests whether the attachment is no larger than the specified size.
-  The size defaults to being in bytes, but "kb", "mb", "gb" etc can be
-  used to specify the units.
+* "`maxsize(size)`" - tests whether the attachment is no larger than the
+  specified size. The size defaults to being in bytes, but "kb", "mb", "gb"
+  etc can be used to specify the units.

   
   

-* minsize(size)
-
-  Tests whether the attachment is no smaller than the specified size.
+* "`minsize(size)`" - tests whether the attachment is no smaller than the
+  specified size.

 
 

-* ispage()
-
-  Tests whether the attachment will be treated by ikiwiki as a wiki page.
-  (Ie, if it has an extension of ".mdwn", or of any other enabled page
-  format).
+* "`ispage()`" - tests whether the attachment will be treated by ikiwiki as a
+  wiki page. (Ie, if it has an extension of ".mdwn", or of any other enabled
+  page format).

 
   So, if you don't want to allow wiki pages to be uploaded as attachments,
   use `!ispage()` ; if you only want to allow wiki pages to be uploaded
   as attachments, use `ispage()`.
 
 
   So, if you don't want to allow wiki pages to be uploaded as attachments,
   use `!ispage()` ; if you only want to allow wiki pages to be uploaded
   as attachments, use `ispage()`.
 

-* user(username)
-
-  Tests whether the attachment is being uploaded by a user with the
-  specified username. If openid is enabled, an openid can also be put here.
-
-* ip(address)
-
-  Tests whether the attacment is being uploaded from the specified IP
-  address.
-
-* mimetype(foo/bar)
+* "`mimetype(foo/bar)`" - checks the MIME type of the attachment. You can
+  include a glob in the type, for example `mimetype(image/*)`.

 
 

-  This checks the MIME type of the attachment. You can include a glob
-  in the type, for example `mimetype(image/*)`.
+* "`virusfree()`" - checks the attachment with an antiviral program.