[Chameleon-dev] [Bug 74] Change the "descXXXX.txt" documentation file to a more extensible format (XML ?)

[bugzilla-daemon@www.maptools.org]

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





------- Additional Comments From thorne@dmsolutions.ca  2003-11-13 16:51 -------
To Address the issue of Widget Dependencies the following sections should be
considered for the doc.xml specifications. I had a quick chat with Paul and he
agrees with this. How we implement/organize this has yet to be determined, but I
will try to outline this.

Here is a list of new sections/ documentation issues that need to be addressed:

1) <SharedResource/> list the Shared Resources that are related to the widget.
i.	required="true|false" XML parameter describing weather the Shared Resource is
required for the widget to work.
ii.	Comment= how and why there is a dependency (optional)
iii.	Description or link to the Shared Resources Documentation.

2) < OtherWidgets /> list Other Widgets that are required for the widget to
function.
i.	Comment= how and why there is a dependency (optional)
ii.	Description or link to the Shared Resources Documentation.

3) <SubWidgets/> Widgets required to be grouped together in order for all of the
widgets to work. No single widget of this group can work on its own.

4) <PHPScipts/> list php files found in /htdocs/widgets/ that are required for
the particular widget eg. Button.php, CatalogSearch.php
i.	Parameter stating weather the script is strictly only used by that widget or
that other widgets in this script.
iii.	Comment= how and why there is a dependency (optional)
iv.	Description or link to the PHP Scripts Documentation.

5) <PHPutilities/> list of required PHP utilities required by the widget.
i.	Comment= how and why there is a dependency (optional)
ii.	Description or link to the PHP Utilities Documentation.

6) <DataResources/> List of dbf or other data like files that are required for
the widget.
i.	Comment= how and why there is a dependency (optional)
ii.	Description or link to the Data Resources Documentation.

7) <JavaVariables /> List of Java Variables required for the Widget.

8) <JavaInclude /> List of Java *.jar files required for the Widget.

This is mostly a list of components that are required to de Documented. How this
is done will have to be hashed out. 




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