Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 359322

Summary: o.e.d.doc.isv doc content for Extension Point Schema Definitions get out-of-date
Product: [Tools] Data Tools Reporter: Linda Chan <lchan>
Component: relengAssignee: Xiaoying Gu <bluesoldier>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: P3 CC: bluesoldier
Version: 1.9   
Target Milestone: 1.9.2   
Hardware: PC   
OS: All   
Whiteboard:

Description Linda Chan CLA 2011-09-28 20:43:53 EDT 
The *.html files found in the o.e.d.doc.isv bundle for the DTP extension points' schema definition are static, and may get out-of-date from their corresponding source content (schema/*.exsd) in the plugin projects.

The o.e.d.doc.isv bundle is built by fetching the static files kept in its source repository, under org.eclipse.datatools.doc.isv/html/reference/extension-points/*.html .

Ideally, the o.e.d.doc.isv bundle build process can dynamically generate those *.html files from the schema definition files (schema/*.exsd) kept in individual plugin projects.
Comment 1 Linda Chan CLA 2011-09-28 20:53:30 EDT 
This will need further investigation on whether it is feasible for the build process to auto generate the html doc files from the schema/*.exsd files.

In the mean time, I have checked in updates to the static html files kept in o.e.d.doc.isv for the o.e.d.connectivity.oda* and o.e.d.connectivity extension points.  Tagged with v201109290731.
Comment 2 Xiaoying Gu CLA 2012-01-04 03:40:34 EST 
similar bug in platform team: https://bugs.eclipse.org/bugs/show_bug.cgi?id=35145
Comment 3 Linda Chan CLA 2012-01-06 17:56:42 EST 
Until there is an automated solution, can we use a custom script to generate the schema doc?  So at least any updates to existing xsd will get an updated doc generated.  And committers that introduce a new xsd will need to manually add an entry in the custom script.
Comment 4 Xiaoying Gu CLA 2012-01-09 03:45:43 EST 
CreateSchemaReference target has been added to BuildDocISV.xml under doc.isv plugin.

If a new xsd file is introduced in a plugin for the first time, committer  should update the BuildDocISV.xml manually.
Comment 5 Xiaoying Gu CLA 2012-08-16 01:34:43 EDT 
If a new schema is introduced, plugins/org.eclipse.datatools.doc.isv/tocreference.xml file need to be updated manually with a new topic link for added schema.