HTML Page Generation

HTML Page Generation Settings provide the following options:

spy.doc removes the in-page style sections that XMLSpy® generates. If a suitable reference to an external style-sheet (.css) file is set in the page-header HTML specified by the HeaderFilePath option, then the styles required by the documentation can be defined in the style-sheet, thus providing a means to change the style of the content pages globally. The style-sheet file path is specified by this option. The file is always displayed as an absolute file path, but spy.doc always attempts to save the file path relative to the project file path. The file path can be browsed and selected by clicking on the button at the right end of the option text field (labeled with an ellipsis '...').

FooterFilePath Option

The file specified by this file path should contain HTML tags to complete the documentation page content. In its simplest form, the only tags required are the BODY and HTML closing tags:

</body></html>

however, this can be elaborated to provide complex footers. For example, the following is the footer that is required by this documentation:

<span class="footer"><hr>
spy.doc Version 2007.1 - 18 Jan 2007. Copyright © Businessware Architects cc 2007
</span>
</body>
</html>

The footer file is always displayed as an absolute file path, but spy.doc always attempts to save the file path relative to the project file path. The file path can be browsed and selected by clicking on the button at the right end of the option text field (labeled with an ellipsis '...').

HeaderFilePath Option

The file specified by this file path should contain HTML tags that define the documentation page content header. In its simplest form, the HTML opening tag, the HEAD section, and TITLE section, as well as the opening BODY tag should be used:

<html><head><title></title></head><body>

however, the following is a typical definition of the header:

<html> <head><title></title> <meta http-equiv="content-type" content="text/html; charset=UTF-8" /> <link href="my_style_sheet.css" type="text/css" rel="stylesheet" /> </head> <body> .

The <title></title> tags are required so that spy.doc will add the correct title text to the tags, based on the first heading it finds in the HTML content. In this example, 'my_style_sheet.css' is specified by the CssFilePath option. spy.doc will copy the .css file specified by the CssFilePath path to the OutputFolderPath, in order that the style-sheet reference requires only the .css file name and not the file path.

The header file is always displayed as an absolute file path, but spy.doc always attempts to save the file path relative to the project file path. The file path can be browsed and selected by clicking on the button at the right end of the option text field (labeled with an ellipsis '...').