logo       

Re: documenting widgets was: release 0.4.1 bug triage: msg#00428

web.dojo.devel

Subject: Re: documenting widgets was: release 0.4.1 bug triage

Carla Mott > I created 2 files with names of widgets, one with the list from namespaces/dojo.js
and one from the list of widgets in the API doc. That is I looked at the widget
entry on the left nav bar and copied all entries under that.

Not surprisingly the lists don't match. What is the real list? Some merger of the 2?

Probably the main difference between the lists is that the API doc contains a lot of internal widgets. I think if you wait until the API doc for the widgets is done it'll be clear which widgets are meant to be used explicitly used and which are used internally.


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

Right, this is what I was aiming for w/the chapter on Forms and the chapter on Layout widgets, although the chapter on forms actually encompasses everything related to forms, not just widgets.

The other thing (I'm sure the nomenclature police will take great offense to me saying this) is that a single "widget" (from the user's point of view), like the Tree, is actually composed of multiple widgets (TreeV3, TreeV3Node, TreeV3Controller etc.) This is a pattern with many of the widgets, and should be evident from the fact that all the related widgets start w/the same word.


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

News | FAQ | advertise