Changes between Version 4 and Version 5 of DownloadsPlugin


Ignore:
Timestamp:
Jul 30, 2007 5:25:59 PM (7 years ago)
Author:
Blackhex
Comment:

Installation notes and features description.

Legend:

Unmodified
Added
Removed
Modified
  • DownloadsPlugin

    v4 v5  
    33== Description == 
    44 
    5 This plugin will provide downloads section which would contain release files. 
    6 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. 
    7  
    8 Currently this plugin is NOT functional (in early stage of development)!!! 
     5This 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. 
    96 
    107== Bugs/Feature Requests ==  
     
    1613[http://trac-hacks.org/newticket?component=DownloadsPlugin&owner=Blackhex new ticket] but read BugReporting page first, please. 
    1714 
    18  
    1915== Download == 
    2016 
     
    2521You can check out DownloadsPlugin from [http://trac-hacks.org/svn/downloadsplugin here] using Subversion, or [source:downloadsplugin browse the source] with Trac. 
    2622 
    27 == Example == 
     23== Dependencies == 
    2824 
    29 Not avaiable yet. 
     25DownloadsPlugin depends on WebAdminPlugin since many configuration options are avaiable only on apropriate WebAdminPlugin's pages. Support for TagsPlugin is planned too. 
     26 
     27== Installation == 
     28 
     29After installing plugin's egg you can set up few configuration variables in {{{trac.ini}}}. Their default values are displayed bellow:  
     30 
     31{{{ 
     32[downloads] 
     33 
     34title = Downloads 
     35path = /var/lib/trac/downloads 
     36ext = zip gz bz2 rar 
     37visible_fields = id file description size time count author tags component version architecture platform type # Currently not implemented. 
     38}}} 
     39 
     40Variable {{{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. 
     41 
     42If you run Trac in environment which needs to enable plugins explicitly put in trac.ini these lines:  
     43 
     44{{{ 
     45[components] 
     46tracdownloads.api.DownloadsApi = enabled 
     47tracdownloads.admin.DownloadsWebAdmin = enabled 
     48tracdownloads.core.DownloadsCore = enabled 
     49tracdownloads.init.DownloadsInit = enabled 
     50tracdownloads.timeline.DownloadsTimeline = enabled 
     51tracdownloads.wiki.DownloadsWiki = enabled 
     52}}} 
     53 
     54The next step is to upgrade your environment:  
     55 
     56{{{ 
     57# trac-admin <path_to_environment> upgrade 
     58}}} 
     59 
     60== Permissions == 
     61 
     62DownloadsPlugin defines two permissions {{{DOWNLOADS_VIEW}}} for normal users and {{{DOWNLOADS_ADMIN}}} for people who uploads and administrates downloads. 
     63 
     64You can grant them using these commands: 
     65 
     66{{{ 
     67# trac-admin <path_to_environment> permission add <user> DOWNLOADS_VIEW 
     68# trac-admin <path_to_environment> permission add <user> DOWNLOADS_ADMIN 
     69}}} 
     70 
     71== Macros == 
     72 
     73There is only macro for downloads referencing on wiki pages: 
     74 
     75{{{ 
     76[download:<download_id> <text>] 
     77}}} 
    3078 
    3179== Recent Changes ==