Changes between Version 61 and Version 62 of WikiTicketCalendarMacro

Timestamp:

Jul 21, 2012, 9:26:44 PM (12 years ago)

Author:

Steffen Hoffmann

Comment:

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

WikiTicketCalendarMacro

@@ -6 +6 @@
 
 [[Image(wikiticketcalendar_screenshot.gif)]]
+
+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.
 
 == Usage ==
@@ -37 +42 @@
 || `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" ||
 || `cdate`|| || (1) show ticket created / open dates [1,0] || 1 || cdate=1 ||
-|| `template`|| ||wiki template tried to create new page  || "" || base="" ||
+|| `base`|| ||wiki template tried to create new page  || "" || base="" ||
 || `query`|| ||evaluates a valid TracQuery expression based on any ticket field including multiple expressions grouped by 'and' and 'or' || || query="id!=0" ||
 || `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 ||
@@ -60 +65 @@
 '''Notes''':
 
-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:
+1. All maintained versions of this macro 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:
 {{{
     [[WikiTicketCalendar(wiki=Meeting-%Y-%m-%d)]]
 }}}
-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.
+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 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,
+or you could choose to display tickets only with high/highest priority, tickets with some special content in a custom field, etc.
 
 
 == Install ==
 
-Generic installation guidelines and troubleshooting can be found at TracPlugins.
+Generic guidelines on installation and troubleshooting can be found at TracPlugins.
 
 Steps to install and configure this plugin are:
@@ -81 +88 @@
  1. '''Enable'''
     * Update TracIni file (`..../trac.ini`) with:
-      * Trac <= 0.11
-{{{
-    [components]
-    WikiTicketCalendarMacro.* = enabled
-}}}
-      * Trac >= ''0.12'' and ''trunk'' branch with i18n support (have a different code structure due to packaging)
-{{{
-    [components]
-    wikiticketcalendar.* = enabled
-}}}
-      Note: See i18n/l10n section for related [#Abouti18nl10nsupport hints on egg creation]. 
+{{{
+#!ini
+[components]
+wikicalendar.* = enabled
+}}}
+     This enables both, this macro as well as the WikiCalendarMacro.
+     Both macros are bundled in `wikicalendar-2.0.0` and later. For historic versions the old instructions are preserved [#Historicnotes below]:
 
  1. '''Configure'''
     * The plugin optionally makes use of an own configuration section, that could be placed into 'trac.ini' as follows:
 {{{
-    [wikiticketcalendar]
-    ticket.due_field.name = due_close
-    ticket.due_field.format = %y-%m-%d
+[wikiticketcalendar]
+ticket.due_field.name = due_close
+ticket.due_field.format = %y-%m-%d
 }}}
     * Note: these are the implicit default values to give backwards compatible behaviour.
@@ -149 +152 @@
 Again, for more details see the [t:wiki:CookBook/PluginL10N#Compileanduseit l10n cookbook page for Trac plugins].
 
-== Bugs/Feature Requests ==
+
+== Bug Reports ==
 
 Get it, enjoy and report back, please. Comments welcome.
@@ -159 +163 @@
 [/newticket?component=WikiTicketCalendarMacro&owner=hasienda new ticket].
 
+Make sure to send feature requests for the macro bundle only (see WikiCalendarMacro).
+
 [[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)]]
 
 == Source & Download ==
+For the latest code see WikiCalendarMacro. The information below is historic by now.
 
 You can:
@@ -179 +186 @@
 
 
-=== Recent Changes ===
-
-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.
+=== Historic notes ===
+These are the old instructions for enabling historic versions of the !WikiTicketCalendarMacro:
+{{{
+[components]
+WikiTicketCalendarMacro.* = enabled
+}}}
+ for Trac <= 0.11
+
+{{{
+[components]
+wikiticketcalendar.* = enabled
+}}}
+ for Trac >= ''0.12'' and ''trunk'' branch with i18n support (have a different code structure due to packaging)
+
 
 == Author/Contributors ==