wiki:DateFieldPlugin

Version 47 (modified by rjollos, 21 months ago) (diff)

Added syntax highlighting.

Add custom date fields to tickets and helps date selection

Description

This plugin provides a datepicker for ticket and milestone fields, and validation of the date string for ticket custom fields. It will only validate that the given input has the specified date format (see below). The value is stored in the database as a string, as Trac does not yet have date field support (t:#1942). Note: It will never be the intention of this plugin to provide date-type support.

With release 1.0, Trac has integrated the jQuery UI library along with datepicker and datetimepicker extensions into the core. Major changes to this plugin have followed suite, and the plugin will be obsolete in an upcoming release once the work in t:#1942 and t:#10756 is complete.

Usage

Development News

  • Version 3.0.0: The 1.0 branch is a development branch that has been created to support work forwards version 3.0 of the plugin, which will only support Trac 1.0 and later.
  • Version 2.0.0: The 0.12 branch is a development branch that has been created to support work towards version 2.0 of the plugin, which will only support Trac 0.12 and later.
  • Version 1.1.0: The jQuery UI component has been downgraded to 1.6 to ensure compatibility with jQuery 1.2.6 that ships with Trac 0.11.x
  1. Install and configure
  2. Pick a date on tickets and milestones

0.11 branch ------------------- Development branch

DateFieldPlugin at version 1.0.3

Installation

  1. Install globally with:
      sudo easy_install https://trac-hacks.org/svn/datefieldplugin/0.11/
    
  2. Enable the plugin by updating TracIni file (..../trac.ini) as follows:
      [components]
      datefield.* = enabled
    
  3. Configure the project management support for the plugin in its own configuration section, placed into 'trac.ini' file as follows:
    1. To add a Due Date, just set up the field as a custom field, or use the CustomFieldAdminPlugin (image right) to create a date field:
        [ticket-custom]
        due_date = text
        due_date.date = true
        due_date.label = Due Date
        due_date.value = MM-DD-YYYY
        due_date.date_empty = true
      
    2. Site-wide defaults for macro arguments may be set at [datefield] section. More details about them see #Arguments section.
        [datefield]
        format = mdy
        separator = -
        first_day = 1
      
  4. Restart web server on command line:
        $ sudo /etc/init.d/apache2 restart
    

Arguments

This plugin can be controlled with a number of arguments, inside [datefield] section contained in trac.ini configuration file:

Argument Version Description Default
value
format The format to use for dates. valid formats are dmy, mdy, and ymd dmy
separator The separator character to use for dates. Possible values are - or . or / /
first_day >= [6118] First day of the week (0=Sunday .. 6=Saturday) 0
months >= [7192] How many months to show at once? 1
milestone >= [7192] Use datepicker for milestone due/complete fields? (format= must match your locale) If you turn this on, you must use MM/DD/YYYY for the date format. Set format to mdy and separator to /. false
weeknumbers >= [7192] Show ISO8601 week number in calendar? false
panel >= [7192] Show panel with a "Today" and "Done" buttons (at bottom)? false
change_month >= [7192] Show a dropdown with month selection? false
change_year >= [7192] Show a dropdown with year selection? false
match_request >= [7192] Use datepicker on arbitrary request paths. Use text fields with class=datepick in your template, and configure the start of request path (in list format), like: match_request = /query,/other_path
months >= [7192] Number of months visible in datepicker 1

Bugs/Feature Requests

Existing bugs and feature requests for DateFieldPlugin are here.

If you have any issues, create a new ticket.

Known issues

  1. If you have the AutoQueryPlugin installed, you'll need to patch the DateFieldPlugin to work with it, see comment:4:ticket:6796.

Source & Download

You can check out DateFieldPlugin from here using Subversion, or browse the source with Trac.

Download the zipped source from here.

Recent Changes

[14332] by rjollos on 2014-12-15 06:03:26
2.0.0dev: Restore line accidentally deleted in [14331]. Refs #12035.
[14331] by rjollos on 2014-12-15 05:59:07
2.0.0dev: Use 2-digit year format for compatibility with milestone date field. Fixes #12035.

Author/Contributors

Author: coderanger
Maintainer: rjollos
Contributors: doki_pen, terje

Attachments (4)

Download all attachments as: .zip