Changes between Version 4 and Version 5 of DownloadsPlugin

Timestamp:

Jul 30, 2007, 3:25:59 PM (17 years ago)

Author:

Radek Bartoň

Comment:

Installation notes and features description.

DownloadsPlugin

@@ -3 +3 @@
 == Description ==
 
-This plugin will provide downloads section which would contain release files.
-It will be administrable via WebAdminPlugin and would show information about uploaded files such as description, component and version which is related to, size, architecture, type, etc ... It will be collecting information about number of downloads too.
-
-Currently this plugin is NOT functional (in early stage of development)!!!
+This plugin provides downloads section which may contain release or other files. It is administrable via WebAdminPlugin and shows informations 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.
 
 == Bugs/Feature Requests == 
@@ -16 +13 @@
 [http://trac-hacks.org/newticket?component=DownloadsPlugin&owner=Blackhex new ticket] but read BugReporting page first, please.
 
-
 == Download ==
 
@@ -25 +21 @@
 You can check out DownloadsPlugin from [http://trac-hacks.org/svn/downloadsplugin here] using Subversion, or [source:downloadsplugin browse the source] with Trac.
 
-== Example ==
+== Dependencies ==
 
-Not avaiable yet.
+DownloadsPlugin depends on WebAdminPlugin since many configuration options are avaiable only on apropriate WebAdminPlugin's pages. Support for TagsPlugin is planned too.
+
+== Installation ==
+
+After installing plugin's egg you can set up few configuration variables in {{{trac.ini}}}. Their default values are displayed bellow: 
+
+{{{
+[downloads]
+
+title = Downloads
+path = /var/lib/trac/downloads
+ext = zip gz bz2 rar
+visible_fields = id file description size time count author tags component version architecture platform type # Currently not implemented.
+}}}
+
+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. Finally {{{visibled_field}}} variable controls appearance of downloads table columns in Downloads sections.
+
+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
+}}}
+
+The next step is to upgrade your environment: 
+
+{{{
+# trac-admin <path_to_environment> upgrade
+}}}
+
+== Permissions ==
+
+DownloadsPlugin defines two permissions {{{DOWNLOADS_VIEW}}} for normal users and {{{DOWNLOADS_ADMIN}}} for people who uploads and administrates downloads.
+
+You can grant them using these commands:
+
+{{{
+# trac-admin <path_to_environment> permission add <user> DOWNLOADS_VIEW
+# trac-admin <path_to_environment> permission add <user> DOWNLOADS_ADMIN
+}}}
+
+== Macros ==
+
+There is only macro for downloads referencing on wiki pages:
+
+{{{
+[download:<download_id> <text>]
+}}}
 
 == Recent Changes ==