wiki:DateFieldPlugin

Version 38 (modified by AdrianFritz, 2 years ago) (diff)

Page re-factor. Retrieves code documentation (as in [11026]). Still requires some review.

Add custom date fields to tickets and helps date selection

Description

This plugin allows for validating custom fields as dates in tickets and also for milestones due_date field (some restriction apply).

Currently this will only validate that the given input looks like the specified date format (see below). Date range checking could be added if someone asks nicely enough.

Development News

  • 1.0.4: The jQuery UI was upgraded from 1.7.3 to 1.8.16.
  • 1.0.3: The jQuery UI was upgraded from 1.7.2 to 1.7.3 and the theme was changed to Blitzer, which seems better suited for Trac (#9598).

DateFieldPlugin at version 1.0.3

Usage

  1. Install and configure
  2. Pick a date on tickets and milestones

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. DateFieldPlugin now requires >= changeset:7982, or apply the changeset:7982 patch. Alternatively, you can use r3982 which is older, has more bugs and less features.
  2. 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

[12118] by rjollos on 2012-10-06 19:38:30
Highlight the current day, as requested by ynoslenav on the mailing list. The option does not seem to be effective on the 0.11 branch.
[11717] by rjollos on 2012-07-09 14:52:45
Refs #10107: Branching to support Trac 1.0. Bump DateFieldPlugin version to 3.0.0dev.

Author/Contributors

Author: coderanger
Maintainer: doki_pen, rjollos
Contributors: terje

Attachments (4)

Download all attachments as: .zip