Defining documentation properties

Prerequisite

Documentation is generated from a model which has already been built and documented.

The "Properties" tab of the documentation generation window

Figure 18. Defining the properties of a document

Steps:

1. Select a package in the explorer.

2. Click on the "Create a document" button.

3. Enter the relevant information in the dialog box which appears, and then select the message file.

4. Select the document template.

5. Confirm by clicking on "OK".

In the explorer, double-click on the newly created document work product or right-click to open the context menu and then run the "Generate" command.

The ... field	is used to
Name	enter the name of the produced document. The name of the product corresponds to the name of the generated master file.
Title	enter the document's title.
Subtitle	enter the document’s subtitle.
Author	enter the name of the document’s author.
Version	enter the document’s version.
Reference	enter the reference number.
Date	enter the document’s creation date. The document’s date can be entered directly in this field. \DATE\ inserts the current date into RTF documentation, but not into HTML documentation.
Targeted format	choose the generated document’s format (ASCII, Rtf, Postscript, HTML). Postscript is not available in Windows.
Save as	enter the path where the generated document will be stored. Note: the default path is defined in the "Modifying configuration" window.
Automatic generation after modification	generate the document automatically after having closed the window (without selecting the "Generate" menu).
Message file	select a message file. The delivered document templates use external files. They allow the generation of documentation in English and French.
Document template	select a document template.

Text formats

Files can be generated in different formats.

The ... format	platform ...
Postscript	UNIX
RTF	UNIX and Windows
Ascii	UNIX and Windows
HTML	UNIX and Windows

Image formats

It is also possible to include images in documents.

The ... format	platform ...	inclusion mode ...
Encapsulated Postscript (EPS)	UNIX	reference
Windows EnhancedMetaFile (EMF)	Windows	reference
Portable Network Graphics (PNG)	UNIX and Windows	reference

Partial generation

A document template is subdivided into several "document items". A document item corresponds to a special description of a model element (class, operation, …) within the document template.

For example, to generate a section of a document concerning a class from a document template related to a package, you must:

1. Select the class.

2. Click on the "Create a document".

3. Enter the relevant information in the "Properties" tab, and select the document template.

4. Select the "Partial generation" tab, click on the "Search" button and select a document item from those suggested (they all concern a class).

5. Click on the "OK" button.