MapTools.org

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

bugzilla-daemon@www.maptools.org bugzilla-daemon@www.maptools.org
Fri, 17 Oct 2003 08:21:53 -0400
http://www.maptools.org/bugzilla/show_bug.cgi?id=74

           Summary: Change the "descXXXX.txt" documentation file to a more
                    extensible format (XML ?)
           Product: Chameleon
           Version: 1.1
          Platform: PC
        OS/Version: Linux
            Status: NEW
          Severity: normal
          Priority: P2
         Component: Documentation
        AssignedTo: chameleon-dev@lists.maptools.org
        ReportedBy: sfournier@dmsolutions.ca


As discussed with Paul, a more extensible format should be use for the middle
storage format of CWC documentation.

For now, 3 text files are use but don't support documentation of list inside
widget. Also, no support for events documentation. 

By changing the format to XML, we'll be able to add documentation for new widget
sections.

Maybe something like this should do the trick:

<WIDGETS>
    <WIDGET ClassName="Table" Description="Display a table ;)">
    <PARAMETERS>
        <PARAMETER ParameterName="SharedResourceName" Type="String" ...../>
        ...
        ...
    </PARAMETERS>
    <FORMVARIABLES>
        <FORMVARIABLE FormVariableName="Count" ..../>
        ...
        ...
    </FORMVARIABLES>

// Do the same for JS

// Do the same for events

    </WIDGET>
</WIDGETS>



------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.


This archive was generated by Pipermail.