Screenshots Plugin

Description

Provides screenshots upload and viewing subsystem 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 timeline and screenshots can be referenced or embedded in wiki pages. Plugin internally defines few interfaces for further extension.

The name is a little misleading as of course it is perfectly able to be used as a picture archive for the wiki pages.

Bugs/Feature Requests

Existing bugs and feature requests for ScreenshotsPlugin are here.

If you have any issues, create a new ticket but read BugReporting page first, please.

Download and Source

Download the zipped source, check out using Subversion, or browse the source with Trac.

Dependencies

You need to have PIL library installed to get plugin working. Plugin optionally depends on TracTags plugin for screenshot tagging support.

Installation

Install plugins egg and set variables in the [screenshots] section of your trac.ini configuration file according to your needs. Following list shows all of them with a description and their default values:

Option	Description	Default Value
additional_tags	what additional screenshot attributes will be inserted as tags	author,components,versions,name
default_components	default values for component filter	all
default_description	description attached to the screenshot if not explicitly specified in request	$description
default_filter_relation	how the filters should be related by default	or
default_format	format which will be returned if no format is specified in request (see formats below)	html
default_list_item	how the [[ScreenshotsList]] macro should be expanded by default	$id - $name - $description
default_order_directions	whether to start with the first or last item by default	asc
default_orders	if not specified otherwise, by which criteria should we order?	id
default_versions	default values for version filter	all
ext	list of allowed file extension which can be uploaded	jpg,png
formats	in which formats images can be downloaded	raw,html,jpg,png
mainnav_title	Caption in Tracs main navigation menu (empty = hide item)	Screenshots
metanav_title	Caption in Tracs meta navigation menu (empty = hide item)
path	location of directory where plugin should store uploaded and generated images	/var/lib/trac/screenshots

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.

default_components and default_versions options sets default values for component and version filter.

Another possible value for additional_tags except of those listed as default is description.

If you run Trac in environment which needs to enable plugins explicitly put in trac.ini these lines:

[components]
TracScreenshots.init.ScreenshotsInit = enabled
TracScreenshots.core.ScreenshotsCore = enabled
TracScreenshots.api.ScreenshotsApi = enabled
TracScreenshots.matrix_view.ScreenshotsMatrixView = enabled
TracScreenshots.tags.ScreenshotsMatrixView = enabled
TracScreenshots.wiki.ScreenshotsWiki = enabled
TracScreenshots.timeline.ScreenshotsTimeline = enabled # For 0.11 branch.
TracScreenshots.tags.ScreenshotsTags = enabled

ScreenshotMatrixView is currently the only one present component for actual screenshots display although there are internaly defined interfaces so any other component with different view can be introduced in the future.

If you don't have TagsPlugin installed replace last line with

tracscreenshots.tags.screenshotstags = disabled

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:

# trac-admin <path_to_environment> upgrade

Permissions

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):

SCREENSHOTS_ADD	permission to upload screenshots
SCREENSHOTS_ADMIN	permission to upload, delete, view, filter and order screenshots
SCREENSHOTS_DELETE	permission to delete screenshots
SCREENSHOTS_FILTER	allows to modify component and version filter
SCREENSHOTS_ORDER	permits to change the order they are displayed in
SCREENSHOTS_VIEW	permits to browse screenshots and see screenshot uploads in timeline

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:

# trac-admin <path_to_environment> permission add <user> SCREENSHOTS_ADMIN
# trac-admin <path_to_environment> permission add <user> SCREENSHOTS_ADD
# trac-admin <path_to_environment> permission add <user> SCREENSHOTS_DELETE
# trac-admin <path_to_environment> permission add <user> SCREENSHOTS_FILTER
# trac-admin <path_to_environment> permission add <user> SCREENSHOTS_ORDER
# trac-admin <path_to_environment> permission add <user> SCREENSHOTS_VIEW

Macros

There is a macro [screenshot:<screenshot_id>] for screenshots referencing.

For screenshot embedding in wiki page use [[Screenshot(<screenshot_id>, [<attribute>=<value>, ...])]]. First mandatory argument is ID of the screenshot. Number or image attributes can be specified next. This is a list of them:

• align - Specifies image alignment in wiki page. Possible values are: left, right and center.
• alt - Alternative description of image.
• border - Sets image border of specified width in pixels.
• class - Class of image for CSS styling.
• description - Brief description under the image. Accepts several variables (see bellow).
• format - Format of returned image or screenshot behind link.
• height - Height of image. Set to 0 if you want original image height.
• id - ID of image for CSS styling.
• longdesc - Detailed description of image.
• title - Title of image.
• usemap - Image map for clickable images.
• width - Width of image. Set to 0 if you want original image width.

Attribute description displays several variables:

• $id - ID of image.
• $name - Name of image.
• $author - User name who uploaded image.
• $time - Time when image was uploaded.
• $file - File name of image.
• $description - Detailed description of image.
• $width - Original width of image.
• $height - Original height of image.
• $tags - Comma separated list of screenshot tags.
• $components - Comma separated list of screenshot components.
• $versions - Comma separated list of screenshot versions.

Example:

 [[Screenshot(2,width=400,height=300,description=The $name by $author: $description,align=left)]]

For creating image maps you might consider using tools like http://www.maschek.hu/imagemap/imgmap.

[[ScreenshotsList()]] macro displays list of all available screenshots on wiki page. Accepts one argument which is template for list items formatting. Possible variables in this template are:

• $id - ID of image.
• $name - Name of image.
• $author - User name who uploaded image.
• $time - Time when image was uploaded.
• $file - File name of image.
• $description - Detailed description of image.
• $width - Original width of image.
• $height - Original height of image.
• $tags - Comma separated list of screenshot tags.
• $components - Comma separated list of screenshot components.
• $versions - Comma separated list of screenshot versions.

Example:

 [[ScreenshotsList($name - $description ($widthx$height))]]

Notes

Previous revisions used space separated list of values in trac.ini configuration options. Now it uses comma separated list so change this to prevent inconveniences.

Feedback

Are you using this plugin?

• Yes, it's usefull. (sgrayban, cboos, okaori, wadeb, s0undt3ch, ttressieres, imme, dh1jc, talameelombu, Tharban, athomas, jtuchscherer, xvirus, osimons, prz, Sincklation, manni, izzy, ericalens, KevinGabbert, mwehr, renzo, marcvs, eskil, rjollos, koolhand, edo, colski, dfleming, lucasrangit, miezuit, lhr870630, hasienda)
• No, it's useless.
• No, I don't need it. (dfaerch, harmy)

Change Log

[7703] by Blackhex on 02/23/10 09:46:38

ScreenshotsPlugin:

• Bug #6702 fix.

[7486] by Blackhex on 01/29/10 16:43:00

ScreenshotsPlugin:

• Regression of bug #4257 fixed. If you experience cyclic redirections with mod_python, it's because you have path setted to {{{../screenhsots}}, change it.
• additional_tags config option added.
• Environment upgrade now depends on path directory existance and it crates it.
• path option can be now relative to trac.ini placement and it defaults to ../screenshots.
• Fixed handling of internationalized file names.
• All components and versions are enabled by default in filter now.

[7481] by Blackhex on 01/26/10 16:56:14

ScreenshotsPlugin:

• Bug #4535 fix.
• Some XHTML validation fixes.

[5002] by Blackhex on 12/12/08 10:36:51

ScreenshotsPlugin:

• Bug #4257 fix.
• SCREENSHOTS_ADMIN permission separated into SCREENSHOTS_ADD, SCREENSHOTS_EDIT and SCREENSHOTS_DELETE.

[4673] by Blackhex on 10/30/08 15:36:06

ScreenshotsPlugin:

• Fixed uploaded file name problem on Windows.

[4365] by Blackhex on 10/01/08 19:08:37

ScreenshotsPlugin:

• Fixed missing exclamation mark in configuration option documentation.

Author/Contributors

Author: Blackhex
Maintainer: Blackhex
Contributors: