Changes between Version 42 and Version 43 of TracDownloaderPlugin


Ignore:
Timestamp:
Mar 22, 2015, 1:04:40 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with license

Legend:

Unmodified
Added
Removed
Modified

  • TracDownloaderPlugin

    v42 v43  
    1 = Trac Downloader plug-in =
    2 [[PageOutline]]
     1= Trac Downloader plug-in
    32
    4 == Description ==
     3== Description
    54
    65Project release downloader plugin for Trac system with optional questionnaire before download of file, Captcha antirobot check, stats module and easy to use administration in Trac WebAdmin plug-in.
    … …  
    1716 * [attachment:07_file_stats.png statistics of files (releases and categories has this too)]
    1817
    19 == Planned features and improvements ==
     18== Planned features and improvements
    2019
    2120 * rewrite all templates from !ClearSilver to Genshi
    … …  
    2625 * some aggregations of data filled in user defined questionnaire
    2726
    28 == Bugs/Feature Requests ==
     27== Bugs/Feature Requests
    2928
    3029Plug-in was tested on Python 2.3 - Trac 0.9.6 and Trac 0.10.4, '''first successful tests were made on Trac 0.11b1! ''' But be patient if there are still some bugs and report every problem you find.
    … …  
    3635[http://trac-hacks.org/newticket?component=TracDownloaderPlugin&owner=peca new ticket].
    3736
    38 == Download ==
     37[[TicketQuery(component=TracDownloaderPlugin,group=type,format=progress)]]
     38
     39== Download
    3940
    4041If you don't like Subversion you can download egg or full source here:
    … …  
    5051Download the zipped source for [download:tracdownloaderplugin/0.9 Trac 0.9], [download:tracdownloaderplugin/0.10 Trac 0.10], [download:tracdownloaderplugin/0.11 Trac 0.11] or [download:tracdownloaderplugin just everything].
    5152
    52 == Source ==
     53== Source
    5354
    5455You can check out TracDownloaderPlugin from [http://trac-hacks.org/svn/tracdownloaderplugin here] using Subversion, or [source:tracdownloaderplugin browse the source] with Trac.
    5556
    56 == Installation ==
     57== Installation
    5758
    58 '''EGG'''[[BR]]
    59 The easiest way to start using Downloader plug-in is to get downloaded python egg into plugin directory of project environment (egg is most probably python version independent, just rename it, but who knows, there's still source package...), after that you must turn both modules of Downloader on in WebAdmin/plugins (Downloader is dependent on WebAdmin plug-in). And finally there is need to get some permissions of Downloader to some users... In this case if you like to use !PyCaptcha, you must take care of installing it by yourself, !PyCaptcha is dependent on PIL so you must download it too.
     59'''Using Python egg'''
    6060
    61 '''SOURCE''' - installation with !PyCaptcha and Python Imaging Library (PIL) which are needed for Captcha to work[[BR]]
     61The easiest way to start using Downloader plug-in is to get downloaded python egg into plugin directory of project environment (egg is most probably python version independent, just rename it, there is still the source package), after that you must turn both modules of Downloader on in WebAdmin/plugins (Downloader is dependent on WebAdmin plug-in). And finally there is need to get some permissions of Downloader to some users. In this case if you like to use !PyCaptcha, you must take care of installing it by yourself, !PyCaptcha is dependent on PIL so you must download it too.
     62
     63'''Using source''' - installation with !PyCaptcha and Python Imaging Library (PIL) which are needed for Captcha to work:
    6264
    6365{{{
     66#!sh
    6467easy_install --find-links http://www.pythonware.com/products/pil/ Imaging
    6568easy_install PyCaptcha
    6669easy_install http://trac-hacks.org/svn/tracdownloaderplugin/0.10/
    67 
    6870}}}
    6971
     72'''Second and maybe better way''' is to download and unpack somewhere source zip package and then just run "setup.py install" (or on windows maybe better "python setup.py install") or you can just use easy_install commands written above. ~~Setup should take care of all dependences (!PyCaptcha and PIL but it could get some errors while dowloading them so if automatic dependency resolution doesn't work use code above) and prepare plugin to be turned on in !WebAdmin/plugins.~~ Setup just installs TracDownloaderPlugin. If you like to use Captcha tests you have to install PIL and !PyCaptcha manually either (note that PIL is in most ''Linux distributions'' package named '''python-imaging''' so you don't need to install it by easy install but you can use your package manager).
    7073
    71 '''Second and maybe better way''' is to download and unpack somewhere source zip package and then just run "setup.py install" (or on windows maybe better "python setup.py install") or you can just use easy_install commands written above. ~~Setup should take care of all dependences (!PyCaptcha and PIL but it could get some errors while dowloading them so if automatic dependency resolution doesn't work use code above) and prepare plugin to be turned on in !WebAdmin/plugins.~~ Setup just installs TracDownloaderPlugin. If you like to use Captcha tests you have to install PIL and !PyCaptcha manually either (note that PIL is in most ''Linux distributions'' package named '''python-imaging''' so you don't need to install it by easy install but you can use your package manager). Then you must enable both Downloader modules in !TracAdmin/Plugins (or enable Downoader components in your envronment's ini file - source bottom) and assign some permissions of downloader to someone and you can start trying Downloader plug-in...
     74Then you must enable both Downloader modules in !TracAdmin/Plugins (or enable Downoader components in your envronment's ini file - source bottom) and assign some permissions of downloader to someone and you can start trying Downloader plug-in:
     75
    7276{{{
     77#!ini
    7378[components]
    7479tracdownloader.admin.downloaderadminpage = enabled
    7580tracdownloader.web_ui.downloadermodule = enabled
    76 
    7781}}}
    7882
    7983After steps above and clicking to any part of Downloader you should be asked about location of directory to store uploaded files. When it is set up, you must Submit that form two times and there can occur exception "!DatabaseError: database schema has changed". If this exception is thrown, it's best to restart your http server.
    8084
    81 Downloader keeps using '''!ClearSilver''' as templating system so you have to have it installed (version for new templating system Genshe will be written soon). '''Version for Trac 0.11 wasn't too much tested so if you find errors, please write me a ticket as soon as possible.'''
     85Downloader keeps using '''!ClearSilver''' as templating system so you have to have it installed (version for new templating system Genshi will be written soon). '''Version for Trac 0.11 wasn't too much tested so if you find errors, please write me a ticket.'''
    8286
    8387'''If you had problems installing Downloader, please write me a ticket or write solution of your installation problems here.'''
    8488
    85 == Permissions ==
     89== Permissions
    8690
    87 '''Downloader plug-in defines three permissions:'''[[BR]]
     91Downloader plug-in defines the following permissions:
    8892
    89 '''DOWNLOADER_DOWNLOAD''' - lets user to download things from main part of plug-in, if you like to let all users download from donwloader, just get this permission to user anonymous.[[BR]]
    90 '''DOWNLOADER_STATS''' - lets user to browse part of statistics in the main module of Downloader (user will be able to see links to statistics in the right top corner of the page).[[BR]]
    91 '''DOWNLOADER_ADMIN''' - lets user to upload files, manage files, releases and categories, browse fill up's of questionnaire, delete fill up's of questionnaire and manage settings of Downloader plug-in. Note that this permission should never be given to user anonymous!
     93`DOWNLOADER_DOWNLOAD`: lets user to download things from main part of plug-in, if you like to let all users download from donwloader, just get this permission to user anonymous.
     94`DOWNLOADER_STATS`: lets user to browse part of statistics in the main module of Downloader (user will be able to see links to statistics in the right top corner of the page).
     95`DOWNLOADER_ADMIN`: lets user to upload files, manage files, releases and categories, browse fill up's of questionnaire, delete fill up's of questionnaire and manage settings of Downloader plug-in. Note that this permission should never be given to user anonymous!
    9296
    93 == Wiki syntax ==
     97== Wiki syntax
    9498
    9599Downloader plug-in provides three types of wiki syntax for referencing of standalone files, whole releases or categories. Each syntax have two possible forms. If syntax is enclosed by [] you can easily write your own title for item (file, release, category). If the syntax is separated just by spaces, there will be automatically created link with name of referenced item (file, release, category).
    … …  
    106110downloadercat:43 - Creates link to category with id 43 with it's name
    107111[downloadercat:43 click here] - Creates 'click here' link to category with id 43
    108 
    109 
    110112}}}
    111113
    112 If item of that id doesn't exist, there's diplayed only link to nowhere with title "id not found". If file was deleted, it still displays it's correct name, but link is to nowhere.
     114If item of that id doesn't exist, there's diplayed only link to nowhere with title "id not found". If file was deleted, it still displays its correct name, but does not link to anywhere.
    113115
    114 == Special features ==
     116== Special features
    115117
    116 This features are availible only if you have Downloader installed in unzipped form (doesn't work in egg or zip file).
     118This features are available only if you have Downloader installed in unzipped form (doesn't work in egg or zip file).
    117119
    118120'''MIME list'''
    … …  
    120122
    121123'''EDIT QUESTIONNAIRE'''
    122 The file form_data.py contains structure used to generate questionnaire before download of file. You can easily edit this to get from users the data you exactly want. There is big decription inside of this file.
     124The file form_data.py contains structure used to generate questionnaire before download of file. You can easily edit this to get from users the data you exactly want. There is big description inside of this file.
    123125
    124 == Reset all statistics ==
     126== Reset all statistics
    125127
    126 To clear all recorded data about dowloads and users who downloaded anything by !DownloaderPlugin you can use on your Trac environment database these two SQL commands.
     128To clear all recorded data about downloads and users who downloaded anything by !DownloaderPlugin you can use on your Trac environment database these two SQL commands.
    127129{{{
    128130DELETE FROM downloader_downloaded_attributes;
    129131DELETE FROM downloader_downloaded;
     132}}}
    130133
    131 }}}
    132 That's all... After this '''all statistics are gone...'''
     134After this '''all statistics are gone'''.
    133135
    134 == Recent Changes ==
     136== Recent Changes
    135137
    136138[[ChangeLog(tracdownloaderplugin, 3)]]
    137139
    138 == Author/Contributors ==
     140== Author/Contributors
    139141
    140142'''Author:''' [wiki:peca Petr Škoda] [[BR]]
    141 '''Maintainer:''' [wiki:peca Petr Škoda] [[BR]]
     143'''Maintainer:''' [[Maintainer]] [[BR]]
    142144'''Contributors:'''