Bug 878 - [Chameleon - AutoDoc] HTML Widget Doc Location in Chameleon.
: [Chameleon - AutoDoc] HTML Widget Doc Location in Chameleon.
Status: RESOLVED FIXED
: Chameleon
AutoDoc
: 1.99
: PC Windows 2000
: P2 normal
: 2.0 Final
Assigned To:
:
:
:
:
:
  Show dependency treegraph
 
Reported: 2004-11-29 10:31 by
Modified: 2005-01-07 08:25 (History)


Attachments


Note

You need to log in before you can comment on or make changes to this bug.


Description From 2004-11-29 10:31:28
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. :)
------- Comment #1 From 2004-11-29 10:31:52 -------
setting target to RC 1
------- Comment #2 From 2004-12-19 07:52:28 -------
Based on a meeting between Paul, Bill and I. We decided to put the HTML DUMP of
widget docs in:

/chameleon/docs/html/widgets
/chameleon/docs/html/attributegroup (?)

------- Comment #3 From 2004-12-19 09:05:53 -------
this will be address by the final release

moving target
------- Comment #4 From 2005-01-04 08:35:17 -------
Looking at this one now.
------- Comment #5 From 2005-01-07 08:25:08 -------
Fixed in CVS.  The docs are all dumped into a single directory
/docs/html/widgets/