[KULRICE-805] Come up with a method for generating documentation about our XML document structure (XSD schema) Created: 05/Jan/09  Updated: 11/Jan/08  Resolved: 11/Jan/08

Status: Closed
Project: Kuali Rice Development
Component/s: Documentation
Affects Version/s: None
Fix Version/s: Documentation

Type: Task Priority: Major
Reporter: Eric Westfall Assignee: Chiakang Chou (Inactive)
Resolution: Won't Fix Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Similar issues:
KULRICE-6109Come up with a way to "auto-generate" documentation on our various configuration parameters
KULRICE-1993Create a reference guide for our Ingestable XML configuration (DocumentType, RuleAttribute, etc.)
KULRICE-50Document the structure of all of our database components in the project
KULRICE-1855KEN XSD Schema validation for notifications being sent into KEN via the XML based String input service fails for non-UTF-8 DBs
KULRICE-3683Clean up the XML that's generated to be used for generating emails using XSLT
KULRICE-2309Improve XSD schema defintitions for KEW XML so that they can be utilized by XML tools
KULRICE-1599Developer-friendly XSD URIs
KULRICE-1130improve performance of xml ingestion
KULRICE-5188Need to remove ImmutableListAdapter and ImmutableCollectionAdapter from our service definitions and come up with a better solution because it is producing undesirable XML
KULRICE-3297XML Document Content is not properly included in XML used to generate workflow emails
Rice Module:
KEW

 Description   

This one will be a bit more challenging

We have a few files in the project which end in ".xsd". These are the XML schema definition files for the workflow XML. What I want you to do is document these schema files. However, I don't really want to do this manually. I would rather use a tool to generate this documentation and then add the appropriate <xs:annotation> and <xs:documentation> to those schema files.

Here's a product that I was looking at for this which is free:

http://www.filigris.com/products/docflex_xml/xsddoc/about.php

Feel free to do some more research if you would like to try and find some other options (must be free

If you could do some investigation into this and see how to run it and set it up that would be great. When you are ready to process the schemas, they are in the workflow project under

src/schemas

If you don't have workflow checked out currently (can't remember if you do) let me know and I'll help you get it checked out.



 Comments   
Comment by Eric Westfall [ 11/Jan/08 ]

This program didn't end up panning out.

Generated at Sat Jan 18 11:07:43 CST 2020 using JIRA 6.1.5#6160-sha1:a61a0fc278117a0da0ec9b89167b8f29b6afdab2.