Changes between Version 35 and Version 36 of DownloadsPlugin

Timestamp:

Nov 28, 2016, 8:54:57 AM (7 years ago)

Author:

Ryan J Ollos

Comment:

Remove obsolete info about old versions and update config options.

DownloadsPlugin

@@ -29 +29 @@
 == Installation
 
-!DownloadsPlugin for Trac 0.10 depends on WebAdminPlugin, since many of the configuration options are available only on appropriate WebAdminPlugin's pages. On Trac 0.11 this is supported by Trac itself. Optionally !DownloadsPlugin uses TagsPlugin for tags support.
-
 General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
 
 == Configuration
 
-After installing plugin's egg you can set up few configuration variables in the `trac.ini` file. Their default values are: 
+After installing the plugin you can set up configuration variables in `trac.ini`. Their default values are: 
 
 {{{#!ini
 [downloads]
-path = /var/lib/trac/downloads
-ext = zip gz bz2 rar # For 0.10 and 0.11 branch.
-ext = zip,gz,bz2,rar # For 0.12 branch.
-additional_tags = author,component,version,architecture,platform,type # 0.12 branch only.
-visible_fields = id file description size time count author tags component version \
-  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.
+additional_tags = author,component,version,architecture,platform,\
+                  type # If TagsPlugin is installed
+architecture_sort = name
+architecture_sort_direction = asc
+consoleadmin_user = anonymous
+download_sort = time
+download_sort_direction = desc
+ext = zip,gz,bz2,rar
+max_size = 268697600
+path = ../downloads
+platform_sort = name
+platform_sort_direction = asc
+type_sort = name
+type_sort_direction = asc
 unique_filename = False
-consoleadmin_user = anonymous # Branch 0.12 only.
+visible_fields = id,file,description,size,time,count,author,tags,\
+                 component,version,architecture,platform,type
 }}}
 
 Option values:
- * The {{{path}}} is the location where the 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, then the plugin checks if the file name of the download file is not already occupied by any other download file. 
- * {{{visible_fields}}} variable controls appearance of downloads table columns in Downloads section.
- * {{{consoleadmin_user}}} option serves for permission checks when listing, adding or removing downloads using {{{trac-admin}}}. This option is available only in 0.12 branch. 
- * Another option available only in 0.12 branch is {{{additional_tags}}} that configures from which fields the download tags should be also generated.
+* The `path` is the location where the 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, then the plugin checks if the file name of the download file is not already occupied by any other download file. 
+* `visible_fields` variable controls appearance of downloads table columns in Downloads section.
+* `consoleadmin_user` option serves for permission checks when listing, adding or removing downloads using `trac-admin`.
+* `additional_tags` configures from which fields the download tags should be also generated.
 
-'''Note:''' {{{ext}}} and {{{visible_fields}}} options have changed to comma separated lists in 0.12 branch of the plugin.
-
-If you run Trac in an environment which needs to enable plugins explicitly, add the following lines in the `trac.ini` file: 
+Enable the plugin using the following in trac.ini:
 
 {{{#!ini
 [components]
-tracdownloads.api.DownloadsApi = enabled
-tracdownloads.core.DownloadsCore = enabled
-tracdownloads.init.DownloadsInit = enabled
-tracdownloads.timeline.DownloadsTimeline = enabled
-tracdownloads.wiki.DownloadsWiki = enabled
-tracdownloads.admin.DownloadsWebAdmin = enabled # Branch 0.10 and 0.11.
-tracdownloads.webadmin.DownloadsWebAdmin = enabled # Branch 0.12 only.
-tracdownloads.consoleadmin.DownloadsConsoleAdmin = enabled # Branch 0.12 only.
-tracdownloads.core.DownloadsDownloads = enabled # Branch 0.12 only.
-tracdownloads.tags.DownloadsTags = enabled # With TagsPlugin installed.
+tracdownloads.* = enabled
 }}}
 
@@ -94 +88 @@
 
 This plugin defines the following permissions: 
- 1. {{{DOWNLOADS_VIEW}}} for normal users.
- 1. {{{DOWNLOADS_ADD}}} and {{{DOWNLOADS_ADMIN}}} for people who upload and administrate downloads.
- 1. {{{DOWNLOADS_ADD}}} permission is implemented since the 0.12 branch and allows a user to upload downloads without access to the WebAdmin interface.
+1. {{{DOWNLOADS_VIEW}}} for normal users.
+1. {{{DOWNLOADS_ADD}}} and {{{DOWNLOADS_ADMIN}}} for people who upload and administer downloads.
+1. {{{DOWNLOADS_ADD}}} permission allows a user to upload downloads without access to the WebAdmin interface.
 
 You can grant these permissions using these commands: