Changes between Version 13 and Version 14 of TicketBoxMacro


Ignore:
Timestamp:
Mar 28, 2008 2:03:29 PM (6 years ago)
Author:
gotoh
Comment:

Add undescribed options and update for readability.

Legend:

Unmodified
Added
Removed
Modified
  • TicketBoxMacro

    v13 v14  
    77 title="sample image" style="float:right"/> 
    88}}} 
    9 Display list of ticket numbers in a box on the right side of the page. 
    10 The purpose of this macro is show related tickets compactly. 
    11 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. 
    12 An example image is shown op the right of this page. 
     9This macro displays the list of ticket numbers in a box on the right 
     10side of the page compactly. 
     11You can specify the tickets explicitly or use the result of reporting. 
     12The tickets will be displayed as sorted and uniq'ed. 
     13An example image is shown on the right of this page. 
     14 
     15Note: 'query' format is not yet supported. 
    1316 
    1417== Bugs/Feature Requests ==  
     
    4548== Example == 
    4649 
    47 Simple list of tickets by specifiying ticket numbers. 
     50These example shows the simple list of tickets by specifiying ticket numbers. 
    4851'#' character can be omitted: 
    4952{{{ 
     
    5255}}} 
    5356 
    54 List tickets expanded from the report result. 
    55 Third example uses dynamic variable. 
    56 The special variable 'USER' can be specified. If not specified, 
    57 login name (or anonymous) is used: 
     57These examples lists the tickets from the report result. 
     58Second examplesh uses dynamic variable 'COMPONENT'. 
     59The special variable 'USER' is always avaiable and it is 
     60your login name (or 'anonymous' if not logged in). 
     61You can override the variable 'USER' like third example. 
    5862{{{ 
    5963[[TicketBox({1})]] 
     
    6367}}} 
    6468 
    65 Combination of above is allowed. The tickets are listed as sorted and uniq'ed: 
     69The combination of above is allowed. 
     70The tickets are listed as sorted and uniq'ed: 
    6671{{{ 
    67 [[TicketBox({1),#50,{2},100)]] 
     72[[TicketBox({1},#50,{2},100)]] 
    6873}}} 
    6974 
    70 Specifying a size of the box: 
     75You can specify the size of the box: 
    7176{{{ 
    7277[[TicketBox(500pt,{1})]] 
     
    7580}}} 
    7681 
    77 Specifying a title of the box. 
    78 single and double quoted string are allowed. 
    79 If '%d' in title string will be replaced with count of tickets: 
     82You can specify the title. 
     83The value should be surrounded by single or double quote. 
     84You can also embed the number of tickets by '%d' in title string like 
     85third example: 
    8086{{{ 
    8187[[TicketBox('Related Tickets',#1,#2)]] 
    8288[[TicketBox("Related Tickets",#1,#2)]] 
    8389[[TicketBox("There are %d tickets",{1})]] 
     90}}} 
     91 
     92If you do not make box floating, put the 'inline' argument. 
     93The box is placed in the text. 
     94If you want to show with summary string, put 'summary' argument: 
     95{{{ 
     96[[TicketBox({1},inline)]] 
     97[[TicketBox({1},summary,inline)]] 
    8498}}} 
    8599