Changes between Version 46 and Version 47 of ScreenshotsPlugin


Ignore:
Timestamp:
Aug 6, 2016, 7:57:14 AM (6 years ago)
Author:
figaro
Comment:

Further cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • ScreenshotsPlugin

    v46 v47  
    11[[PageOutline(2-5,Contents,pullout)]]
    22
    3 = Screenshots Plugin
     3= Manage images and screenshots in Trac
    44
    55== Description
    66
    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.
     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 Trac wiki pages. The plugin internally defines few interfaces for further extension.
    88
    99The plugin can also be used as a picture archive for the wiki pages.
     
    2929Check out ScreenshotsPlugin from [/svn/screenshotsplugin here] using Subversion, or [source:screenshotsplugin browse the source] with Trac.
    3030
    31 == Dependencies
    32 
    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.
    34 
    3531== Installation
     32
     33'''Dependencies''':
     34 * You need to have the [pypi:PIL Python Imaging Library] installed to get the plugin working.
     35 * Optional: install the TracTags plugin for screenshot tagging support.
    3636
    3737Install the plugin egg. Set the variables in the {{{[screenshots]}}} section of your {{{trac.ini}}} configuration file according to your needs:
     
    5353||path|| location of directory where plugin should store uploaded and generated images || /var/lib/trac/screenshots ||
    5454
    55 {{{default_format}}} and {{{formats}}} must be supported by your Python Imaging 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.
     55{{{default_format}}} and {{{formats}}} must be supported by your Python Imaging Library installation. There are two meta formats:
     56 * {{{raw}}} denotes original format of uploaded image
     57 * {{{html}}} is image embedded in HTML page.
     58
     59{{{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.
    5660
    5761{{{default_components}}} and {{{default_versions}}} options sets default values for component and version filter.
     
    148152}}}
    149153
    150 For creating image maps you might consider using tools like [http://www.maschek.hu/imagemap/imgmap imgmap].
    151 
    152 {{{[[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:
     154For creating image maps you may want to consider using tools like [http://www.maschek.hu/imagemap/imgmap imgmap], which itself is dual licensed: Commercial and GPL.
     155
     156{{{[[ScreenshotsList()]]}}} macro displays a list of all available screenshots on the wiki page. It accepts one argument, which is the template for list items formatting. The possible variables in this template are:
    153157
    154158 * {{{$id}}} - ID of image.
     
    172176== Notes
    173177
    174 Previous revisions used space separated list of values in the `trac.ini` configuration options. Now it uses comma separated list so change this to prevent inconveniences.
     178Previous revisions used space separated list of values in the `trac.ini` configuration options. Now it uses a comma separated list, so change this to prevent inconveniences.
    175179
    176180== Feedback