Changes between Version 43 and Version 44 of WikiTicketCalendarMacro


Ignore:
Timestamp:
Jul 18, 2010 2:55:34 AM (4 years ago)
Author:
hasienda
Comment:

add hints on new keyword arguments

Legend:

Unmodified
Added
Removed
Modified
  • WikiTicketCalendarMacro

    v43 v44  
    7979}}} 
    8080 
     81== Extended configuration == 
     82The 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): 
     83{{{ 
     84nav = true - navigation link switch, same as 'showbuttens' 
     85wikipage="%Y-%m-%d" - same as 'wiki_page_format' 
     86template="" - same as 'wiki_page_template' 
     87query="id!=0" 
     88}}} 
     89The ''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. 
     90 
     91The plugin optionally makes use of an own configuration section, that could be placed into 'trac.ini' as follows: 
     92{{{ 
     93[wikiticketcalendar] 
     94ticket.due_field.name = due_close 
     95ticket.due_field.format = %y-%m-%d 
     96ticket.due_field.utcoffset = 0 
     97}}} 
     98 
     99Again these are the implicit default values. A useful alternative configuration would look like 
     100{{{ 
     101[wikiticketcalendar] 
     102ticket.due_field.name = due_date 
     103ticket.due_field.format = ts 
     104ticket.due_field.utcoffset = 2 
     105}}} 
     106to 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]). 
     107 
    81108== About i18n/l10n support == 
    82 The development version of this plugin is prepared for localization (tooltip customization in calendar navigation).[[BR]] 
     109The 0.12 branch of this plugin is prepared for localization (tooltip customization in calendar navigation).[[BR]] 
    83110But English message texts are still the (POSIX) default. If this isn't your preferred language, you can 
    84111 1. look, if it's already available from the [TracPluginTranslation Trac plugin l10n project] at [http://www.transifex.net/projects/p/Trac_Plugin-L10N/c/wikiticketcalendar Transifex] or 
     
    96123{{{ 
    97124cd wikiticketcalendarmacro 
    98 python ./setup.py egg_info 
    99125python ./setup.py compile_catalog -f 
    100126python ./setup.py bdist_egg 
    101127}}}  
    102 If you missed the 3rd step, this will be taken care for before the build step 4.[[BR]] 
     128But if you missed the 2rd step, this will be taken care for before the build step 3.[[BR]] 
    103129To exclude translations marked as `# fuzzy` by the translator, you'll want to omit the extra `-f` argument to message catalog compilation. 
    104130In fact this is the default for automatic compilation before the build.