Changes between Version 13 and Version 14 of TicketBoxMacro

Timestamp:

Mar 28, 2008, 1:03:29 PM (16 years ago)

Author:

Shun-ichi Goto

Comment:

Add undescribed options and update for readability.

TicketBoxMacro

@@ -7 +7 @@
  title="sample image" style="float:right"/>
 }}}
-Display list of ticket numbers in a box on the right side of the page.
-The purpose of this macro is show related tickets compactly.
-You can list tickets explicitly or specify a report that generates them (to do the same with [TracQuery queries] instead of [TracReports reports], use the [trac:TicketQuery TicketQuery macro]). Tickets will be displayed as sorted and uniq'ed.
-An example image is shown op the right of this page.
+This macro displays the list of ticket numbers in a box on the right
+side of the page compactly.
+You can specify the tickets explicitly or use the result of reporting.
+The tickets will be displayed as sorted and uniq'ed.
+An example image is shown on the right of this page.
+
+Note: 'query' format is not yet supported.
 
 == Bugs/Feature Requests == 
@@ -45 +48 @@
 == Example ==
 
-Simple list of tickets by specifiying ticket numbers.
+These example shows the simple list of tickets by specifiying ticket numbers.
 '#' character can be omitted:
 {{{
@@ -52 +55 @@
 }}}
 
-List tickets expanded from the report result.
-Third example uses dynamic variable.
-The special variable 'USER' can be specified. If not specified,
-login name (or anonymous) is used:
+These examples lists the tickets from the report result.
+Second examplesh uses dynamic variable 'COMPONENT'.
+The special variable 'USER' is always avaiable and it is
+your login name (or 'anonymous' if not logged in).
+You can override the variable 'USER' like third example.
 {{{
 [[TicketBox({1})]]
@@ -63 +67 @@
 }}}
 
-Combination of above is allowed. The tickets are listed as sorted and uniq'ed:
+The combination of above is allowed.
+The tickets are listed as sorted and uniq'ed:
 {{{
-[[TicketBox({1),#50,{2},100)]]
+[[TicketBox({1},#50,{2},100)]]
 }}}
 
-Specifying a size of the box:
+You can specify the size of the box:
 {{{
 [[TicketBox(500pt,{1})]]
@@ -75 +80 @@
 }}}
 
-Specifying a title of the box.
-single and double quoted string are allowed.
-If '%d' in title string will be replaced with count of tickets:
+You can specify the title.
+The value should be surrounded by single or double quote.
+You can also embed the number of tickets by '%d' in title string like
+third example:
 {{{
 [[TicketBox('Related Tickets',#1,#2)]]
 [[TicketBox("Related Tickets",#1,#2)]]
 [[TicketBox("There are %d tickets",{1})]]
+}}}
+
+If you do not make box floating, put the 'inline' argument.
+The box is placed in the text.
+If you want to show with summary string, put 'summary' argument:
+{{{
+[[TicketBox({1},inline)]]
+[[TicketBox({1},summary,inline)]]
 }}}