Working with the styles.dot document model

 

Overview

Generated RTF documents are created using a Word document model named "styles.dot".

 

You can create your own Word document model, by redefining styles in the "styles.dot" model:

·         the "Normal" mode

·         chapter levels

·         chapter levels for the table of contents

·         headers (except the first page)

·         footers (except the first page)

·         titles

·         sub-titles

·         page numbers

·         bulleted lists

·         numbered lists

·         diagram legends

·         diagrams: Diagram

·         method syntax: Syntax

·         table headers

·         table texts

 

 

Using the "styles.dot" document model

An Objecteering Documentation MDAC parameter is used to indicate the Word document model which is to be associated with the generated document.  This document model is copied into the "res/rtf" directory and renamed "styles.dot".

 

During generation, the document generated is associated with a model named "styles.dot" stored in the same directory as the RTF document.  It is for this reason that your document model is duplicated and renamed.  This means that all elements relative to the document generated (document model, images) are stored in the same directory and your document can, therefore, be used by all users, wherever it is stored.

 

 

Modifying the "styles.dot" document model

To modify a style in the “styles.dot" file, the following steps should be carried out:

1.      Make a copy of the "styles.dot" file within the "$OBJING_PATH\ \mdaplugs\Documentation\<version>\res\rtf" directory (for example, "MyStyles.dot").

2.      Launch Microsoft Word and then open "MyStyles.dot".  It is important that you proceed in this way.  Do not double-click on the "MyStyles.dot" icon, as this would only result in a copy which would retain the original styles.

3.      Select the style you wish to modify, and then select "Format/Styles/Modify/Format", and choose from the list.

4.      Once the style has been modified, save your changes.

5.      At MDAC parameter level, select the "RTF options" subset of Documentation parameters and enter "MyStyles.dot" in the "Word Template (".dot")" field.