wiki:TicketBoxMacro

Version 13 (modified by gotoh, 6 years ago) (diff)

describe to obsolete supporting for trac 0.8.

Ticket list in a box on the wiki page

Description

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 queries instead of reports, use the TicketQuery macro). Tickets will be displayed as sorted and uniq'ed. An example image is shown op the right of this page.

Bugs/Feature Requests

Existing bugs and feature requests for TicketBoxMacro are here.

If you have any issues, create a new ticket.

Download

TicketBoxMacro for 0.9.
TicketBoxMacro for 0.10.
TicketBoxMacro for 0.11.

(2008/03/28 : TicketBoxMacro for 0.8 is obsoleted.)

Source

You can check out the source for TicketBoxMacro from Subversion at http://trac-hacks.org/svn/ticketboxmacro.

Install

For trac 0.10 or before, copy TicketBox.py to wiki-macros directory of your trac environment or system wide wiki-macros directory.

For trac 0.11, copy TicketBox.py to plugins directory of your trac environment (no need enable this plugin explicitly). Or copy it to system wide plugins directory then enable the TicketBox plugin via admin page.

Example

Simple list of tickets by specifiying ticket numbers. '#' character can be omitted:

[[TicketBox(#1,#7,#31)]]
[[TicketBox(1,7,31)]]

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:

[[TicketBox({1})]]
[[TicketBox([report:1])]]
[[TicketBox([report:9?COMPONENT=TicketBox])]]
[[TicketBox([report:9?USER=foo])]]

Combination of above is allowed. The tickets are listed as sorted and uniq'ed:

[[TicketBox({1),#50,{2},100)]]

Specifying a size of the box:

[[TicketBox(500pt,{1})]]
[[TicketBox(200px,{1})]]
[[TicketBox(25%,{1})]]

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:

[[TicketBox('Related Tickets',#1,#2)]]
[[TicketBox("Related Tickets",#1,#2)]]
[[TicketBox("There are %d tickets",{1})]]

Author/Contributors

Author: gotoh
Contributors:

TagIt(macro,gotoh,example,0.9,0.10,0.11)?

[7516] by gotoh on 2010-02-09 02:38:57
Set documentation string of macro.
Now you can see macro description in WikiMacros page.
close #6591.
[7508] by gotoh on 2010-02-08 08:24:14
Fix to work with trac 0.12dev.
[7507] by gotoh on 2010-02-08 07:42:07
Correct plugin info introduced in last commit r7506. (#6562)
Also use the page on TracHacks as home page URL.
[7506] by gotoh on 2010-02-08 03:52:32
Add plugin module info supported by Trac 0.12.
close #6562.
[5658] by gotoh on 2009-05-05 08:54:28
Add new directive 'inline_total' to make simple total number text inline.
This feature is a sub request in #1929.