Bug 851 - [Chameleon - Autodoc] modify schema for widget docs
: [Chameleon - Autodoc] modify schema for widget docs
Status: RESOLVED FIXED
: Chameleon
AutoDoc
: 1.99
: PC Windows 2000
: P2 normal
: 2.0 RC 1
Assigned To:
:
:
:
:
:
  Show dependency treegraph
 
Reported: 2004-11-14 11:22 by
Modified: 2004-12-19 08:42 (History)


Attachments


Note

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


Description From 2004-11-14 11:22:23
Currently I am working on reformatting the xsd's to address the following
issues, I am 80% done:

SCHEMA NEEDS:
----------------------
* Make it easier to read.
* Make is easier to add content.
* No language specific content should be defined within the xslt translation
document.
* require a new section for js files.
* Need to have a location to define shared resource tag syntax.
* Need new section for external references to using widget, 
* Address the issue of the reorganization of the xslt sections within the help
viewer. the new division of content within the help viewer is changing,

FROM: Widget Name, Parent Group, Maturity Level, Widget description, Tag
Structure, Attributes, Widget Examples, Shared Resources (description sub
section, shared res. examples), Sample Applications. 

TO:

This will be the Outline for the ALL View for Help Viewer:
 - Widget Name, 
 - All Descriptions (all content driven material which will have the following
sub sections
    - Widget Description, 
    - Maturity Level, 
    - Parent Group, 
    - Widget Dependances, 
    - Shared Resource Description 
    - General User Description for -- Embedded Help Resource Content (this
section should help the general us of the Embedded Help Widget when application
developers are using this widget it would be nice to display the textual
description that will be shown to them in the application for the widget they
wish to have help for. 
    - Detailed Interface Functionality,   
    - Technical Requirements, 
    - Widget QA Information.
 - Tag Syntax (for widget sub tag(s) and shared resource(s)), 
 - Example
   - Widget Tag examples
   - Shared Resource tag examples
   - Sample Applications 
   - Script Examples - script examples that utilize form elements, js api, js
func, js variables, js file. This section should be available for when community
wish to add common executing scripts.
 - Attribute 
   - <CWC2/> Widget Attributes
   - <Sub Tag/> Widget Attributes
   - <Sub Tag Value=""/> Shared Resource Sub Tag Attributes
- Form elements
- Java Script Variables (found in widget code)
- Java Script Functions (found in widget code)
  - JS Parameters
  - JS Return Value
  - JS Api Triggered Events Values
- Java Script Files 
  - Java Script Variables
  - Java Script Functions
    - JS Parameters
    - JS Return Value
    - JS Api Triggered Events Values
- JS API Listened Events
- Widget Events
- Widget Errors
- Reference ?? (Other reference material links to important none chameleon
documents or web sites)
- Comment Submit ?? (link to page on the Community page for this widget.)

CHANGES TO Make to SCHEMA:  
----------------
The above list of issue was addressed by the following requirements for the new
xsd schema.

* Organizes the schema based on type of content vs. the type of chameleon
feature. eg. Document Information, Widget Identification, All Widget
Descriptions, All Examples section, Attribute Groups, All Attributes, JS
Functions, JS Variables, JS Files, JS Api listen Events, Widget Events, Widget
Errors. In this order.

* Provide a <cham:element title=""> title element for any element that would
define a section or subsection within a xslt translated html page. 

* Provide an <cham:intro> element for any section requiring a description of the
purpose of the section or sub section.

* Provide more <cham:description> elements for elements that require explanation
within the final html output widget doc. For example, maturity level, parent
group....

* Reference section?
* Comment Submit section?

SCHEMA CHANGES WILL CREATE THE FOLLOWING OTHER TASKS:
------------------------------------------
* Update default content (titles and intros) for doc_template.xml and attribute
group template for Doc_builder process.
* All xml docs in cvs will have to be migrated to new schema. specifically
validating the current base widget docs.
EmbeddedHelp Widget
* new location in schema for the content to be displayed by this widget.
* Doc Builder -- Update Doc Builder to place extracted values into the proper
elements or attribute.
* Help Viewer -- redue and reorganize for the new structure Simple view xslt.

OBSERVED ISSUES TO CONSIDER:
---------------------------
* Document Management Issues:
  - Since all documents will contain all default introduction content and titles
which was originally found in the xslt. This default information will be
difficult to manage between all the widget docs.
    * one temporary solution is to us the grep tool in TextPad to make updates
if needed between files.
  - Other solution is to reformat how doc builder processes its templates.
Currently the doc builder only uses the default template when there is no widget
doc for the current widget being processed. What should actually happen is to
update from the default template any title or introduction element every time
the process is run. This will allow changes to the default content to be easily
maintained.
  - Future Language consideration. There will have to default widget and
attribute group templates for different languages.
  - Doc builder should allow users to select the default language template they
need, based on language code.
------- Comment #1 From 2004-11-25 15:09:28 -------
Updated doc_builder.php to account for:
1)new xml paths in default xml
2)new "<ca:" tag prefix
3)added language specific selection of default template.
------- Comment #2 From 2004-11-25 15:36:16 -------
need to address the attribute groups. In the new schema
/utils/xml/schema/chameleon.xsd

The attribute group document definition is defined by. <ca:attributegroupdoc>
root element. This is instead of having two separate xml schema documents.

For this doc builder this will have an effect on the element root path. A
variable to either ca:widgetdoc and ca:attributegroupdoc depending on the
default template used.

This bug will be managed by Chris
------- Comment #3 From 2004-12-19 08:42:46 -------
This task has been completed the results of this can be found:
/chameleon/utils/xml/schema/chameleon.xsd (defines the final widget doc with the
xml namespace id <ca: /> )

/chameleon/utils/xml/schema/docbuilder.xsd (defines the interam output step to
the final widget doc. The docbuilder schema is defined with the xml namespace id
<db: /> )