logo       

documenting widgets was: release 0.4.1 bug triage: msg#00427

web.dojo.devel

Subject: documenting widgets was: release 0.4.1 bug triage


I just looked at how many widgets there are and looks like over 150. I
maybe off but even if I'm off by half that's still alot of widgets and pages.

I think it makes sense to group like widgets on a single page and reduce
the number of pages. For example, group could be Form widgets, Layout
widgets, general or core widgets.
Form widgets page would talk about at least the following:
Editor, Checkbox, Validate, DatePicker, TimePicker, ColorPalette , Dialog,
CiviCrmDateTimePicker

I do agree that we need to at least provide some information about the
widgets that is not in the API docs. Obviously we will include a pointer to the
API doc entry.

comments?

Carla


Jon Sykes wrote:

I would have assumed a page for every widget would be minimal.

There are so many features and functions of almost all the widgets that are totally hidden and voodoo to the average user, currently the only way to work out how something works is to go through the code line by line.

I would hope moving forward that widget documentation would be a prerequisite for having a widget added to the bundled Dojo library.

Maybe I'm being overly optimistic thought. ;-)

Jon Sykes


On Oct 24, 2006, at 11:40 PM, Bill Keese wrote:

Maybe you are more pessimistic than I am because you have higher
expectations for the book? For example I wasn't expecting a page for
every widget.


_______________________________________________
dojo-contributors mailing list
dojo-contributors@xxxxxxxxxxxxxxx
http://dojotoolkit.org/mailman/listinfo/dojo-contributors


<Prev in Thread] Current Thread [Next in Thread>
Google Custom Search

News | FAQ | advertise