Bug 875 - [Chameleon - DocBuilder] HTML output option using xslt's
: [Chameleon - DocBuilder] HTML output option using xslt's
Status: RESOLVED FIXED
: Chameleon
AutoDoc
: 1.99
: PC Windows 2000
: P2 normal
: 2.0 Final
Assigned To:
:
:
:
:
:
  Show dependency treegraph
 
Reported: 2004-11-29 09:56 by
Modified: 2005-01-07 08:23 (History)


Attachments


Note

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


Description From 2004-11-29 09:56:33
Ok, to avoid providing support for configuring the appropriate php extensions
for none installer for Linux and Window users. We have decided to provide html
outputs of the widget docs on the release of 1.99 rc1.

We have also decided that the doc builder (internal tool) will be the tool that
allows us to create these files. 

It should be an option of the doc_builder. how this will be defined in the
interface has yet to be defined. The issues are:

* If an xml document has not been generated during html building what should happen?
* Should xml building separate from html building from the interface point of
view?    
  * Should we have check boxes for html building vs. xml building. 
  * Separate wizard?
------- Comment #1 From 2004-11-29 09:57:33 -------
Assign to bill, target to rc1
------- Comment #2 From 2004-11-29 10:25:35 -------
I think the HTML generation can be (and should be) kept very simple.  It should
be a checkbox in the doc_builder prcess.  This will allow for generation of HTML
at the same time the XML is updated as well as allow the user to exclusively
generate HTML docs from the existing XML docs.  

It will be CLEARLY indicated on the checkbox that the HTML docs are being
generated from exisiting (or newly generated) XML files and NOT from the widgets
themselves.

If an XML doc does not exist for the selected widget, an appropriate error
message will be displayed.
------- Comment #3 From 2004-11-29 10:49:08 -------
bill, I think it is important to have the doc builder first update/check the xml
doc during the output of the html documents. But you are assuming that the xml
doc process is perfect. :) There will be instances where a missing attribute
will be added manually, and if not registered by doc builder correctly it will
be commented out and not show up in the html output. 

How should be deal with this?
------- Comment #4 From 2004-11-29 11:50:19 -------
I understand what you are getting at, but because the HTML output is only needed
as a secondary measure for the help viewer I don't see the need (or think the
time should be spent) to create another interface for something like this.

As I indicated earlier, the process (i.e. checkbox for HTML output) can be run
as a stand alone process using the same interface.  Just select the widgets you
want to gerneate HTML docs for and click "Gen Docs".

How does that sound?
------- Comment #5 From 2004-11-29 13:03:35 -------
I agree with your statement. Check box options vs. a new interface would be
best. How about.

Two checkboxes: 1) for xml output and 2) for html output. 
* If both are checked xml will be processed after html.
* If 1) is only checked than xml will be generated (this should be the default
setting).
* If 2) is only checked than html is genrated. If not xml is found than an error
message should be presented.

Is that ok?
------- Comment #6 From 2004-11-29 13:25:52 -------
Yes, that sounds fine to me, that is what I meant by "stand alone process"
(although I didn't explcitly say so ;)).
------- Comment #7 From 2004-12-19 09:02:57 -------
moving target to final release.
------- Comment #8 From 2005-01-07 08:23:14 -------
Fixed in CVS.  In the intrest of saving time, the process has been greatly
simplified.  The last step of the doc builder is a list of available XML docs. 
Select the doc(s) from the list and click the "translate" button.