Changes between Version 7 and Version 8 of DownloadsPlugin

Timestamp:

May 6, 2009, 4:59:59 PM (15 years ago)

Author:

Radek Bartoň

Comment:

Finish of 0.12 branch documentation update.

DownloadsPlugin

@@ -3 +3 @@
 == Description ==
 
-This plugin provides downloads section which may contain release or other files. It is administrable via WebAdminPlugin and shows information about uploaded files such as description, component, version, size, architecture and type which is download related to. It collects information about number of downloads too.
+This plugin provides downloads section which may contain release or other files. It is administrable via WebAdminPlugin and there is inteface to {{{trac-admin}} tool that may help during automatic server maintanance. Dowloads section of the Trac shows table with information about uploaded files such as description, component, version, size, architecture, type and optionally assigned tags which is download related to. It also collects information about number of downloads which can be displayed on wiki page together with direct links to specified download. 
 
 == Bugs/Feature Requests == 
@@ -23 +23 @@
 == 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.
+!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 ==
@@ -54 +54 @@
   architecture,platform,type # For 0.12 branch.
 unique_filename = False
-consoleadmin_user = anonymous # 0.12 branch only.
+consoleadmin_user = anonymous # Branch 0.12 only.
 }}}
 
@@ -61 +61 @@
 '''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: 
+If you run Trac in environment which needs to enable plugins explicitly put in {{{trac.ini}}} these lines: 
 
 {{{
 [components]
 tracdownloads.api.DownloadsApi = enabled
-tracdownloads.admin.DownloadsWebAdmin = 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.
 }}}
+
+In 0.12 branch, the {{{DownloadsCore}}} component was splited into the {{{DownloadsDownloads}}} component, which handles Downloads section of Trac, and the {{{DownloadsCore}}} component that serves file download requests and other core features. This means that you can disable the {{{DownloadsDownloads}}} component to hide Downloads section from users. {{{admin}}} module was renamed to {{{consoleadmin}}}.
 
 The next step is to upgrade your environment: 
@@ -81 +87 @@
 == Permissions ==
 
-DownloadsPlugin defines two permissions: {{{DOWNLOADS_VIEW}}} for normal users and {{{DOWNLOADS_ADMIN}}} for people who uploads and administrates downloads.
+!DownloadsPlugin defines three permissions: {{{DOWNLOADS_VIEW}}} for normal users and {{{DOWNLOADS_ADD}}} and {{{DOWNLOADS_ADMIN}}} for people who uploads and administrates downloads. {{{DOWNLOADS_ADD}}} permission is implemented since 0.12 branch and allows user to upload downloads without access to WebAdmin interface.
 
 You can grant them using these commands:
@@ -87 +93 @@
 {{{
 # trac-admin <path_to_environment> permission add <user> DOWNLOADS_VIEW
+# trac-admin <path_to_environment> permission add <user> DOWNLOADS_ADD # Branch 0.12 only.
 # trac-admin <path_to_environment> permission add <user> DOWNLOADS_ADMIN
 }}}
@@ -92 +99 @@
 == Macros ==
 
-There is only macro with two possible evocations for downloads referencing on wiki pages:
+There are few wiki macros available:
 
 {{{
@@ -98 +105 @@
 [download:<download_filename> <text>]
 }}}
+
+Displays link to download identified by ID {{{<download_id>}}} or filename {{{<download_filename>}}} with text {{{<text>}}}.
+
+{{{
+[[DownloadsCount(1)]]
+[[DownloadsCount(1, 2, 3)]]
+[[DownloadsCount(foo.zip)]]
+[[DownloadsCount(1, foo.zip, bar.rar, 3)]]
+[[DownloadsCount()]]
+[[DownloadsCount(0)]]
+}}}
+
+Displays sum of number of downloads for downloads identified by comma separated list of IDs or filenames. If there is empty list or any zero (last two examples), sum of all number of downloads for all downloads is returned. Non-existing downloads silently counts as zero. Works with branch 0.12 only.
+
+{{{
+[[ListDownloads()]]
+}}}
+
+Displays same table that is displayed in Downloads section of the Trac on a wiki page. Works with branch 0.12 only.
+
+== Inteface to {{{trac-admin}}} ==
+
+There is ability to list, insert or delete downloads from server's console/script with following commands:
+
+{{{
+# trac-admin <path_to_environment> download list
+# trac-admin <path_to_environment> download add <path_to_file> description=<description> \
+    author=<author> tags="<tag1> <tag2> ..." component=<component> version=<version> \
+    architecture=<architecture> platform=<platform> type=<type>
+# trac-admin <path_to_environment> download remove <download_filename>
+# trac-admin <path_to_environment> download remove <download_id>
+}}}
+
+All download attributes of {{{download add}}} command are optional only the file must be specified. {{{console_admin}}} {{{trac.ini}}} option must be setted to any user who has permission to do apropriate action.
+
+== Notes ==
+
+ * Branch 0.10 of the plugin is considered as deprecated and not developed anymore.
+ * Branch 0.11 is bug-fix only unless requested otherwise.
 
 == Recent Changes ==