Changes between Version 45 and Version 46 of ScreenshotsPlugin


Ignore:
Timestamp:
Nov 11, 2015, 9:17:43 AM (7 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • ScreenshotsPlugin

    v45 v46  
    55== Description
    66
    7 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 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.
     7This 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
     9The plugin can also be used as a picture archive for the wiki pages.
    1010
    1111See also: ScreenshotPastePlugin
     
    1313== Bugs/Feature Requests
    1414
    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.
     15Existing bugs and feature requests for ScreenshotsPlugin are
     16[report:9?COMPONENT=ScreenshotsPlugin here].
     17
     18If you have any issues, create a
     19[/newticket?component=ScreenshotsPlugin new ticket].
    1620
    1721[[TicketQuery(component=ScreenshotsPlugin&group=type,format=progress)]]
    1822
    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
     25Download the zipped source from [export:screenshotsplugin zipped here].
     26
     27== Source
     28
     29Check out ScreenshotsPlugin from [/svn/screenshotsplugin here] using Subversion, or [source:screenshotsplugin browse the source] with Trac.
    2230
    2331== Dependencies
    2432
    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.
     33You 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.
    2634
    2735== Installation
     
    4149||ext|| list of allowed file extension which can be uploaded || jpg,png ||
    4250||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) || ||
    4553||path|| location of directory where plugin should store uploaded and generated images || /var/lib/trac/screenshots ||
    4654
     
    5159Another possible value for {{{additional_tags}}} except of those listed as default is {{{description}}}.
    5260
    53 If you run Trac in an environment which needs to enable plugins explicitly, put these lines in trac.ini:
     61If you run Trac in an environment which needs to enable plugins explicitly, put these lines in your `trac.ini` file:
    5462
    5563{{{#!ini
     
    7280}}}
    7381
    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 
     82Create 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:
    7683{{{#!sh
    7784trac-admin <path_to_environment> upgrade
     
    8087== Permissions
    8188
    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:
     89This 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:
    8390
    8491||'''Permission'''||'''Description'''||
     
    8693||SCREENSHOTS_ADMIN||permission to upload, delete, view, filter and order screenshots||
    8794||SCREENSHOTS_DELETE||permission to delete screenshots||
    88 ||SCREENSHOTS_FILTER||allows to modify component and version filter||
    89 ||SCREENSHOTS_ORDER||permits to change the order they are displayed in||
    90 ||SCREENSHOTS_VIEW||permits to 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||
    9198
    9299If 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:
     
    112119 * {{{border}}} - Sets image border of specified width in pixels.
    113120 * {{{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).
    116122 * {{{format}}} - Format of returned image or screenshot behind link.
    117123 * {{{height}}} - Height of image. Set to 0 if you want original image height.
     
    160166Example:
    161167
    162  {{{
     168{{{
    163169[[ScreenshotsList($name - $description ($widthx$height))]]
    164170}}}