Changes between Version 24 and Version 25 of DownloadsPlugin


Ignore:
Timestamp:
Mar 11, 2015, 10:56:58 AM (9 years ago)
Author:
figaro
Comment:

Tagged with license

Legend:

Unmodified
Added
Removed
Modified
  • DownloadsPlugin

    v24 v25  
    11[[PageOutline(2-5, Contents, pullout)]]
    22
    3 = !DownloadPlugin
    4 
    5 Adds a downloads section to the Trac system.
     3= !DownloadsPlugin adds a downloads section to Trac
    64
    75== Description
     
    3129== Installation
    3230
    33 After installing plugin's egg you can set up few configuration variables in {{{trac.ini}}}. Their default values are displayed bellow:
     31After installing plugin's egg you can set up few configuration variables in {{{trac.ini}}}. Their default values are:
    3432
    3533{{{#!ini
     
    5149Variable {{{title}}} sets text of main navigation bar button. {{{path}}} is location where 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, plugin checks if file name of download file is not already occupied by any other download file. {{{visible_fields}}} variable controls appearance of downloads table columns in Downloads section. Finally, {{{consoleadmin_user}}} option serves for permission checks when listing, adding or removing downlads 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 should be also generated download tags.
    5250
    53 '''Note:''' Don't miss that {{{ext}}} and {{{visible_fields}}} options has changed to comma separated lists in 0.12 branch of the plugin.
     51'''Note:''' {{{ext}}} and {{{visible_fields}}} options have changed to comma separated lists in 0.12 branch of the plugin.
    5452
    55 If you run Trac in environment which needs to enable plugins explicitly put in {{{trac.ini}}} these lines:
     53If you run Trac in an environment which needs to enable plugins explicitly, put in {{{trac.ini}}} these lines:
    5654
    5755{{{#!ini
     
    7169In 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}}}.
    7270
    73 The next step is to upgrade your environment:
     71The next step is to upgrade your Trac environment:
    7472
    7573{{{#!sh
     
    7775}}}
    7876
    79 '''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):
     77'''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". This may require configuration of your HTTP server as well:
    8078{{{#!ini
    8179[trac]
     
    142140[[ChangeLog(downloadsplugin, 3)]]
    143141
    144 == Author/Contributors ==
     142== Author/Contributors
    145143
    146144'''Author:''' [wiki:Blackhex] [[BR]]