Imagix 4D User Guide

Document Formats

The Document function produces output in three formats - ASCII, RTF and HTML - to support different uses. While any document can actually be produced in any of the three formats, each of the formats has certain advantages. Typically, there is one obvious choice for a given document use.

ASCII format results in simple, readable files. Generating and post-processing ASCII documents is one quick way to export information from Imagix 4D. If you have more advanced data export or custom report needs, please contact Imagix or your local distributor, as the tool has an extensive database with powerful analysis and export capabilities.

With RTF (rich text format), you can produce hardcopy documentation. The Imagix 4D creates a (series of) files, that you can import into your word processor. For large documents, you can then use your word processing tools to control type styles and page layout; to generate a table of contents with your word processor, use `Section' and `Subsection' as the styles to include in the table. However, RTF is normally the format choice for smaller code review or problem analysis type documents. For these, a table of contents is often unnecessary. You can quickly add whatever annotations you want using your word processor, and then generate a paper or electronic document that can be shared for the task at hand.

The HTML format enables you to create on-line documentation with indices. All symbol references are linked, including symbols appearing in graphs. Metrics tables and class hierarchies are included. For comprehensive design documents, this is usually the format of choice.