Document the use of the API within forms.

The API is changing in the HEAD version (which will become the 5.2 version). I've finally switched the way this works so it uses hook_elements() and has its own #process and #validate functions. Once it is all working well, I'll need to come back and get it all documented.

The new version is not ready for use. When it gets more reliable, I'll create a 5.2 branch where it can be tested.

There is lots of internal documention in the functions.

The file date_api.module is basically a big collection of date utility functions. You can scan through the file and it should be pretty obvious what they are and what they do.

The date_api_xxx.inc files are files you can optionally include to do other things -- create cross-database date sql or work with ical. The date sql is implemented for views queries in date_api.views.inc, which should give you ideas on how to use it. The ical functions are implemented by the Calendar iCal module, which you can use as an example.

The basic date functions are the PHP 5.2 date functions -- date_create(), date_timezone_set(), date_format(), etc, all of which are documented on php.net.

The Date PHP4 module provides those 5.2 date functions for systems that don't have them (earlier than PHP 5.2).

The date_api_elements.inc creates date form elements - create a date selection form using type => '#date_select' and give it a few parameters (all documented in that file).

The Date Popup module will create a popup widget if you create a form and give it type=>'#date_popup' and a few other parameters documented in that file.

Someone needs to develop some good documentation, so maybe you can start some as you go?

Oh yes, and the Date Repeat module has an API for creating and parsing iCal RRULEs. You can use it to add a form element that allows users to select repeat rules (a form with type => '#date_repeat') and the repeat_calc function will parse an iCal RRULE and return an array of the dates that fit that rule.

Sorry I overlooked your original effort and I appreciate what you've done.

Yes, I was trying to make things as consistent as possible with the way FAPI usually works. I'll leave this active and try to get back to it to build on what you started and make sure it's easy to find.

Thanks!

I split the API documentation between the way it works in 5.1 and the way it works in 5.2 and 6.2 and moved the latter to a new page at http://drupal.org/node/287128. Since the documentation itself separates the different versions, we should have separate API pages for each.

Thanks again for getting this started :)

I'm going to mark this fixed because it is at least started. Things like this are never 'done', and I'm trying to clean up the issue queue.