Documentation Generation

Documentation Generation settings provide options that adjust the generation process to support incremental documentation generation, which is important when the schema-sets are large and complex, and documentation generation for the schema-set has never been executed before.

HhOnly Option

spy.doc will create only the actual HTML Help files, if this option is set to True, else if set to False spy.doc will execute the whole generation path, unless the NoCreate option is set to True. Only the following files will be created:

• HTML Help Project (.hhp),
• HTML Help Table-of-contents (.hhc),
• HTML Help Index (.hhk), and
• HTML Help documentation file (.chm).

NOTE: In order for this option to work successfully, the NoDelete option should have been set to True on a prior generation execution: the intermediate HTML, image and other referenced files required for inclusion in the help file should exist.

This reason this option is used is if the requirement is to rebuild the actual help components without having to rebuild the entire documentation set.

The default value is False.

NoCreate Option

This option is set to True if the documentation generation must exclude the content generation phase provided by XMLSpy®. If it is set to False, spy.doc will direct XMLSpy to generate the help documentation content. If the documentation is generated in increments, this can be useful, as the XMLSPY® generation phase normally consumes most of the execution time. This becomes a major factor if the schema-sets are very large. See this section for more information:

• XMLSpy Workarounds - Complete Documentation for Large Schemas.

NOTE: In order for this option to work successfully, the NoDelete option should have been set to True on a prior generation execution: the intermediate HTML, image and other referenced files required for inclusion in the help file should exist.

The default value is False.

NoDelete Option

This option is set to True to instruct spy.doc not to delete intermediate files (files that are required for inclusion in the help file), and temporary files (files that are created when the documentation content files are split and merged as the documentation is generated), after documentation generation is completed. It is usually used in conjunction with the HhOnly and NoCreate options.

Another reason this option is used is if the help file is to be modified after it is initially generated by spy.doc. This is typically required, when additional page are to be added manually to the help file, or if table-of-content, index, or other files in the help file are to be modified. Use this option if you want to use the content in other help files, for web-browser browsing of the content, or for inclusion in H2 or SandCastle help.

The default value is False.