[[PageOutline(2-5,Contents,pullout)]] = Calendar view of Milestones and Tickets = == Description == Macro for the Trac Wiki Ticketing system to display Milestones and Tickets in a calendar view. The original version of the macro was hosted [http://macgeek.dyndns.org/software/Trac_WikiTicketCalendar here]. [[Image(wikiticketcalendar_screenshot.png)]][[BR]] screenshot of WikiTicketCalendarMacro 1.1.0 for Trac 0.12 with German localization (calendar header and tooltip) Versions compatible with Trac 0.11, 0.12 and even for old 0.10 are available now, so test, enjoy and report back any issue, please. == Bugs/Feature Requests == Existing bugs and feature requests for WikiTicketCalendarMacro are [query:status!=closed&component=WikiTicketCalendarMacro&order=priority here]. If you have any issues, create a [/newticket?component=WikiTicketCalendarMacro&owner=rjollos new ticket]. == Download == Download the zipped source from [download:wikiticketcalendarmacro here].[[BR]] However, to get the one-file version you could look at and save it with the Trac repository browser: * [browser:wikiticketcalendarmacro/branches/0.10 0.10] depreciated, security concerns unresolved * [browser:wikiticketcalendarmacro/branches/0.11 0.11]/0.12 without i18n ^1^ * [browser:wikiticketcalendarmacro/branches/0.12 0.12] with [#Abouti18nl10nsupport i18n support] ^1^ Note: The 0.11 single-file macro install is somewhat smaller than the Python egg with translations,[[BR]] and there's no visible difference to the genuine 0.12 version, if you don't use localization for Trac 0.12. Historically the macro code was activated for a long time by {{{ [components] WikiTicketCalendarMacro.* = enabled }}} what is still correct for 0.11 branch. New versions from 0.12 branch and trunk with i18n support have a different code structure due to packaging.[[BR]] See i18n/l10n section for an '''[#Abouti18nl10nsupport important hint on egg creation]'''. The statement required for activation has changed as well: {{{ [components] wikiticketcalendar.* = enabled }}} == Source == You can check out WikiTicketCalendarMacro from [http://trac-hacks.org/svn/wikiticketcalendarmacro here] using Subversion, or [source:wikiticketcalendarmacro browse the source] with Trac. == Example == See [#Download download section] on how to activate your version. The invocation for the screenshot above is {{{[[WikiTicketCalendar(*,*,true,Wochenberatung/%Y-%m-%d,true,Beratung)]]}}}.[[BR]] Excerpt of the source documentation: {{{ Usage ----- [[WikiTicketCalendar([year,month,[showbuttons,[wiki_page_format, [show_ticket_open_dates,[wiki_page_template]]]]])]] Arguments --------- year, month = display calendar for month in year ('*' for current year/month) showbuttons = true/false, show prev/next buttons wiki_page_format = strftime format for wiki pages to display as link (if there is not a milestone placed on that day) (if exist, otherwise link to create page) default is "%Y-%m-%d", '*' for default show_ticket_open_dates = true/false, show also when a ticket was opened wiki_page_template = wiki template tried to create new page Examples -------- [[WikiTicketCalendar(2006,07)]] [[WikiTicketCalendar(2006,07,false)]] [[WikiTicketCalendar(*,*,true,Meeting-%Y-%m-%d)]] [[WikiTicketCalendar(2006,07,false,Meeting-%Y-%m-%d)]] [[WikiTicketCalendar(2006,07,true,*,true)]] [[WikiTicketCalendar(2006,07,true,Meeting-%Y-%m-%d,true,Meeting)]] }}} == Extended configuration == 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): {{{ nav = true - navigation link switch, same as 'showbuttens' wikipage="%Y-%m-%d" - same as 'wiki_page_format' template="" - same as 'wiki_page_template' query="id!=0" }}} 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. 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 ticket.due_field.utcoffset = 0 }}} Again these are the implicit default values. A useful alternative configuration would look like {{{ [wikiticketcalendar] ticket.due_field.name = due_date ticket.due_field.format = ts ticket.due_field.utcoffset = 2 }}} 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]). == About i18n/l10n support == The 0.12 branch of this plugin is prepared for localization (tooltip customization in calendar navigation).[[BR]] But English message texts are still the (POSIX) default. If this isn't your preferred language, you can 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 2. do it yourself (see the [t:wiki:CookBook/PluginL10N#Dotranslatorswork l10n cookbook page for Trac plugins] for more details). You've done a new translation? Superb! Contributing your translation is highly appreciated.[[BR]] You could send it to the plugin's maintainer or contribute to [TracPluginTranslation Trac plugin l10n project] via [http://www.transifex.net/projects/p/Trac_Plugin-L10N/ Transifex]: Top translations: Trac_Plugin-L10N ยป [http://www.transifex.net/projects/p/Trac_Plugin-L10N/c/wikiticketcalendar/ wikiticketcalendar][[BR]] [[Image(http://www.transifex.net/projects/p/Trac_Plugin-L10N/c/wikiticketcalendar/chart/image_png, title=Go to Trac_Plugin-L10N project page on Transifex.net, link=http://www.transifex.net/projects/p/Trac_Plugin-L10N/c/wikiticketcalendar/)]] Kindly provided by [[Image(http://sw.transifex.net/2/static/charts/images/tx-logo-micro.png, link=http://www.transifex.net/, title=the open translation platform, valign=bottom)]] Preparing the plugin from source requires the additional step of compiling message catalog files. Walk through: {{{ cd wikiticketcalendarmacro python ./setup.py compile_catalog -f python ./setup.py bdist_egg }}} But if you missed the 2rd step, this will be taken care for before the build step 3.[[BR]] To exclude translations marked as `# fuzzy` by the translator, you'll want to omit the extra `-f` argument to message catalog compilation. In fact this is the default for automatic compilation before the build. Again, for more details see the [t:wiki:CookBook/PluginL10N#Compileanduseit l10n cookbook page for Trac plugins]. == Recent Changes == [[ChangeLog(wikiticketcalendarmacro, 3)]] == Author/Contributors == '''Author:''' [wiki:mcomb] [[BR]] '''Maintainer:''' [wiki:rjollos] [[BR]] '''Contributors:''' [wiki:hasienda]