Changes between Version 44 and Version 45 of ScreenshotsPlugin


Ignore:
Timestamp:
Apr 2, 2015, 11:54:10 AM (7 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with needsadoption

Legend:

Unmodified
Added
Removed
Modified
  • ScreenshotsPlugin

    v44 v45  
    99The plugin is perfectly able to be used as a picture archive for the wiki pages.
    1010
     11See also: ScreenshotPastePlugin
     12
    1113== Bugs/Feature Requests
    1214
    13 Total issue record:
    14 [[TicketQuery(component=ScreenshotsPlugin,format=progress)]]
    15 Open issues by type:
    16  [[TicketQuery(component=ScreenshotsPlugin,status!=closed&group=type,format=progress)]]
    17 
    18 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. Thanks for taking care.
     15Check [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.
     16
     17[[TicketQuery(component=ScreenshotsPlugin&group=type,format=progress)]]
    1918
    2019== Download and Source
     
    4645||path|| location of directory where plugin should store uploaded and generated images || /var/lib/trac/screenshots ||
    4746
    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.
     47{{{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.
    4948
    5049{{{default_components}}} and {{{default_versions}}} options sets default values for component and version filter.
     
    6867{{{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.
    6968
    70 If you don't have TagsPlugin installed replace last line with:
     69If you don't have TagsPlugin installed, then replace the last line with:
    7170{{{#!ini
    7271tracscreenshots.tags.screenshotstags = disabled
     
    7675
    7776{{{#!sh
    78 $ trac-admin <path_to_environment> upgrade
     77trac-admin <path_to_environment> upgrade
    7978}}}
    8079
    8180== Permissions
    8281
    83 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):
    84 ||'''SCREENSHOTS_ADD'''||permission to upload screenshots||
    85 ||'''SCREENSHOTS_ADMIN'''||permission to upload, delete, view, filter and order screenshots||
    86 ||'''SCREENSHOTS_DELETE'''||permission to delete screenshots||
    87 ||'''SCREENSHOTS_FILTER'''||allows to modify component and version filter||
    88 ||'''SCREENSHOTS_ORDER'''||permits to change the order they are displayed in||
    89 ||'''SCREENSHOTS_VIEW'''||permits to browse screenshots and see screenshot uploads in timeline||
     82Screenshots 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:
     83
     84||'''Permission'''||'''Description'''||
     85||SCREENSHOTS_ADD||permission to upload screenshots||
     86||SCREENSHOTS_ADMIN||permission to upload, delete, view, filter and order screenshots||
     87||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||
    9091
    9192If 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:
    9293
    9394{{{#!sh
    94 $ trac-admin <path_to_environment> permission add <user> SCREENSHOTS_ADMIN
    95 $ trac-admin <path_to_environment> permission add <user> SCREENSHOTS_ADD
    96 $ trac-admin <path_to_environment> permission add <user> SCREENSHOTS_DELETE
    97 $ trac-admin <path_to_environment> permission add <user> SCREENSHOTS_FILTER
    98 $ trac-admin <path_to_environment> permission add <user> SCREENSHOTS_ORDER
    99 $ trac-admin <path_to_environment> permission add <user> SCREENSHOTS_VIEW
     95trac-admin <path_to_environment> permission add <user> SCREENSHOTS_ADMIN
     96trac-admin <path_to_environment> permission add <user> SCREENSHOTS_ADD
     97trac-admin <path_to_environment> permission add <user> SCREENSHOTS_DELETE
     98trac-admin <path_to_environment> permission add <user> SCREENSHOTS_FILTER
     99trac-admin <path_to_environment> permission add <user> SCREENSHOTS_ORDER
     100trac-admin <path_to_environment> permission add <user> SCREENSHOTS_VIEW
    100101}}}
    101102
     
    137138Example:
    138139
    139  {{{
     140{{{
    140141[[Screenshot(2,width=400,height=300,description=The $name by $author: $description,align=left)]]
    141142}}}
     
    165166== Notes
    166167
    167 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.
     168Previous 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.
    168169
    169170== Feedback
     
    178179 2. do it yourself, see the [http://trac.edgewall.org/wiki/CookBook/PluginL10N#Dotranslatorswork l10n cookbook page for Trac plugins] for more details.
    179180
    180 You've done a new translation? Superb! Contributing your translation is highly appreciated.[[BR]]
    181 You could send it to the plugin's maintainer or contribute to [TracPluginTranslation Trac plugin l10n project]
    182 via [http://www.transifex.net/projects/p/Trac_Plugin-L10N/ Transifex]:
     181Contributing your translation is highly appreciated. You could send it to the plugin's maintainer or contribute to [TracPluginTranslation Trac plugin l10n project] via [http://www.transifex.net/projects/p/Trac_Plugin-L10N/ Transifex]:
    183182
    184183Top translations: Trac_Plugin-L10N » [http://www.transifex.net/projects/p/Trac_Plugin-L10N/resource/tracscreenshots/ tracscreenshots][[BR]]
     
    191190python ./setup.py compile_catalog -f
    192191python ./setup.py bdist_egg
    193 }}} 
    194 Step 2 is almost obsolete, and only needed to include translations marked as `# fuzzy` by the translator, since
    195 the compilation before packaging will do message catalog compilation compile only without the extra `-f` argument.
     192}}}
     193
     194Step 2 is almost obsolete, and only needed to include translations marked as `# fuzzy` by the translator, since the compilation before packaging will do message catalog compilation compile only without the extra `-f` argument.
    196195Again, for more details see the [t:wiki:CookBook/PluginL10N#Compileanduseit l10n cookbook page for Trac plugins].
    197196
    198197== Change Log
    199198
    200 [[ChangeLog(/screenshotsplugin, 5)]]
     199[[ChangeLog(/screenshotsplugin, 3)]]
    201200
    202201== Author/Contributors
    203202
    204203'''Author:''' [wiki:Blackhex] [[BR]]
    205 '''Maintainer:''' [wiki:Blackhex] [[BR]]
     204'''Maintainer:''' [[Maintainer]] [[BR]]
    206205'''Contributors:''' [wiki:hasienda] [[BR]]