Changes between Version 6 and Version 7 of DownloadsPlugin


Ignore:
Timestamp:
May 6, 2009, 5:57:53 PM (6 years ago)
Author:
Blackhex
Comment:

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

Legend:

Unmodified
Added
Removed
Modified
  • DownloadsPlugin

    v6 v7  
    77== Bugs/Feature Requests ==
    88
    9 Existing bugs and feature requests for DownloadsPlugin are
     9Existing bugs and feature requests for !DownloadsPlugin are
    1010[report:9?COMPONENT=DownloadsPlugin here].
    1111
     
    1919== Source ==
    2020
    21 You can check out DownloadsPlugin from [http://trac-hacks.org/svn/downloadsplugin here] using Subversion, or [source:downloadsplugin browse the source] with Trac.
     21You can [http://trac-hacks.org/svn/downloadsplugin check out] !DownloadsPlugin using Subversion, or [source:downloadsplugin browse the source] with Trac.
    2222
    2323== Dependencies ==
    2424
    2525DownloadsPlugin 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.
     26
     27== Plugin Versions ==
     28
     29As 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:
     30
     31|| Plugin Branch || Trac Branch         || Plugin Version ||
     32|| 0.10          || 0.10-stable         || 0.1            ||
     33|| 0.11          || 0.11-stable         || 0.2            ||
     34|| 0.12          || trunk, 0.11-stable* || 0.3            ||
     35
     36Main 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.
     37
     38''* 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.''
    2639
    2740== Installation ==
     
    3447title = Downloads
    3548path = /var/lib/trac/downloads
    36 ext = zip gz bz2 rar
     49ext = zip gz bz2 rar # For 0.10 and 0.11 branch.
     50ext = zip,gz,bz2,rar # For 0.12 branch.
    3751visible_fields = id file description size time count author tags component version \
    38   architecture platform type # Currently not implemented.
     52  architecture platform type # For 0.10 and 0.11 branch.
     53visible_fields = id,file,description,size,time,count,author,tags,component,version, \
     54  architecture,platform,type # For 0.12 branch.
    3955unique_filename = False
     56consoleadmin_user = anonymous # 0.12 branch only.
    4057}}}
    4158
    42 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.
     59Variable {{{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.
     60
     61'''Note:''' Don't miss that {{{ext}}} and {{{visible_fields}}} options has changed to comma separated lists in 0.12 branch of the plugin.
    4362
    4463If you run Trac in environment which needs to enable plugins explicitly put in trac.ini these lines: