Creating XSD Documentation

The purpose of this document is to show how XSDs are properly documented and the results stored in shared areas and source control for all to use. These files are required by customers to aid in developing interfaces into CTMS and as such are reuired parts of the development process.

Requirements

• An XSD to document, with valid annotation tags embedded within it.
• Notepad++ with XML Tools plugin installed.
• Chrome (or other HTML to PDF conversion tool).
• Access to the shared drives.
• Access to the XSL transformation sheet xs3p.xsl, in the shared drives.

Process

Once the XSD has been modified, ensure that it is in source code control.

Save the XSD to the shared drive, for exmple for TripOrder XSD, \\DGA1FS01OBS\Projects3\Product\OBS XML\C-TMS tripOrder\Schema Source

• Using Notepad++, open the XSD you have edited.
• Menu, Plugins/XML Tools/XSL Transformation.
• Select the XSL transformation sheet xs3p.xsl.
• Click Transform.
• On the newly created file, replace the titles with the version. For example, for TripOrderXML, replace all "Trip/Order XML" with "Trip/Order XML vx.yy". There should be 3.
• Click Save.
• Change type to HTML.
• Name as "{InterfaceName} vx.yy XML Schema Documentation.html", for example "TripOrder vx.yy XML Schema Documentation.html".
• Open the HTML file in Chrome (directly, or double click the created HTML file, or from Notepad++, Menu, Run/Open in Chrome).
• Right-click, Print
• Change Destination to Save as PDF
• Click Save
• Name as "{InterfaceName} vx.yy XML Schema Documentation.pdf", for example "TripOrder vx.yy XML Schema Documentation.pdf".
• Copy the following files to the shared drive:
  • {InterfaceName} vx.yy XML Schema Documentation.pdf
  • {InterfaceName} vx.yy XML Schema Documentation.html