Configuring documentation generation
Overview
Documentation
directories (where the files are generated) and
documentation viewers can be parameterized in the configuration
window (accessed by clicking on the 
icon in the toolbar, or by running the
"Tools/MDAC options" command).
There are
four parameter sets for the Objecteering Documentation MDAC (as shown in
Figures 19, 20, 21 and 22):
· General
· Viewers
· RTF options
· HTML options
The "General" parameter set
Figure 19. The
"General" subset of "Documentation" parameters
|
The ...
field |
indicates
... |
|
Generation directory |
the directory in which all the documentation files will be stored by default. |
|
Message files |
the files that contain the headers of the titles and messages of the documentation generation. This list will be proposed when the product is created. Each file must be separated by the ";" character. |
|
Characters generating bulleted lists |
the characters which are used in notes to identify text sections which are to be presented in the form of bulleted lists. These characters are separated by a ";". |
|
Convert manual line break to paragraph mark in notes |
that carriage returns in notes have to be converted to paragraph marks. If the tickbox is not checked, carriage returns are generated as manual line breaks. In HTML, manual line breaks correspond to the <BR/> tag and paragraph marks correspond to the <P/> tag. |
The "Viewers" parameter set
Figure 20. The "Viewers" subset of "Documentation" parameters
|
The ... field |
indicates ... |
|
Ascii viewer |
the ASCII viewer tool. |
|
HTML viewer |
the tool which is used to visualize HTML documents (Netscape, Mosaïc, internet Explorer) |
|
Postscript viewer |
the tool which is used to visualize a postscript document (ghostview). |
|
RTF viewer |
the rtf viewer tool. |
|
Let Windows start the viewer |
whether Windows should determine which viewer to run. If this tickbox is checked, the parameters which define viewers are not used and Windows determines which viewer is to be run, according to the type of file and on what has been defined in the registry. |
Note: The "Let Windows start the viewer" parameter is only used on Windows. On Linux, it is not possible to associate a file with an application used to open it.
The "RTF options" parameter set
Figure 21. The "RTF options" subset of "Documentation" parameters
|
The
... field |
indicates
... |
|
Word Template (".dot") |
the Word model associated with the generated
document. |
|
Image width for "landscape" mode |
the minimum width expressed in pixels, from which the page containing the diagram is generated in "landscape" mode. This parameter is only used if the width is greater than the height of the diagram. |
|
Image format |
the format of the image that is to be generated in the rtf document (".png" or ".emf" for Windows only). |
Note 1: When a parameter does not contain a viewer's absolute path, you must define this viewer's path in the "PATH" environment variable.
Note 2: Diagrams generated in "landscape" mode appear extended if macros are active. For this, you should check the Microsoft Word security level using the "Tools/Macros/Security" command.
The "HTML options" parameter set
Figure 22. The "HTML options" subset of "Documentation" parameters
|
The
... field |
indicates
... |
|
HTML style sheet (".css") |
the HTML style sheet associated with the generated
document. |
|
Index generation |
whether or not to generate an index in the HTML document. If the user chooses to generate the index, a hypertext link called "Index" will appear at the top of the page. Clicking on this link displays the index, organized alphabetically and according to element type. |
|
Model generation |
whether or not to generate a model explorer in the HTML document. If the user chooses to generate the model explorer, a hypertext link called "Model" will appear at the top of the page. Clicking on this link displays the model explorer. |
Note: If both the "Index generation" and "Model generation" options are active, the user can only display either the index or the model explorer at any one time. To switch, he should simply click on the hypertext link corresponding to the other item.