Changes between Version 61 and Version 62 of WikiTicketCalendarMacro


Ignore:
Timestamp:
Jul 21, 2012 11:26:44 PM (2 years ago)
Author:
hasienda
Comment:

correct argument name for template pre-selection and start to move historic notes

Legend:

Unmodified
Added
Removed
Modified
  • WikiTicketCalendarMacro

    v61 v62  
    66 
    77[[Image(wikiticketcalendar_screenshot.gif)]] 
     8 
     9Development of the single-file macros is discontinued. 
     10Code has been merged with WikiCalendarMacro for joined upstream development. 
     11Make sure to change over to the packaged plugin code hosted within the 
     12[source:/wikicalendarmacro /wikicalendarmacro] domain to receive latest improvements and bug fixes. 
    813 
    914== Usage == 
     
    3742|| `wiki`|| || strftime format for wiki pages to display as link (if exist, otherwise links to a create page) '*' for default. Supports any expression that strftime can handle  || "%Y-%m-%d" || wiki="%Y-%m-%d" || 
    3843|| `cdate`|| || (1) show ticket created / open dates [1,0] || 1 || cdate=1 || 
    39 || `template`|| ||wiki template tried to create new page  || "" || base="" || 
     44|| `base`|| ||wiki template tried to create new page  || "" || base="" || 
    4045|| `query`|| ||evaluates a valid TracQuery expression based on any ticket field including multiple expressions grouped by 'and' and 'or' || || query="id!=0" || 
    4146|| `short`|| ||total ticket count per day, that'll have ticket list display condensed to just ticket no., 0 = never condense list. This feature looks like [attachment:wikiticketcalendar_screenshot_1-2-1.png this] [0,1,...] || 0 || short=0 || 
     
    6065'''Notes''': 
    6166 
    62 1. All maintained versions of this plugin support keyword arguments and mixed use of both - simple and keyword arguments - as well. 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: 
     671. All maintained versions of this macro support keyword arguments and mixed use of both - simple and keyword arguments - as well. 
     68This 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: 
    6369{{{ 
    6470    [[WikiTicketCalendar(wiki=Meeting-%Y-%m-%d)]] 
    6571}}} 
    66 2. The ''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. 
     722. The ''query'' keyword supports any expression supported by TracQuery. This is the single new ticket selection logic that can use custom field values as well for expressions chained by AND (OR since 0.12 only). An always-true 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, 
     73or you could choose to display tickets only with high/highest priority, tickets with some special content in a custom field, etc. 
    6774 
    6875 
    6976== Install == 
    7077 
    71 Generic installation guidelines and troubleshooting can be found at TracPlugins. 
     78Generic guidelines on installation and troubleshooting can be found at TracPlugins. 
    7279 
    7380Steps to install and configure this plugin are: 
     
    8188 1. '''Enable''' 
    8289    * Update TracIni file (`..../trac.ini`) with: 
    83       * Trac <= 0.11 
    84 {{{ 
    85     [components] 
    86     WikiTicketCalendarMacro.* = enabled 
    87 }}} 
    88       * Trac >= ''0.12'' and ''trunk'' branch with i18n support (have a different code structure due to packaging) 
    89 {{{ 
    90     [components] 
    91     wikiticketcalendar.* = enabled 
    92 }}} 
    93       Note: See i18n/l10n section for related [#Abouti18nl10nsupport hints on egg creation].  
     90{{{ 
     91#!ini 
     92[components] 
     93wikicalendar.* = enabled 
     94}}} 
     95     This enables both, this macro as well as the WikiCalendarMacro. 
     96     Both macros are bundled in `wikicalendar-2.0.0` and later. For historic versions the old instructions are preserved [#Historicnotes below]: 
    9497 
    9598 1. '''Configure''' 
    9699    * The plugin optionally makes use of an own configuration section, that could be placed into 'trac.ini' as follows: 
    97100{{{ 
    98     [wikiticketcalendar] 
    99     ticket.due_field.name = due_close 
    100     ticket.due_field.format = %y-%m-%d 
     101[wikiticketcalendar] 
     102ticket.due_field.name = due_close 
     103ticket.due_field.format = %y-%m-%d 
    101104}}} 
    102105    * Note: these are the implicit default values to give backwards compatible behaviour. 
     
    149152Again, for more details see the [t:wiki:CookBook/PluginL10N#Compileanduseit l10n cookbook page for Trac plugins]. 
    150153 
    151 == Bugs/Feature Requests == 
     154 
     155== Bug Reports == 
    152156 
    153157Get it, enjoy and report back, please. Comments welcome. 
     
    159163[/newticket?component=WikiTicketCalendarMacro&owner=hasienda new ticket]. 
    160164 
     165Make sure to send feature requests for the macro bundle only (see WikiCalendarMacro). 
     166 
    161167[[Poll(What do you think of the WikiTicketCalendarMacro?; Great; Useful; Somewhat useful, but could be better; Useless; Horrible; Don't care/don't need such stuff)]] 
    162168 
    163169== Source & Download == 
     170For the latest code see WikiCalendarMacro. The information below is historic by now. 
    164171 
    165172You can: 
     
    179186 
    180187 
    181 === Recent Changes === 
    182  
    183 Development of the single-file macros is discontinued.  Code has been merged with WikiCalendarMacro for joined upstream development.  Make sure to change over to the packaged plugin code hosted within the [source:/wikicalendarmacro /wikicalendarmacro] domain to receive latest improvements and bug fixes. 
     188=== Historic notes === 
     189These are the old instructions for enabling historic versions of the !WikiTicketCalendarMacro: 
     190{{{ 
     191[components] 
     192WikiTicketCalendarMacro.* = enabled 
     193}}} 
     194 for Trac <= 0.11 
     195 
     196{{{ 
     197[components] 
     198wikiticketcalendar.* = enabled 
     199}}} 
     200 for Trac >= ''0.12'' and ''trunk'' branch with i18n support (have a different code structure due to packaging) 
     201 
    184202 
    185203== Author/Contributors ==