Uploaded image for project: 'Kuali Rice Development'
  1. Kuali Rice Development
  2. KULRICE-805

Come up with a method for generating documentation about our XML document structure (XSD schema)

    Details

    • Type: Task
    • Status: Closed
    • Priority: Major
    • Resolution: Won't Fix
    • Affects Version/s: None
    • Fix Version/s: Documentation
    • Component/s: Documentation
    • Labels:
      None
    • 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.

        Attachments

          Activity

          agodert Aaron Godert (Inactive) made changes -
          Field Original Value New Value
          Project KEW TEMP IMPORT [ 10280 ] Kuali Rice [ 10220 ]
          Key KEWTMPIMPORT-57 KULRICE-805
          Rice Module [KEW]
          Component/s Documentation [ 11241 ]
          Component/s Documentation [ 11604 ]
          Fix Version/s Documentation [ 13081 ]
          Fix Version/s KEW - Documentation [ 13280 ]
          Fix Version/s 2.4.x Documentation
          Move to Kuali JIRA [ 13324 ]
          Responsible Team [Rice Team]
          agodert Aaron Godert (Inactive) made changes -
          Co-Assignee/s [cchiakan]
          Assignee Chiakang Chou [ cchiakan ] Aaron Godert [ agodert ]
          agodert Aaron Godert (Inactive) made changes -
          Status Open [ 1 ] In Progress [ 3 ]
          agodert Aaron Godert (Inactive) made changes -
          Status In Progress [ 3 ] Open [ 1 ]
          agodert Aaron Godert (Inactive) made changes -
          Co-Assignee/s [cchiakan]
          Assignee Aaron Godert [ agodert ] Chiakang Chou [ cchiakan ]
          ewestfal Eric Westfall made changes -
          Status Open [ 1 ] Closed [ 6 ]
          Resolution Won't Fix [ 2 ]
          ewestfal Eric Westfall created issue -
          spatterson Shem Patterson (Inactive) made changes -
          Workflow custom [ 45198 ] Copy of custom for rice [ 209081 ]
          spatterson Shem Patterson (Inactive) made changes -
          Workflow Copy of custom for rice [ 209081 ] custom [ 218829 ]
          spatterson Shem Patterson (Inactive) made changes -
          Workflow custom [ 218829 ] Rice Workflow [ 228577 ]

            People

            • Assignee:
              cchiakan Chiakang Chou (Inactive)
              Reporter:
              ewestfal Eric Westfall
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: