Installed Samples

Sample 1, 2, and 3 document the spy.doc project configuration XML-schema ‘spy.doc.xsd’. The GJXML sample illustrates the approach to use when documenting very large XML-schemas.

1.   Sample1: Basic most common configuration. The sample project produces a standard HTML Help file with Table-of-contents categorized according to XML-schema construct, and a standard name-based Index. Full-text search is available.

2.   Sample2: Same as Sample1, but the XML-schema annotations are displayed first.

3.   Sample3: Same as Sample2, but no XML-schema source-code is displayed. A startup and homepage is also specified, and the XML-schema dictionary definition list is added via the ‘DefinitionGenerator’ addin. This plugin also modifies the Table-of-contents by adding ‘Definition’ and ‘Structure’ categories as main categories. The plugin also modifies the Index by adding sub-sections to each named index entry. The image dimensions are removed in the diagram section using the ‘PageHtmlFixup’ addin. This fixes some image display problems in the browser.

4.   GJXML: The GJXML sample provides the project to document the entire JXDM (GJXML) schema. The schema .xsd files are not provided, but can be downloaded (Version 3.0.3) from the link below:

http://it.ojp.gov/jxdm/3.0.3/index.html

NOTE: For the project to work correctly you should place the ‘jxdm’ folder and all sub-folders in the ‘.\Sample\GJXML\’ folder.

If the provided jxdm.spydoc project is used, a HTML Help file with the following properties is created: