Changes between Version 15 and Version 16 of TicketBoxMacro


Ignore:
Timestamp:
Jul 30, 2008 10:48:08 PM (6 years ago)
Author:
gotoh
Comment:

Describe new features in recent version.

Legend:

Unmodified
Added
Removed
Modified
  • TicketBoxMacro

    v15 v16  
    11= Ticket list in a box on the wiki page = 
     2 
     3== News == 
     4This macro is unified for several trac versions (0.9, 0.10, 0.11, 0.12dev) 
     5since 2008-07-31 (r4088). 
     6Note that repository structure is changed and the version directory 
     7are no longer exist. 
     8Get latest source from [http://trac-hacks.org/svn/ticketboxmacro/TicketBox.py here]. 
    29 
    310== Description == 
    411{{{ 
    512#!html 
    6 <img src="http://trac-hacks.org/svn/ticketboxmacro/0.9/TicketBox-image.png" 
     13<img src="http://trac-hacks.org/svn/ticketboxmacro/TicketBox-image.png" 
    714 title="sample image" style="float:right"/> 
    815}}} 
     
    2532 
    2633 * [source:ticketboxmacro Browse with Trac]. 
    27  * checkout with subversion: [/svn/ticketboxmacro/0.11 0.11] - [/svn/ticketboxmacro/0.10 0.10] - [/svn/ticketboxmacro/0.9 0.9] 
     34 * checkout with subversion from [/svn/ticketboxmacro repository] (for any trac versions) 
    2835 
    29 (2008/03/28 : [source:ticketboxmacro/0.8/#2848 TicketBoxMacro for 0.8] is obsoleted.) 
     36[[BR]](2008/07/31 : Files for each trac versions are unified.) 
     37[[BR]](2008/03/28 : [source:ticketboxmacro/0.8/#2848 TicketBoxMacro for 0.8] is obsoleted.) 
    3038 
    3139== Install == 
     
    3442of your trac environment or system wide `wiki-macros` directory. 
    3543 
    36 For trac 0.11, copy `TicketBox.py` to `plugins` directory of your 
     44For trac 0.11 or later, copy `TicketBox.py` to `plugins` directory of your 
    3745trac environment (no need enable this plugin explicitly). 
    3846Or copy it to system wide `plugins` directory then enable the  
    3947`TicketBox` plugin via admin page. 
    4048 
    41 == Example == 
     49== Basic Usage == 
    4250 
    4351These example shows the simple list of tickets by specifiying ticket numbers. 
     
    6068}}} 
    6169 
     70If field name of ticket id is not 'ticket' in report report definition, 
     71You can specify by `ticket=xxx`: 
     72{{{ 
     73[[Ticketbox({20},ticket=id)]] 
     74}}} 
     75 
     76TracQuery style of query string can be used. 
     77And it aslo can be used in report defintion (starting with `query:`), 
     78{{{ 
     79[[TicketBox([query:status=new])]] 
     80}}} 
     81 
    6282The combination of above is allowed. 
    6383The tickets are listed as sorted and uniq'ed: 
    6484{{{ 
    65 [[TicketBox({1},#50,{2},100)]] 
     85[[TicketBox({1},#50,{2},[query:keywords~=important],100)]] 
    6686}}} 
     87 
     88If `nosort` option is specified, tickets are listed without sorting: 
     89{{{ 
     90[[TicketBox(3,2,1,{1},nosort)]] 
     91}}} 
     92 
     93== Displaying == 
    6794 
    6895You can specify the size of the box: 
     
    91118}}} 
    92119 
     120`nowrap` forces no wrap of line. It is usefull with summary option. 
     121If this option is specified, line length may exceeds specified `width`. 
     122{{{ 
     123[[TicketBox({1},summary,nowrap)]] 
     124}}} 
     125 
     126Text color, background color, border line color and float position  
     127can be specified: 
     128{{{ 
     129[[TicketBox({1},float=left,color=green,background=transparent,border-color=red)]] 
     130}}} 
     131 
    93132 
    94133== Author/Contributors == 
     
    97136'''Contributors:''' 
    98137 
    99 [[TagIt(macro,gotoh,example,0.9,0.10,0.11)]] 
     138[[TagIt(macro,gotoh,example,0.9,0.10,0.11,0.12)]] 
    100139[[ChangeLog(ticketboxmacro)]]