Changes between Version 23 and Version 24 of ScreenshotsPlugin


Ignore:
Timestamp:
Oct 2, 2008, 12:40:28 PM (6 years ago)
Author:
izzy
Comment:

updated latest feature adds

Legend:

Unmodified
Added
Removed
Modified
  • ScreenshotsPlugin

    v23 v24  
    2727{{{
    2828[screenshots]
     29default_components = none
     30default_description = $description
     31default_filter_relation = or
     32default_format = html
     33default_format = html
     34default_list_item = $id - $name - $description
     35default_order_directions = asc
     36default_orders = id
     37default_versions = none
     38ext = jpg,png
     39formats = raw,html,jpg,png
    2940mainnav_title = Screenshots
    3041metanav_title =
    3142path = /var/lib/trac/screenshots
    32 ext = jpg,png
    33 formats = raw,html,jpg,png
    34 default_format = html
    35 default_components = none
    36 default_versions = none
    3743}}}
    3844
    39 Value of {{{mainnav_title}}} variable sets caption of item in Trac's main navigation menu and {{{metanav_title}}} sets caption of meta navigation menu item. Appropriate item will be hidden if its title is empty. {{{path}}} is location of directory where plugin should store uploaded and generated images and {{{ext}}} is list of allowed file extension which can be uploaded. Using {{{formats}}} option you can set in wich formats can be images downloaded and {{{default_format}}} is format which will be returned if no format is specified in request. It must be one of formats supported by your PIL library installation. There are two meta formats: {{{raw}}} denotes original format of uploaded image and {{{html}}} is image embended in HTML page. {{{default_components}}} and {{{default_versions}}} options sets default values for component and version filter. Set these variables according your Trac setup, otherwise, you would't see any screenshots with default filter.
     45||'''Option'''||'''Description'''||
     46||default_components|| default values for component filter ||
     47||default_description|| description attached to the screenshot if not explicitly specified in request ||
     48||default_filter_relation|| how the filters should be related by default ||
     49||default_format|| format which will be returned if no format is specified in request (see ''formats'' below) ||
     50||default_list_item|| how the {{{[[ScreenshotsList]]}}} macro should be expanded by default ||
     51||default_order_directions|| whether to start with the first or last item by default ||
     52||default_orders|| if not specified otherwise, by which criteria should we order? ||
     53||default_versions|| default values for version filter ||
     54||ext|| list of allowed file extension which can be uploaded ||
     55||formats|| in which formats images can be downloaded ||
     56||mainnav_title|| Caption in Tracs main navigation menu (empty = hide item)||
     57||metanav_title|| Caption in Tracs meta navigation menu (empty = hide item) ||
     58||path|| location of directory where plugin should store uploaded and generated images ||
     59
     60{{{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 embended in HTML page.
     61
     62{{{default_components}}} and {{{default_versions}}} options sets default values for component and version filter. Set these variables according your Trac setup, otherwise, you would't see any screenshots with default filter.
    4063
    4164If you run Trac in environment which needs to enable plugins explicitly put in trac.ini these lines:
     
    6487== Permissions ==
    6588
    66 Screenshots plugin defines four permissions. With SCREENSHOTS_VIEW permission you can browse screenshots and see screenshot uploads in timeline. SCREENSHOTS_ADMIN adds you rights to upload screenshots, SCREENSHOTS_FILTER allows you to modify component and version filter, and SCREENSHOTS_ORDER permits you to change the order they are displayed in.
     89Screenshots 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):
     90||'''SCREENSHOTS_VIEW'''||permits to browse screenshots and see screenshot uploads in timeline||
     91||'''SCREENSHOTS_FILTER'''||allows to modify component and version filter||
     92||'''SCREENSHOTS_ORDER'''||permits to change the order they are displayed in||
     93||'''SCREENSHOTS_ADMIN'''||permission to upload/delete screenshots||
    6794''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:
    6895
    6996{{{
    7097# trac-admin <path_to_environment> permission add <user> SCREENSHOTS_VIEW
     98# trac-admin <path_to_environment> permission add <user> SCREENSHOTS_FILTER
     99# trac-admin <path_to_environment> permission add <user> SCREENSHOTS_ORDER
    71100# trac-admin <path_to_environment> permission add <user> SCREENSHOTS_ADMIN
    72 # trac-admin <path_to_environment> permission add <user> SCREENSHOTS_FILTER
    73101}}}
    74102