[Chameleon-dev] [Bug 743] [Chameleon - doc builder] Button attributes are not all extracted from Button.php

[bugzilla-daemon at www.maptools.org]

http://www.maptools.org/bugzilla/show_bug.cgi?id=743





------- Additional Comments From cthorne at dmsolutions.ca  2004-11-01 15:38 -------
I thought I had a clear understanding of what a shared resource is and what it
represents.

Description of SharedResource from help viewer:
 
SharedResource is an invisible widget that defines some set of values that are
to be shared among one or more widgets. Shared Resources are used as a global
placeholders for sets of common attributes from a widget or an attribute group.
The attributes allowed in Shared Resources, and their individual
formats/structures, are defined within the code for the individual widget or
attribute group. Shared Resources help Chameleon application developers better
manage all their different attribute sets. 

pauls comment#3 brakes this fundamental concept/rule. If attributes that are
defined in the shared resource can only be declared in a shared resource and not
within the widget. Than this is an issue, that needs to be discussed further.

--------
Despite this issue. In my opinion, ALL attributes should be
declared/registered/found during the doc building process, where ever they are
declared within chameleon.

And once found should be dumped into the corresponding widget document (widget
or attribute group) that the attribute was found in.

Paul stated that there where two direction this issue could be dealt with. I
would argue that this is both a documentation issue and development issue rather
than one or the other.

>From the documentation point of view:

1) all attribute should be found during doc_builder process.
2) Since, there are attributes declared within a widget that are shared resource
specific (ie. can only be declared in the template under the shared resource)
there should be a new Attribute Class eg. Shear Resource Only. Currently there
is only three attribute class. 

They are: 
1) Require, 
2) Widget Only, 
3) Widget & Shared Resources

I think the bigger question is: 

* Is it ok to create a new Attribute Class "Shear Resource Only"?

I am not a big fan of having attributes declared in the widget that can only be
used in the shear resource. This new class will have to be created for
documentation, if this is not addressed within code.




------- You are receiving this mail because: -------
You are on the CC list for the bug, or are watching someone who is.