Changes between Version 33 and Version 34 of ScreenshotsPlugin


Ignore:
Timestamp:
Jan 29, 2010, 5:06:25 PM (5 years ago)
Author:
Blackhex
Comment:

Documentation updated to r7486.

Legend:

Unmodified
Added
Removed
Modified
  • ScreenshotsPlugin

    v33 v34  
    3030
    3131||'''Option'''||'''Description'''||'''Default Value'''||
    32 ||default_components|| default values for component filter || none ||
     32||additional_tags|| what additional screenshot attributes will be inserted as tags || author,components,versions,name ||
     33||default_components|| default values for component filter || all ||
    3334||default_description|| description attached to the screenshot if not explicitly specified in request || $description ||
    3435||default_filter_relation|| how the filters should be related by default || or ||
     
    3738||default_order_directions|| whether to start with the first or last item by default || asc ||
    3839||default_orders|| if not specified otherwise, by which criteria should we order? || id ||
    39 ||default_versions|| default values for version filter || none ||
     40||default_versions|| default values for version filter || all ||
    4041||ext|| list of allowed file extension which can be uploaded || jpg,png ||
    4142||formats|| in which formats images can be downloaded || raw,html,jpg,png ||
     
    4647{{{default_format}}} and {{{formats}}} must be supported by your PIL library installation. There are two meta formats: {{{raw}}} denotes original format of uploaded image and {{{html}}} is image embedded in HTML page. {{{ext}}} can also include the {{{zip}}} extension, which is not included by default for security reasons. If a {{{zip}}} file containing multiple images is uploaded, all of the images applying to the other extensions specified by {{{ext}}} will be added with the same metadata entered for the {{{zip}}} file - and the {{{zip}}} file itself will be abandoned.
    4748
    48 {{{default_components}}} and {{{default_versions}}} options sets default values for component and version filter. Set these variables according your Trac setup, otherwise, you wouldn't see any screenshots with default filter.
     49{{{default_components}}} and {{{default_versions}}} options sets default values for component and version filter.
     50
     51Another possible value for {{{additional_tags}}} except of those listed as default is {{{description}}}.
    4952
    5053If you run Trac in environment which needs to enable plugins explicitly put in trac.ini these lines:
     
    7881
    7982Screenshots plugin defines four permissions - each one in this list depends on the one mentioned before it, and adds its permissions upon that (with ''SCREENSHOTS_FILTER'' and ''SCREENSHOTS_ORDER'' being on the same level):
    80 ||'''SCREENSHOTS_VIEW'''||permits to browse screenshots and see screenshot uploads in timeline||
     83||'''SCREENSHOTS_ADD'''||permission to upload screenshots||
     84||'''SCREENSHOTS_ADMIN'''||permission to upload, delete, view, filter and order screenshots||
     85||'''SCREENSHOTS_DELETE'''||permission to delete screenshots||
    8186||'''SCREENSHOTS_FILTER'''||allows to modify component and version filter||
    8287||'''SCREENSHOTS_ORDER'''||permits to change the order they are displayed in||
    83 ||'''SCREENSHOTS_ADMIN'''||permission to upload/delete screenshots||
     88||'''SCREENSHOTS_VIEW'''||permits to browse screenshots and see screenshot uploads in timeline||
     89
    8490''If you use apache, please restart it, before setting permissions.'' You can add these permissions by typing following commands from commandline or you can use WebAdminPlugin to do it for you:
    8591
    8692{{{
    87 # trac-admin <path_to_environment> permission add <user> SCREENSHOTS_VIEW
     93# trac-admin <path_to_environment> permission add <user> SCREENSHOTS_ADMIN
     94# trac-admin <path_to_environment> permission add <user> SCREENSHOTS_ADD
     95# trac-admin <path_to_environment> permission add <user> SCREENSHOTS_DELETE
    8896# trac-admin <path_to_environment> permission add <user> SCREENSHOTS_FILTER
    8997# trac-admin <path_to_environment> permission add <user> SCREENSHOTS_ORDER
    90 # trac-admin <path_to_environment> permission add <user> SCREENSHOTS_ADMIN
     98# trac-admin <path_to_environment> permission add <user> SCREENSHOTS_VIEW
    9199}}}
    92100