Generation Log Window Usage
Generation Log Window Usage
The Log Window provides an initial report of the spy.doc project settings and a progress report as the documentation is generated. As documentation generation can be a lengthy process, depending on the documentation generation options specified, a summary of the phases of documentation generation are reported with date and time stamps. A successful documentation generation log is shown below:
2007/01/18 11:32:41 : Generation started.
2007/01/18 11:32:41 : Generation parameters :
XML-schema file path : C:\Program Files\Businessware\spy.doc\Sample\spy.doc.xsd
Output path : C:\Program Files\Businessware\spy.doc\Sample\Sample1\Build\
Links file name : spy-doc-links.xml
XML-schema base uri : http://www.bware.biz/spy.doc/
HTML header file path : C:\Program Files\Businessware\spy.doc\Sample\Files\spy.doc.header.html
HTML footer file path : C:\Program Files\Businessware\spy.doc\Sample\Files\spy.doc.footer.html
CSS file path : C:\Program Files\Businessware\spy.doc\Sample\Files\spy.doc.documentation.css
HHP template file path: C:\Program Files\Businessware\spy.doc\Sample\Files\spy.doc.hhp
Doc-set name : spy.doc
HTML help compiler : C:\Program Files\HTML Help Workshop\hhc.exe
HTML start page path :
HTML home page path :
Skip docn creation : False
Delete working files : True
Generate HH files only: False
Generate options:
XMLSPY; AllDetails; AllTypes
2007/01/18 11:32:47 : Initializing custom documentation implementers.
2007/01/18 11:32:48 : Creating XMLSpy documentation.
2007/01/18 11:32:49 : Creating custom implementers documentation.
2007/01/18 11:32:49 : Parsing documentation and creating HTML links.
2007/01/18 11:32:49 : Creating custom documentation HTML links.
2007/01/18 11:32:49 : Splitting and re-linking XMLSpy documentation.
2007/01/18 11:32:50 : Splitting and re-linking custom documentation.
2007/01/18 11:32:50 : Merging XMLSpy HTML documentation.
2007/01/18 11:32:50 : Merging custom HTML documentation.
2007/01/18 11:32:50 : Completing HTML documentation.
2007/01/18 11:32:50 : Finalizing HTML-Help documentation.
2007/01/18 11:32:50 : Compiling HTML-Help documentation.
2007/01/18 11:32:53 : Deleting temporary folders and files.
2007/01/18 11:32:53 : Finalizing custom implementers.
2007/01/18 11:32:53 : Generation completed successfully.
If an error is encountered, the exception message with a complete exception stack trace is logged. This allows for easier tracking of errors. The following section provides more information: