Messages

Overview

All messages generated in the document (except the contents of Objecteering notes) can be parameterized (chapter titles, bulleted list headers, …).

These messages are defined in the message file indicated in the document work product and are called by the document template. The contents of these files depend on the type of document template used.

To parameterize messages, you should simply carry out the following steps:

· Copy the file relevant to the document template (analysis.* or design.*).

· Modify the contents of the file.

· Copy it into the "$OBJING_PATH\mdaplugs\Documentation\res" directory.

· Indicate this file in the document work product.

In this way, you can easily generate a document in another language (Spanish, German, …). For example, "analysis.fr" is used to generate an analysis document in French, whilst "analysis.us" is used to generate the same analysis document in English.

Message syntax

In the message file, messages must have the following syntax:

Identifier:

This is the translation of the message.

end Identifier

Example

You wish to replace the word "Package" by "Categories". To do this, you must modify the contents of the "Package" message:

Package:

"%1" categories

end Package