Changes between Version 16 and Version 17 of ScreenshotsPlugin

Timestamp:

Mar 5, 2008, 12:43:24 PM (16 years ago)

Author:

Radek Bartoň

Comment:

trac.ini and macro documentation updated.

ScreenshotsPlugin

@@ -34 +34 @@
 metanav_title =
 path = /var/lib/trac/screenshots
-ext = jpg png
-formats = raw html jpg png
+ext = jpg,png
+formats = raw,html,jpg,png
 default_format = html
 default_components = none
@@ -66 +66 @@
 }}}
 
-
 == Permissions ==
 
@@ -79 +78 @@
 == Macros ==
 
-There are a macro ![screenshot:<screenshot_id>] for screenshots referencing and embending. Expamples of usage is here:
+There is a macro {{{[screenshot:<screenshot_id>]}}} for screenshots referencing.
+
+For screenshot embending in wiki page use {{{[[Screenshot(<screenshot_id>, [<attribute>=<value>, ...])]]}}}. First mandatory argument is ID of the screenshot. Number or image attributes
+can be specified next. This is a list of them:
+
+ * {{{align}}} - Specifies image alignment in wiki page. Possible values are:
+   {{{left}}}, {{{right}}} and {{{center}}}.
+ * {{{alt}}} - Alternative description of image.
+ * {{{border}}} - Sets image border of specified width in pixels.
+ * {{{class}}} - Class of image for CSS styling.
+ * {{{description}}} - Brief description under the image. Accepts several
+   variables (see bellow).
+ * {{{format}}} - Format of returned image or screenshot behind link.
+ * {{{height}}} - Height of image. Set to 0 if you want original image height.
+ * {{{id}}} - ID of image for CSS styling.
+ * {{{longdesc}}} - Detailed description of image.
+ * {{{title}}} - Title of image.
+ * {{{usemap}}} - Image map for clickable images.
+ * {{{width}}} - Width of image. Set to 0 if you want original image width.
+
+Attribute {{{description}}} displays several variables:
+
+ * {{{$id}}} - ID of image.
+ * {{{$name}}} - Name of image.
+ * {{{$author}}} - User name who uploaded image.
+ * {{{$time}}} - Time when image was uploaded.
+ * {{{$file}}} - File name of image.
+ * {{{$description}}} - Detailed description of image.
+ * {{{$width}}} - Original width of image.
+ * {{{$height}}} - Original height of image.
+
+Example:
 
 {{{
-See fig [screenshot:1].
-Take a look at [screenshot:1 screenshot].
-Screenshot of main window is: [screenshot:1,width=640,height=480].
+ [[Screenshot(2,width=400,height=300,description=The $name by $author: $description,align=left)]]
 }}}
 
-Possible attributes are:
+== Notes ==
 
- * {{{align}}} - Specifies image alignment in wiki page.
- * {{{border}}} - Sets image border of specified size.
- * {{{width}}} - Width of image, embeds image if specified. Set to 0 if you want original image width.
- * {{{height}}} - Height of image, embeds image if specified. Set to 0 if you want original image height.
- * {{{alt}}} - Alternative description of image.
- * {{{title}}} - Title of image.
- * {{{longdesc}}} - Detailed description of image.
- * {{{class}}} - Class of image for CSS styling.
- * {{{id}}} - ID of image for CSS styling.
- * {{{usemap}}} - Image map for clickable images.
- * {{{format}}} - Format of returned image or screenshot behind link.
+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.
 
 == Feedback ==