Changes between Version 25 and Version 26 of TicketBoxMacro


Ignore:
Timestamp:
Nov 13, 2015, 8:56:32 AM (8 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • TicketBoxMacro

    v25 v26  
    2020== Bugs/Feature Requests
    2121
    22 Existing bugs and feature requests for TicketBoxMacro are [query:status!=closed&component=TicketBoxMacro&order=priority here].
     22Existing bugs and feature requests for TicketBoxMacro are
     23[report:9?COMPONENT=TicketBoxMacro here].
    2324
    2425If you have any issues, create a
     
    2930== Download
    3031
    31 Download the zipped source from [download:ticketboxmacro here].
     32Download the zipped source from [export:ticketboxmacro here].
    3233
    3334== Source
    3435
    35 You can check out TicketBoxMacro from [http://trac-hacks.org/svn/ticketboxmacro here] using Subversion, or [source:ticketboxmacro browse the source] with Trac.
     36You can check out TicketBoxMacro from [/svn/ticketboxmacro here] using Subversion, or [source:ticketboxmacro browse the source] with Trac.
    3637
    3738== Installation
     
    4041
    4142For Trac 0.11 or later, copy `TicketBox.py` to `plugins` directory of your Trac environment and there is no need enable this plugin explicitly.
    42 Or copy it to system wide `plugins` directory then enable the `TicketBox` plugin via the admin page.
     43Or copy it to system wide `plugins` directory, then enable the `TicketBox` plugin via the admin page.
    4344
    4445== Usage
     
    4748'#' character can be omitted:
    4849{{{
    49 [[TicketBox(#1,#7,#31)]]
    50 [[TicketBox(1,7,31)]]
     50[[TicketBox(#1, #7, #31)]]
     51[[TicketBox(1, 7, 31)]]
    5152}}}
    5253
     
    6465If field name of ticket id is not 'ticket' in report report definition, you can specify by `ticket=xxx`:
    6566{{{
    66 [[Ticketbox({20},ticket=id)]]
     67[[Ticketbox({20}, ticket=id)]]
    6768}}}
    6869
     
    7374}}}
    7475
    75 The combination of above is allowed.
     76The combination of the above is allowed.
    7677The tickets are listed as sorted and uniq'ed:
    7778{{{
    78 [[TicketBox({1},#50,{2},[query:keywords~=important],100)]]
     79[[TicketBox({1}, #50, {2}, [query:keywords~=important], 100)]]
    7980}}}
    8081
    81 If `nosort` option is specified, tickets are listed without sorting:
     82If `nosort` option is specified, then the tickets are listed without sorting:
    8283{{{
    83 [[TicketBox(3,2,1,{1},nosort)]]
     84[[TicketBox(3, 2, 1, {1}, nosort)]]
    8485}}}
    8586
    86 == Display Options
     87=== Display Options
    8788
    8889You can specify the size of the box:
    8990{{{
    90 [[TicketBox(500pt,{1})]]
    91 [[TicketBox(200px,{1})]]
    92 [[TicketBox(25%,{1})]]
     91[[TicketBox(500pt, {1})]]
     92[[TicketBox(200px, {1})]]
     93[[TicketBox(25%, {1})]]
    9394}}}
    9495
    9596You can specify the title.
    96 The value should be surrounded by a single quote or a double quote.
     97The value should be surrounded by a single quote (') or a double quote (").
    9798You can also embed the number of tickets by '%d' in title string like in the third example:
    9899{{{
    99 [[TicketBox('Related Tickets',#1,#2)]]
    100 [[TicketBox("Related Tickets",#1,#2)]]
    101 [[TicketBox("There are %d tickets",{1})]]
     100[[TicketBox('Related Tickets', #1, #2)]]
     101[[TicketBox("Related Tickets", #1, #2)]]
     102[[TicketBox("There are %d tickets", {1})]]
    102103}}}
    103104
     
    106107If you want the ticket's summary to be displayed, use the `summary` keyword:
    107108{{{
    108 [[TicketBox({1},inline)]]
    109 [[TicketBox({1},summary,inline)]]
     109[[TicketBox({1}, inline)]]
     110[[TicketBox({1}, summary, inline)]]
    110111}}}
    111112
    112 `nowrap` forces no wrap of line. It is useful with summary option.
     113The option `nowrap` forces the line not to wrap around the screen. It is useful with summary option.
    113114If this option is specified, line length may exceeds specified `width`:
    114115{{{
    115 [[TicketBox({1},summary,nowrap)]]
     116[[TicketBox({1}, summary, nowrap)]]
    116117}}}
    117118
    118119Text color, background color, border line color and float position can be specified:
    119120{{{
    120 [[TicketBox({1},float=left,color=green,background=transparent,border-color=red)]]
     121[[TicketBox({1}, float=left, color=green, background=transparent, border-color=red)]]
    121122}}}
    122123