Changes between Version 23 and Version 24 of TicketBoxMacro
- Timestamp:
- Apr 2, 2015, 1:06:44 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TicketBoxMacro
v23 v24 1 1 [[PageOutline(2-5,Contents,pullout)]] 2 = Ticket list in a box on the wiki page =3 2 4 == News == 5 This macro is unified for several trac versions (0.9, 0.10, 0.11, 0.12dev) 6 since 2008-07-31 (r4088). 7 Note that repository structure is changed and the version directory 8 are no longer exist. 9 Get latest source from [http://trac-hacks.org/svn/ticketboxmacro/TicketBox.py here]. 3 = Ticket list in a box on the wiki page 10 4 11 == Description == 12 This macro displays the list of ticket numbers in a box on the right 13 side of the page compactly. 5 == News 6 This macro is unified for several Trac versions (0.9, 0.10, 0.11, 0.12dev) since 2008-07-31 (r4088). 7 Note that the repository structure has changed and the version directory does no longer exist. 8 Get the latest source from [http://trac-hacks.org/svn/ticketboxmacro/TicketBox.py here]. 9 10 == Description 11 12 This macro displays the list of ticket numbers in a box on the right side of the page compactly. 14 13 You can specify the tickets explicitly or use the result of reporting. 15 14 The tickets will be displayed as sorted and uniq'ed. 16 15 An example image is shown on the right of this page. 17 16 18 Note: 'query' format is not yet supported.17 '''Note''': 'query' format is not yet supported. 19 18 20 19 {{{ … … 24 23 }}} 25 24 26 == Bugs/Feature Requests ==25 == Bugs/Feature Requests 27 26 28 27 Existing bugs and feature requests for TicketBoxMacro are [query:status!=closed&component=TicketBoxMacro&order=priority here]. … … 31 30 [/newticket?component=TicketBoxMacro&owner=gotoh new ticket]. 32 31 33 == Download and Source == 32 [[TicketQuery(component=TicketBoxMacro&group=type,format=progress)]] 33 34 == Download and Source 34 35 35 36 * [source:ticketboxmacro Browse with Trac]. 36 * checkout with subversion from [/svn/ticketboxmacro repository] (for any trac versions)37 * checkout with subversion from [/svn/ticketboxmacro repository] for any Trac version. 37 38 38 [[BR]](2008/07/31 : Files for each trac versions are unified.) 39 [[BR]](2008/03/28 : [source:ticketboxmacro/0.8/#2848 TicketBoxMacro for 0.8] is obsoleted.) 39 Notes: 40 * 2008/07/31 : Files for each trac versions are unified. 41 * 2008/03/28 : [source:ticketboxmacro/0.8/#2848 TicketBoxMacro for 0.8] is obsoleted. 40 42 41 == Install ==43 == Installation 42 44 43 For trac 0.10 or before, copy `TicketBox.py` to `wiki-macros` directory 44 of your trac environment or system wide `wiki-macros` directory. 45 For Trac 0.10 or before, copy `TicketBox.py` to `wiki-macros` directory of your Trac environment or system wide `wiki-macros` directory. 45 46 46 For trac 0.11 or later, copy `TicketBox.py` to `plugins` directory of your 47 trac environment (no need enable this plugin explicitly). 48 Or copy it to system wide `plugins` directory then enable the 49 `TicketBox` plugin via admin page. 47 For Trac 0.11 or later, copy `TicketBox.py` to `plugins` directory of your Trac environment and there is no need enable this plugin explicitly. 48 Or copy it to system wide `plugins` directory then enable the `TicketBox` plugin via the admin page. 50 49 51 == Basic Usage ==50 == Usage 52 51 53 52 These example shows the simple list of tickets by specifiying ticket numbers. … … 58 57 }}} 59 58 60 These examples list sthe tickets from the report result.59 These examples list the tickets from the report result. 61 60 The third example uses the dynamic variable 'COMPONENT'. 62 The special variable 'USER' is always available and it is 63 your login name (or 'anonymous' if not logged in). 61 The special variable 'USER' is always available and it is your login name, or 'anonymous' if not logged in. 64 62 You can override the variable 'USER' like in the fourth example. 65 63 {{{ … … 70 68 }}} 71 69 72 If field name of ticket id is not 'ticket' in report report definition, 73 You can specify by `ticket=xxx`: 70 If field name of ticket id is not 'ticket' in report report definition, you can specify by `ticket=xxx`: 74 71 {{{ 75 72 [[Ticketbox({20},ticket=id)]] … … 77 74 78 75 TracQuery style of query string can be used. 79 And it aslo can be used in report defintion (starting with `query:`),76 And it can also be used in report defintion, starting with `query:`: 80 77 {{{ 81 78 [[TicketBox([query:status=new])]] … … 93 90 }}} 94 91 95 == Display Options ==92 == Display Options 96 93 97 94 You can specify the size of the box: … … 103 100 104 101 You can specify the title. 105 The value should be surrounded by single or double quote. 106 You can also embed the number of tickets by '%d' in title string like 107 third example: 102 The value should be surrounded by a single quote or a double quote. 103 You can also embed the number of tickets by '%d' in title string like in the third example: 108 104 {{{ 109 105 [[TicketBox('Related Tickets',#1,#2)]] … … 114 110 If you do not want the box to be floating, use the `inline` keyword. 115 111 The box is placed inline with the wiki text. 116 If you want the ticket's summary to be displayed, use the `summary` keyword .112 If you want the ticket's summary to be displayed, use the `summary` keyword: 117 113 {{{ 118 114 [[TicketBox({1},inline)]] … … 121 117 122 118 `nowrap` forces no wrap of line. It is useful with summary option. 123 If this option is specified, line length may exceeds specified `width` .119 If this option is specified, line length may exceeds specified `width`: 124 120 {{{ 125 121 [[TicketBox({1},summary,nowrap)]] 126 122 }}} 127 123 128 Text color, background color, border line color and float position 129 can be specified: 124 Text color, background color, border line color and float position can be specified: 130 125 {{{ 131 126 [[TicketBox({1},float=left,color=green,background=transparent,border-color=red)]] 132 127 }}} 133 128 134 == Recent Changes ==129 == Recent Changes 135 130 136 131 [[ChangeLog(ticketboxmacro,3)]] 137 132 138 == Author/Contributors ==133 == Author/Contributors 139 134 140 135 '''Author:''' [wiki:gotoh gotoh] [[BR]] 141 '''Maintainer:''' [ wiki:gotoh gotoh] [[BR]]136 '''Maintainer:''' [[Maintainer]] [[BR]] 142 137 '''Contributors:'''