Configuring messages

 

Simple parameterization

All messages generated in HTML files containing metrics declarations can be parameterized.  These messages are in a file that is defined during configuration of Objecteering Metrics.

 

Note:      It is essential that a messages file be defined, in order to generate metrics.  Objecteering Metrics is delivered with two messages files, which are used to generate documents in English or in French.

 

 

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

 

Identifier:

This is the translation of the message.

end Identifier

 

Example:

  

Overview:

  Overview

   end Overview

 

 

Parameterizing on-line help

All messages generated in HTML files containing metrics can have a hypertext link to the on-line help on the metric in question.  To define a hypertext link, two parameters are necessary:

·         the file opened by the hypertext link

·         the text which defines the place

 

The name of the target file which corresponds to the "Label'" message is defined in the "Label_Help" message.  The on-line help directory defined during configuration of the MDAC is added to this file name.

 

The text which defines the hypertext link must be surrounded by the "@" character in the "label" message.  In this way, you can replace the on-line help provided by Objecteering Software for each metric with different on-line help.

 

Example:

To define the "Specialization index (SIX)", the hypertext link is directed towards D:\Program Files\Objecteering\Help\25\Six.html.

 

   SpecializationIndex:

Specialization index (@Six@)

end SpecializationIndex

SpecializationIndex_Help

six.html

end SpecializationIndex_Help