Changes between Version 42 and Version 43 of ScreenshotsPlugin


Ignore:
Timestamp:
Mar 3, 2015, 9:39:18 AM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • ScreenshotsPlugin

    v42 v43  
    11[[PageOutline(2-5,Contents,pullout)]]
    2 = Screenshots Plugin =
    3 
    4 == Description ==
    5 
    6 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.
    7 
    8 The name is a little misleading as of course it is perfectly able to be used as a picture archive for the wiki pages.
    9 
    10 == Bugs/Feature Requests ==
    11 
    12 total issue record:
     2
     3= Screenshots Plugin
     4
     5== Description
     6
     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 the timeline and screenshots can be referenced or embedded in wiki pages. The plugin internally defines few interfaces for further extension.
     8
     9The plugin is perfectly able to be used as a picture archive for the wiki pages.
     10
     11== Bugs/Feature Requests
     12
     13Total issue record:
    1314[[TicketQuery(component=ScreenshotsPlugin,format=progress)]]
    14 open issues by type:
     15Open issues by type:
    1516 [[TicketQuery(component=ScreenshotsPlugin,status!=closed&group=type,format=progress)]]
    1617
    17 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're 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. Thanks for taking care.
    18 
    19 == Download and Source ==
     18Check [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. Thanks for taking care.
     19
     20== Download and Source
    2021
    2122Download the [download:screenshotsplugin zipped source], check out [/svn/screenshotsplugin using Subversion], or [source:screenshotsplugin browse the source] with Trac.
    2223
    23 == Dependencies ==
    24 
    25 You need to have [http://pythonware.com/products/pil/ PIL] library installed to get plugin working. Plugin optionally depends on TracTags plugin for screenshot tagging support.
    26 
    27 == Installation ==
    28 
    29 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:
     24== Dependencies
     25
     26You 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.
     27
     28== Installation
     29
     30Install the plugin egg. Set the variables in the {{{[screenshots]}}} section of your {{{trac.ini}}} configuration file according to your needs:
    3031
    3132||'''Option'''||'''Description'''||'''Default Value'''||
    … …  
    4546||path|| location of directory where plugin should store uploaded and generated images || /var/lib/trac/screenshots ||
    4647
    47 {{{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.
     48{{{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.
    4849
    4950{{{default_components}}} and {{{default_versions}}} options sets default values for component and version filter.
    … …  
    5152Another possible value for {{{additional_tags}}} except of those listed as default is {{{description}}}.
    5253
    53 If you run Trac in environment which needs to enable plugins explicitly put in trac.ini these lines:
     54If you run Trac in an environment which needs to enable plugins explicitly, put these lines in trac.ini:
    5455
    5556{{{
    … …  
    6566}}}
    6667
    67 {{{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.
    68 
    69 If you don't have TagsPlugin installed replace last line with
     68{{{ScreenshotMatrixView}}} is currently the only component for actual screenshots display, although there are internally defined interfaces, so any other component with a different view can be introduced in the future.
     69
     70If you don't have TagsPlugin installed replace last line with:
    7071{{{
    7172tracscreenshots.tags.screenshotstags = disabled
    … …  
    7879}}}
    7980
    80 == Permissions ==
     81== Permissions
    8182
    8283Screenshots 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):
    … …  
    8889||'''SCREENSHOTS_VIEW'''||permits to browse screenshots and see screenshot uploads in timeline||
    8990
    90 ''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:
     91If 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:
    9192
    9293{{{
    … …  
    99100}}}
    100101
    101 == Macros ==
    102 
    103 There is a macro {{{[screenshot:<screenshot_id>]}}} for screenshots referencing.
    104 
    105 For screenshot embedding in wiki page use {{{[[Screenshot(<screenshot_id>, [<attribute>=<value>, ...])]]}}}. First mandatory argument is ID of the screenshot. Number or image attributes
    106 can be specified next. This is a list of them:
     102== Macros
     103
     104The macro {{{[screenshot:<screenshot_id>]}}} can be used for screenshots referencing.
     105
     106For screenshot embedding in wiki page use {{{[[Screenshot(<screenshot_id>, [<attribute>=<value>, ...])]]}}}. First argument is the ID of the screenshot and is mandatory. The following image attributes can then optionally be specified:
    107107
    108108 * {{{align}}} - Specifies image alignment in wiki page. Possible values are:
    … …  
    163163}}}
    164164
    165 == Notes ==
     165== Notes
    166166
    167167Previous revisions used space separated list of values in {{{trac.ini}}} configuration options. Now it uses comma separated list so change this to prevent inconveniences.
    168168
    169 == Feedback ==
     169== Feedback
    170170
    171171[[Poll(Are you using this plugin?; Yes, it's usefull.; No, it's useless.; No, I don't need it.)]]
    172172
    173 == About i18n/l10n support ==
     173== About i18n/l10n support
     174
    174175The 0.12 branch of this plugin is prepared for localization.[[BR]]
    175176But English message texts are still the (POSIX) default. If this isn't your preferred language, you can
    176  1. look, if it's already available from the [TracPluginTranslation Trac plugin l10n project] at [http://www.transifex.net/projects/p/Trac_Plugin-L10N/resource/tracscreenshots Transifex] or
    177  2. do it yourself (see the [http://trac.edgewall.org/wiki/CookBook/PluginL10N#Dotranslatorswork l10n cookbook page for Trac plugins] for more details).
     177 1. check if it's already available from the [TracPluginTranslation Trac plugin l10n project] at [http://www.transifex.net/projects/p/Trac_Plugin-L10N/resource/tracscreenshots Transifex] or
     178 2. do it yourself, see the [http://trac.edgewall.org/wiki/CookBook/PluginL10N#Dotranslatorswork l10n cookbook page for Trac plugins] for more details.
    178179
    179180You've done a new translation? Superb! Contributing your translation is highly appreciated.[[BR]]
    … …  
    195196Again, for more details see the [t:wiki:CookBook/PluginL10N#Compileanduseit l10n cookbook page for Trac plugins].
    196197
    197 == Change Log ==
     198== Change Log
    198199
    199200[[ChangeLog(/screenshotsplugin, 5)]]
    200201
    201 == Author/Contributors ==
     202== Author/Contributors
    202203
    203204'''Author:''' [wiki:Blackhex] [[BR]]