Changes between Version 24 and Version 25 of ScreenshotsPlugin


Ignore:
Timestamp:
Oct 2, 2008, 5:03:58 PM (8 years ago)
Author:
izzy
Comment:

Spell checking and TOC

Legend:

Unmodified
Added
Removed
Modified
  • ScreenshotsPlugin

    v24 v25  
     1[[TOC]]
     2
    13= Screenshots Plugin =
    24
    35== Description ==
    46
    5 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 embender in wiki pages. Plugin internally defines few interfaces for further extension.
     7Provides 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.
    68
    79== Bugs/Feature Requests ==
     
    2325== Installation ==
    2426
    25 Install plugin's egg and set variables in trac.ini configuration file according to your needs. Following list shows all of them with their default values:
     27Install plugins egg and set variables in trac.ini configuration file according to your needs. Following list shows all of them with their default values:
    2628
    2729{{{
     
    5860||path|| location of directory where plugin should store uploaded and generated images ||
    5961
    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.
     62{{{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.
    6163
    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.
     64{{{default_components}}} and {{{default_versions}}} options sets default values for component and version filter. Set these variables according your Trac setup, otherwise, you wouldn't see any screenshots with default filter.
    6365
    6466If you run Trac in environment which needs to enable plugins explicitly put in trac.ini these lines:
     
    106108There is a macro {{{[screenshot:<screenshot_id>]}}} for screenshots referencing.
    107109
    108 For screenshot embending in wiki page use {{{[[Screenshot(<screenshot_id>, [<attribute>=<value>, ...])]]}}}. First mandatory argument is ID of the screenshot. Number or image attributes
     110For screenshot embedding in wiki page use {{{[[Screenshot(<screenshot_id>, [<attribute>=<value>, ...])]]}}}. First mandatory argument is ID of the screenshot. Number or image attributes
    109111can be specified next. This is a list of them:
    110112
     
    146148For creating image maps you might consider using tools like http://www.maschek.hu/imagemap/imgmap.
    147149
    148 {{{[[ScreenshotsList()]]}}} macro displays list of all available screenshots on wiki page. Accepts one argument which is template for list items fromatting. Possible variables in this template are:
     150{{{[[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:
    149151
    150152 * {{{$id}}} - ID of image.
     
    163165
    164166{{{
    165  [[ScreenshotsList($name - $description ($widthx$height))]]
     167 [[ScreenshotsList($name - $description (${width}x${height}))]]
    166168}}}
    167169
     
    172174== Feedback ==
    173175
    174 [[Poll(Are you using this plugin?; Yes, it's usefull.; No, it's useless.; No, I don't need it.)]]
     176[[Poll(Are you using this plugin?; Yes, it's useful.; No, it's useless.; No, I don't need it.)]]
    175177
    176178== Change Log ==