Changes between Version 6 and Version 7 of DownloadsPlugin

Timestamp:

May 6, 2009, 3:57:53 PM (15 years ago)

Author:

Radek Bartoň

Comment:

Partial update of documentation for lastest (0.12) branch of the plugin.

DownloadsPlugin

@@ -7 +7 @@
 == Bugs/Feature Requests == 
 
-Existing bugs and feature requests for DownloadsPlugin are 
+Existing bugs and feature requests for !DownloadsPlugin are 
 [report:9?COMPONENT=DownloadsPlugin here].
 
@@ -19 +19 @@
 == Source ==
 
-You can check out DownloadsPlugin from [http://trac-hacks.org/svn/downloadsplugin here] using Subversion, or [source:downloadsplugin browse the source] with Trac.
+You can [http://trac-hacks.org/svn/downloadsplugin check out] !DownloadsPlugin using Subversion, or [source:downloadsplugin browse the source] with Trac.
 
 == Dependencies ==
 
 DownloadsPlugin for Trac 0.10 depends on WebAdminPlugin since many configuration options are avaiable only on apropriate WebAdminPlugin's pages. On Trac 0.11 this is supported by Trac itself. Optionally DownloadsPlugin uses TagsPlugin for tags support.
+
+== Plugin Versions ==
+
+As many other plugins in this site even this plugin names its branches according to Trac versions. Here is a simple table explaining this convention for !DownloadsPlugin:
+
+|| Plugin Branch || Trac Branch         || Plugin Version ||
+|| 0.10          || 0.10-stable         || 0.1            ||
+|| 0.11          || 0.11-stable         || 0.2            ||
+|| 0.12          || trunk, 0.11-stable* || 0.3            ||
+
+Main difference between 0.1 and 0.2 version is that 0.2 uses Genshi templates and 0.1 !ClearSilver ones. 0.12 branch is the one where new features are introduced so you may experience some regressions with this branch.
+
+''* So far 0.12 branch of the plugin works with Trac 0.11 except of interface to {{{trac-admin}}} command. If you want to use this full-featured but testing branch, just disable {{{DownloadsConsoleAdmin}}} component.''
 
 == Installation ==
@@ -34 +47 @@
 title = Downloads
 path = /var/lib/trac/downloads
-ext = zip gz bz2 rar
+ext = zip gz bz2 rar # For 0.10 and 0.11 branch.
+ext = zip,gz,bz2,rar # For 0.12 branch.
 visible_fields = id file description size time count author tags component version \
-  architecture platform type # Currently not implemented.
+  architecture platform type # For 0.10 and 0.11 branch.
+visible_fields = id,file,description,size,time,count,author,tags,component,version, \
+  architecture,platform,type # For 0.12 branch.
 unique_filename = False
+consoleadmin_user = anonymous # 0.12 branch only.
 }}}
 
-Variable {{{title}}} sets text of main navigation bar button. {{{path}}} is location where uploaded downloads are stored. It has to be accesible for writing to web server. Setting {{{ext}}} variable restricts allowed extensions of uploaded files. If {{{unique_filename}}} is enabled, plugin checks if file name of download file is not already occupied by any other download file. Finally, {{{visibled_field}}} variable controls appearance of downloads table columns in Downloads section.
+Variable {{{title}}} sets text of main navigation bar button. {{{path}}} is location where uploaded downloads are stored. It has to be accessible for writing to web server. Setting {{{ext}}} variable restricts allowed extensions of uploaded files. If {{{unique_filename}}} is enabled, plugin checks if file name of download file is not already occupied by any other download file. {{{visibled_field}}} variable controls appearance of downloads table columns in Downloads section. Finally, {{{consoleadmin_user}}} option serves for permission checks when listing, adding or removing downlads using {{{trac-admin}}}. This option is available only in 0.12 branch.
+
+'''Note:''' Don't miss that {{{ext}}} and {{{visible_fields}}} options has changed to comma separated lists in 0.12 branch of the plugin.
 
 If you run Trac in environment which needs to enable plugins explicitly put in trac.ini these lines: