Changes between Version 1 and Version 2 of AttachFilterPlugin

Timestamp:

May 16, 2011, 4:02:41 PM (13 years ago)

Author:

anonymous

Comment:

Initial documentation

AttachFilterPlugin

@@ -24 +24 @@
 You can check out AttachFilterPlugin from [http://trac-hacks.org/svn/attachfilterplugin here] using Subversion, or [source:attachfilterplugin browse the source] with Trac.
 
-== Example ==
+== Documentation ==
 
-TBD
+In `trac.ini`, add a new section `[attachment_filter]`, where:
+ * keys match the mime file type to exclude
+ * values gives a brief description that is shown to the user to explain why the file is rejected
+
+=== Example ===
+
+{{{
+#!ini
+[attachment_filter]
+application/vnd.ms-excel = Microsoft Excel documents should be attached as PDF files
+application/vnd.ms-powerpoint = Microsoft PowerPoint documents should be attached as PDF files
+application/msword = Microsoft Word documents should be attached as PDF files
+image/bmp = Microsoft bitmap images should be attached as PNG images
+}}}
+
+Yep, M$ is evil :-)
+
+=== MIME type ===
+
+To obtain the exact MIME type string:
+ 1. set up your Trac installation to show/dump INFO log message,
+ 1. attach a file of the (un)desired type
+ 1. look for the plugin trace that shows the file name and the MIME type:
+{{{
+grep Filename .../log/trac.log
+}}}
+{{{
+2011-05-16 15:49:26,299 Trac[filter] INFO: Filename stuff.doc, filetype application/msword
+}}}
+ 1. add this new MIME type to the `[attachment_filter]` section
+ 1. restart your Trac engine
 
 == Recent Changes ==