Changes between Version 44 and Version 45 of WikiTicketCalendarMacro


Ignore:
Timestamp:
Jul 19, 2010 12:41:23 AM (4 years ago)
Author:
hasienda
Comment:

refined extended config section

Legend:

Unmodified
Added
Removed
Modified
  • WikiTicketCalendarMacro

    v44 v45  
    7979}}} 
    8080 
    81 == Extended configuration == 
    82 The development version of this plugin addes support for keyword arguments. This could make macro invocations more readable and maybe even shorter than before, as long as you largely stick to the defaults and just want to change one or two values. Supported keywords are (with default values here): 
     81== Advanced configuration == 
     82The development version of this plugin has added support for keyword arguments. This could make macro invocations more readable and maybe even shorter than before, as long as you largely stick to the defaults and just want to change one or two values. So i.e. the 3rd example from above could be rewritten now as: 
    8383{{{ 
    84 nav = true - navigation link switch, same as 'showbuttens' 
    85 wikipage="%Y-%m-%d" - same as 'wiki_page_format' 
    86 template="" - same as 'wiki_page_template' 
    87 query="id!=0" 
     84    [[WikiTicketCalendar(wiki=Meeting-%Y-%m-%d)]] 
    8885}}} 
    89 The ''query'' keyword actually supports any expression supported by TracQuery. This is the single new ticket selection logic and can use custom field values as well as expressions chained by AND (OR since 0.12). An invalid expression was chosen on purpose to select and show all tickets by default. 
     86 
     87Supported keywords are (with default values here): 
     88{{{ 
     89nav=1             same as 'showbuttens' 
     90wiki="%Y-%m-%d"   same as 'wiki_page_format', supports any expression that strftime can handle 
     91cdate=1           same as 'show_ticket_open_dates' 
     92draft=""          same as 'wiki_page_template' 
     93query="id!=0"     see below 
     94}}} 
     95The ''query'' keyword supports any expression supported by TracQuery. This is the single new ticket selection logic that can use custom field values as well as expressions chained by AND (OR since 0.12 only). An invalid expression was chosen on purpose to select and show all tickets by default. Use your own query expression to create per-developer or per-component ticket calendars, or you could choose to display tickets only with high/highest priority, tickets with some special content in a custom field, etc. 
    9096 
    9197The plugin optionally makes use of an own configuration section, that could be placed into 'trac.ini' as follows: 
     
    96102ticket.due_field.utcoffset = 0 
    97103}}} 
     104Again these are the implicit default values to give backwards compatible behaviour. 
    98105 
    99 Again these are the implicit default values. A useful alternative configuration would look like 
     106Real configuration examples: 
     107{{{ 
     108[wikiticketcalendar] 
     109ticket.due_field.name = due-date 
     110ticket.due_field.format = %m/%d/%Y 
     111ticket.due_field.utcoffset = -5 
     112}}} 
     113 * account for US east coast time 
     114 * for a custom due date field named 'due-date' that holds 
     115 * US style date with 4-digit year 
     116 
    100117{{{ 
    101118[wikiticketcalendar] 
     
    104121ticket.due_field.utcoffset = 2 
    105122}}} 
    106 to support European time zone offset for a custom due date field named 'due_date', that holds true POSIX microsecond timestamps (see: [t:wiki:TracDev/Proposals/TracTicketsCustomTimeFields custom time fields proposal]). 
     123 * support European time zone offset 
     124 * for a custom due date field named 'due_date' that holds 
     125 * true POSIX microsecond timestamps (see: [t:wiki:TracDev/Proposals/TracTicketsCustomTimeFields custom time fields proposal]) 
    107126 
    108127== About i18n/l10n support ==