Changes between Version 23 and Version 24 of DownloadsPlugin


Ignore:
Timestamp:
Nov 15, 2014, 9:03:45 AM (7 years ago)
Author:
Ryan J Ollos
Comment:

Tidy up page.

Legend:

Unmodified
Added
Removed
Modified
  • DownloadsPlugin

    v23 v24  
    11[[PageOutline(2-5, Contents, pullout)]]
    22
    3 = !DownloadPlugin =
     3= !DownloadPlugin
    44
    55Adds a downloads section to the Trac system.
    66
    7 == Description ==
     7== Description
    88
    99This plugin provides downloads section which may contain releases or other files. It is administrated via WebAdminPlugin and there is an interface to the {{{trac-admin}}} tool that may help during automatic server maintenance. The Downloads section of Trac displays a table with information about the uploaded files such as description, component, version, size, architecture, type and optionally assigned tags which the download is related to. It also collects information about number of downloads which can be displayed on wiki page together with direct links to the specified download.
    1010
    11 == Bugs/Feature Requests ==
     11== Bugs/Feature Requests
    1212
    1313Existing bugs and feature requests for !DownloadsPlugin are
     
    1515
    1616If you have any issues, create a
    17 [http://trac-hacks.org/newticket?component=DownloadsPlugin&owner=rjollos new ticket] but read BugReporting page first, please.
     17[http://trac-hacks.org/newticket?component=DownloadsPlugin new ticket] but read BugReporting page first, please.
    1818
    19 == Download ==
     19== Download
    2020
    2121Download the zipped source from [download:downloadsplugin here].
    2222
    23 == Source ==
     23== Source
    2424
    2525You can [http://trac-hacks.org/svn/downloadsplugin check out] !DownloadsPlugin using Subversion, or [source:downloadsplugin browse the source] with Trac.
    2626
    27 == Dependencies ==
     27== Dependencies
    2828
    2929!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.
    3030
    31 == Installation ==
     31== Installation
    3232
    3333After installing plugin's egg you can set up few configuration variables in {{{trac.ini}}}. Their default values are displayed bellow:
    3434
    35 {{{
    36 #!ini
     35{{{#!ini
    3736[downloads]
    3837
     
    5655If you run Trac in environment which needs to enable plugins explicitly put in {{{trac.ini}}} these lines:
    5756
    58 {{{
    59 #!ini
     57{{{#!ini
    6058[components]
    6159tracdownloads.api.DownloadsApi = enabled
     
    7573The next step is to upgrade your environment:
    7674
    77 {{{
    78 #!sh
     75{{{#!sh
    7976# trac-admin <path_to_environment> upgrade
    8077}}}
    8178
    8279'''Note:''' Some environments might not handle download of large files gracefully.  Notably the fcgi wrapper may timeout.  A possible work around, that also adds HTTP "Range:" header support is telling Trac to use "X-Sendfile" (which may require configuration of your HTTP server as well):
    83 {{{
    84 #!ini
     80{{{#!ini
    8581[trac]
    8682use_xsendfile = True
    8783}}}
    8884
    89 == Permissions ==
     85== Permissions
    9086
    9187!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.
     
    9389You can grant them using these commands:
    9490
    95 {{{
    96 #!sh
     91{{{#!sh
    9792# trac-admin <path_to_environment> permission add <user> DOWNLOADS_VIEW
    9893# trac-admin <path_to_environment> permission add <user> DOWNLOADS_ADD # Branch 0.12 only.
     
    10095}}}
    10196
    102 == Macros ==
     97== Macros
    10398
    10499There are few wiki macros available:
     
    128123Displays same table that is displayed in Downloads section of the Trac on a wiki page. Works with branch 0.12 only.
    129124
    130 == Inteface to {{{trac-admin}}} ==
     125== Inteface to `trac-admin`
    131126
    132127There is ability to list, insert or delete downloads from server's console/script with following commands:
    133128
    134 {{{
    135 #!sh
     129{{{#!sh
    136130# trac-admin <path_to_environment> download list
    137131# trac-admin <path_to_environment> download add <path_to_file> description=<description> \
     
    144138All 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.
    145139
    146 == Recent Changes ==
     140== Recent Changes
    147141
    148142[[ChangeLog(downloadsplugin, 3)]]
     
    151145
    152146'''Author:''' [wiki:Blackhex] [[BR]]
    153 '''Maintainer:''' [wiki:rjollos] [[BR]]
     147'''Maintainer:''' [[Maintainer]] [[BR]]
    154148'''Contributors:'''