Permalink
Browse files

Update comments

  • Loading branch information...
1 parent 827511b commit ecd887dbad452a7c9467507d551dc1f03c378f23 Keith Wood committed Mar 30, 2010
Showing with 20 additions and 6 deletions.
  1. +20 −6 README.md
View
@@ -1,9 +1,23 @@
-[jQuery UI](http://jqueryui.com/) - Interactions and Widgets for the web
-================================
+jQuery UI Datepicker Refactor
+=============================
-jQuery UI provides interactions like Drag and Drop and widgets like Autocomplete, Tabs and Slider and makes these as easy to use as jQuery itself.
+I've refactored jQuery UI Datepicker to use the Widget framework that the other components use. Along with this refactoring I've introduced several other changes:
-If you want to use jQuery UI, go to [jqueryui.com](http://jqueryui.com) to get started. Or visit the [Using jQuery UI Forum](http://forum.jquery.com/using-jquery-ui) for discussions and questions.
+* Use of a templating mechanism to generate the datepicker layout.
+* Use of commands to provide keystroke and UI elements for interacting with the datepicker.
+* Use of the position plugin.
+* Common date routines for general use.
+* An extension module for less common usage requirements.
+* Adobe AIR support (no inline event handlers).
-If you are interested in helping developing jQuery UI, you are in the right place.
-To discuss development with team members and the community, visit the [Developing jQuery UI Forum](http://forum.jquery.com/developing-jquery-ui).
+Have a look at the demos section for datepicker to see the range of functionality.
+
+For documentation on the templating see http://keith-wood.name/calendarsPickerRef.html#renderers, as the same mechanism is used. The templating is home grown at the moment, but should be moved to the official jQuery model once that has been established. The templating allows for the insertion or otherwise of command links and/or buttons. There are standard templates for the default layout and for one with a button pane.
+
+For documentation on the commands see http://keith-wood.name/calendarsPickerRef.html#commandsobj, as the same mechanism is used. The use of commands makes it easy to extend the datepicker (as often requested) with custom buttons. It also associates keystrokes with the commands for keyboard-driven entry.
+
+The common date routines are basically there to support the datepicker functionality but could be extracted into a separate module for more general use. They are: newDate, normaliseDate, daysInMonth, iso8601Week, dayOfYear, add, formatDate, parseDate, determineDate.
+
+The extension module includes less common functionality: weekOfYearRenderer, noWeekends (onDate), changeFirstDay (onShow), hoverCallback (onShow), highlightWeek (onShow), showStatus (onShow).
+
+Please comment on any and all of the features at http://forum.jquery.com/topic/jquery-ui-datepicker-refactor as we want to pin down what is eventually included in the next release.

0 comments on commit ecd887d

Please sign in to comment.