Changes between Version 16 and Version 17 of ScreenshotsPlugin


Ignore:
Timestamp:
Mar 5, 2008 1:43:24 PM (6 years ago)
Author:
Blackhex
Comment:

trac.ini and macro documentation updated.

Legend:

Unmodified
Added
Removed
Modified
  • ScreenshotsPlugin

    v16 v17  
    3434metanav_title = 
    3535path = /var/lib/trac/screenshots 
    36 ext = jpg png 
    37 formats = raw html jpg png 
     36ext = jpg,png 
     37formats = raw,html,jpg,png 
    3838default_format = html 
    3939default_components = none 
     
    6666}}} 
    6767 
    68  
    6968== Permissions == 
    7069 
     
    7978== Macros == 
    8079 
    81 There are a macro ![screenshot:<screenshot_id>] for screenshots referencing and embending. Expamples of usage is here: 
     80There is a macro {{{[screenshot:<screenshot_id>]}}} for screenshots referencing. 
     81 
     82For screenshot embending in wiki page use {{{[[Screenshot(<screenshot_id>, [<attribute>=<value>, ...])]]}}}. First mandatory argument is ID of the screenshot. Number or image attributes 
     83can be specified next. This is a list of them: 
     84 
     85 * {{{align}}} - Specifies image alignment in wiki page. Possible values are: 
     86   {{{left}}}, {{{right}}} and {{{center}}}. 
     87 * {{{alt}}} - Alternative description of image. 
     88 * {{{border}}} - Sets image border of specified width in pixels. 
     89 * {{{class}}} - Class of image for CSS styling. 
     90 * {{{description}}} - Brief description under the image. Accepts several 
     91   variables (see bellow). 
     92 * {{{format}}} - Format of returned image or screenshot behind link. 
     93 * {{{height}}} - Height of image. Set to 0 if you want original image height. 
     94 * {{{id}}} - ID of image for CSS styling. 
     95 * {{{longdesc}}} - Detailed description of image. 
     96 * {{{title}}} - Title of image. 
     97 * {{{usemap}}} - Image map for clickable images. 
     98 * {{{width}}} - Width of image. Set to 0 if you want original image width. 
     99 
     100Attribute {{{description}}} displays several variables: 
     101 
     102 * {{{$id}}} - ID of image. 
     103 * {{{$name}}} - Name of image. 
     104 * {{{$author}}} - User name who uploaded image. 
     105 * {{{$time}}} - Time when image was uploaded. 
     106 * {{{$file}}} - File name of image. 
     107 * {{{$description}}} - Detailed description of image. 
     108 * {{{$width}}} - Original width of image. 
     109 * {{{$height}}} - Original height of image. 
     110 
     111Example: 
    82112 
    83113{{{ 
    84 See fig [screenshot:1]. 
    85 Take a look at [screenshot:1 screenshot]. 
    86 Screenshot of main window is: [screenshot:1,width=640,height=480]. 
     114 [[Screenshot(2,width=400,height=300,description=The $name by $author: $description,align=left)]] 
    87115}}} 
    88116 
    89 Possible attributes are: 
     117== Notes == 
    90118 
    91  * {{{align}}} - Specifies image alignment in wiki page. 
    92  * {{{border}}} - Sets image border of specified size. 
    93  * {{{width}}} - Width of image, embeds image if specified. Set to 0 if you want original image width. 
    94  * {{{height}}} - Height of image, embeds image if specified. Set to 0 if you want original image height. 
    95  * {{{alt}}} - Alternative description of image. 
    96  * {{{title}}} - Title of image. 
    97  * {{{longdesc}}} - Detailed description of image. 
    98  * {{{class}}} - Class of image for CSS styling. 
    99  * {{{id}}} - ID of image for CSS styling. 
    100  * {{{usemap}}} - Image map for clickable images. 
    101  * {{{format}}} - Format of returned image or screenshot behind link. 
     119Previous revisions used space separated list of values in {{{trac.ini}}} configuration options. Now it uses comma separated list so change this to prevent inconveniences. 
    102120 
    103121== Feedback ==