wiki:DateFieldPlugin

Version 31 (modified by mister_pope, 3 years ago) (diff)

--

Add custom date fields to tickets

Description

This plugin allows for validating custom fields as dates in tickets. Just set up the field as a custom field, then use these extra options in the trac.ini file:

fieldname.date = true
Enable extra date stuff on this field.
fieldname.date_empty = true
Allow this field to be blank.(default value "due_date.value" must be empty)
or use the CustomFieldAdminPlugin to create a date field:

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.

The configurable options are:

format =
valid formats are dmy, mdy, and ymd
separator =
possible values are - or . or /
first_day =
let you change the first day of week (0=Sunday .. 6=Saturday) (as introduced in #1726)

The following options are available since [7192]

months = 1
How many months to show at once?
milestone = false
Use datepicker for milestone due/complete? (format= must match your locale)
weeknumbers = false
Show ISO8601 week numbers?
panel = false
Show a button panel with "Today" and "Done" buttons (at bottom)?
change_month = false
Show a dropdown with month selection?
change_year = false
Show a dropdown with year selection?
match_request =
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

There are many other options, but you need to modify the datefield.html template if you want to use them. See http://docs.jquery.com/UI/Datepicker

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

Bugs/Feature Requests

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.

Existing bugs and feature requests for DateFieldPlugin are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Installation

Download the source zip and unzip it to a folder.

From a command prompt, run 'setup.py bdist_egg'. This builds an 'egg' installation file to a new 'dist' directory.

Got to your Trac Admin page, select Plugins, click Browse, select the egg file, then click install.

Source

The 0.11 version works with Trac 0.12.

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

Example

To enable:

[components]
datefield.* = enabled

To add a Due Date:

[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

To configure:

[datefield]
format = mdy
separator = -
first_day = 1

No image "datefield.jpg" attached to DateFieldPlugin

Recent Changes

[13931] by rjollos on 2014-05-20 16:39:26
3.0.0dev: Use jQuery-UI from Trac. Refs #10107.
[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
Contributors: doki_pen, terje

Attachments (4)

Download all attachments as: .zip