[Chameleon-dev] [Bug 878] New: [Chameleon - AutoDoc] HTML Widget Doc Location in Chameleon.

bugzilla-daemon at maptools.org bugzilla-daemon at maptools.org
Mon Nov 29 10:31:30 EST 2004


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

           Summary: [Chameleon - AutoDoc] HTML Widget Doc Location in
                    Chameleon.
           Product: Chameleon
           Version: 1.99
          Platform: PC
        OS/Version: Windows 2000
            Status: NEW
          Severity: normal
          Priority: P2
         Component: AutoDoc
        AssignedTo: chameleon-dev at lists.maptools.org
        ReportedBy: cthorne at dmsolutions.ca


The HTML versions of the widget documents that will be pre generated for each
future release starting by the latest RC1 release will have to have to have a
defined directory within Chameleon CVS. 

To be clear the HTML versions of the widget docs will *NOT* be managed within
Chameleon CVS. The reasons are:

1) make chameleon too big!
2) HTML docs will be out date once they have been generated for a release.
3) Duplicated effort for commiting changes.
4) Difficult to managed all HTML docs especially if there are multiple flavours
of widget docs.

Ok, now that we have this covered. we still need to define when the html
documents are generated by doc builder where should they go. I feel the all html
generated widget documents should be placed in a single directory.

These HTML documents should *NOT* be placed within each of the widget
directories. I would prefer a single directory. My preference is:
./chameleon/docs/html/widgetdocs/*.*

As we get more widget docs and increased flavoured html documents, it is likely
we will need sub directories eg.

./widgetdocs/widget/
  - location for all html widet specific documents.
/widgetdocs/attributegroup/
  - location for all html attribute group specific documents.

./widgetdocs/widget/all_sec/ 
  - for HTML pages that show all sections of the widget doc.
./widgetdocs/widget/simple_sec/ 
  - for HTML pages that show the simple view sections of the widget doc.
./widgetdocs/widget/advanced_sec/ 
  - for HTML pages that show the advanced (programmers) view sections of the
widget doc.

Opinions are welcome and need. :)



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


More information about the Chameleon-dev mailing list