Changes between Version 45 and Version 46 of ScreenshotsPlugin
- Timestamp:
- Nov 11, 2015, 9:17:43 AM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
ScreenshotsPlugin
v45 v46 5 5 == Description 6 6 7 Provides screenshots upload and viewing subsystemfor Trac. Uploaded screenshots can be described with short name, longer description and custom tags (if TracTags plugin is installed) and assigned to any number of components and versions registered in Trac. Screenshot uploads can be listed in the timeline and screenshots can be referenced or embedded in wiki pages. The plugin internally defines few interfaces for further extension.8 9 The plugin is perfectly able to be used as a picture archive for the wiki pages.7 This plugin provides a screenshots upload and viewing facility for Trac. Uploaded screenshots can be described with short name, longer description and custom tags (if TracTags plugin is installed) and assigned to any number of components and versions registered in Trac. Screenshot uploads can be listed in the timeline and screenshots can be referenced or embedded in wiki pages. The plugin internally defines few interfaces for further extension. 8 9 The plugin can also be used as a picture archive for the wiki pages. 10 10 11 11 See also: ScreenshotPastePlugin … … 13 13 == Bugs/Feature Requests 14 14 15 Check [query:?status=new&status=assigned&status=reopened&group=&component=ScreenshotsPlugin&order=priority existing bugs and feature requests] first, please. If you have additional issues, you are welcome to ask at our mailing-list to confirm proper local install and configuration. Please create a [/newticket?component=ScreenshotsPlugin&owner=Blackhex&cc=hasienda new ticket], if you're reasonably sure, that it will be a valid defect report or a generally useful enhancement that follows BugReporting recommendations. 15 Existing bugs and feature requests for ScreenshotsPlugin are 16 [report:9?COMPONENT=ScreenshotsPlugin here]. 17 18 If you have any issues, create a 19 [/newticket?component=ScreenshotsPlugin new ticket]. 16 20 17 21 [[TicketQuery(component=ScreenshotsPlugin&group=type,format=progress)]] 18 22 19 == Download and Source 20 21 Download the [download:screenshotsplugin zipped source], check out [/svn/screenshotsplugin using Subversion], or [source:screenshotsplugin browse the source] with Trac. 23 == Download 24 25 Download the zipped source from [export:screenshotsplugin zipped here]. 26 27 == Source 28 29 Check out ScreenshotsPlugin from [/svn/screenshotsplugin here] using Subversion, or [source:screenshotsplugin browse the source] with Trac. 22 30 23 31 == Dependencies 24 32 25 You need to have the [ http://pythonware.com/products/pil/ Python Imaging Library] installed to get the plugin working. Plugin optionally depends on TracTags plugin for screenshot tagging support.33 You need to have the [pypi:PIL Python Imaging Library] installed to get the plugin working. The plugin optionally depends on TracTags plugin for screenshot tagging support. 26 34 27 35 == Installation … … 41 49 ||ext|| list of allowed file extension which can be uploaded || jpg,png || 42 50 ||formats|| in which formats images can be downloaded || raw,html,jpg,png || 43 ||mainnav_title|| Caption in Tracs main navigation menu (empty = hide item)|| Screenshots ||44 ||metanav_title|| Caption in Tracs meta navigation menu (empty = hide item) || ||51 ||mainnav_title|| caption in Tracs main navigation menu (empty = hide item)|| Screenshots || 52 ||metanav_title|| caption in Tracs meta navigation menu (empty = hide item) || || 45 53 ||path|| location of directory where plugin should store uploaded and generated images || /var/lib/trac/screenshots || 46 54 … … 51 59 Another possible value for {{{additional_tags}}} except of those listed as default is {{{description}}}. 52 60 53 If you run Trac in an environment which needs to enable plugins explicitly, put these lines in trac.ini:61 If you run Trac in an environment which needs to enable plugins explicitly, put these lines in your `trac.ini` file: 54 62 55 63 {{{#!ini … … 72 80 }}} 73 81 74 Create directory you have specified with {{{path}}} config option and make sure it is accessible by Trac server. The next step is to upgrade your environment: 75 82 Create a directory you have specified with {{{path}}} config option and make sure it is accessible by your Trac server. The next step is to upgrade your environment: 76 83 {{{#!sh 77 84 trac-admin <path_to_environment> upgrade … … 80 87 == Permissions 81 88 82 Screenshots 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:89 This plugin defines the following 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: 83 90 84 91 ||'''Permission'''||'''Description'''|| … … 86 93 ||SCREENSHOTS_ADMIN||permission to upload, delete, view, filter and order screenshots|| 87 94 ||SCREENSHOTS_DELETE||permission to delete screenshots|| 88 ||SCREENSHOTS_FILTER|| allowsto modify component and version filter||89 ||SCREENSHOTS_ORDER||permi tsto change the order they are displayed in||90 ||SCREENSHOTS_VIEW||permi tsto browse screenshots and see screenshot uploads in timeline||95 ||SCREENSHOTS_FILTER||permission to modify component and version filter|| 96 ||SCREENSHOTS_ORDER||permission to change the order they are displayed in|| 97 ||SCREENSHOTS_VIEW||permission to browse screenshots and see screenshot uploads in timeline|| 91 98 92 99 If you use Apache, please restart it before setting permissions. You can add these permissions by typing the following commands from the command line or you can use WebAdminPlugin to do it for you: … … 112 119 * {{{border}}} - Sets image border of specified width in pixels. 113 120 * {{{class}}} - Class of image for CSS styling. 114 * {{{description}}} - Brief description under the image. Accepts several 115 variables (see bellow). 121 * {{{description}}} - Brief description under the image. Accepts several variables (see below). 116 122 * {{{format}}} - Format of returned image or screenshot behind link. 117 123 * {{{height}}} - Height of image. Set to 0 if you want original image height. … … 160 166 Example: 161 167 162 168 {{{ 163 169 [[ScreenshotsList($name - $description ($widthx$height))]] 164 170 }}}