Overview of advanced document template customization

Purpose of this chapter

Objecteering documentation generation can be customized using the tools for building document templates. For more sophisticated parameterization services, MDA Modeler is used to realize J parameterization rules.

This chapter, therefore, presents the necessary additional information to parameterize a document template (generation rules, hypertext links, …).

Customizable rules

Document templates call several rules that are in fact J methods. These methods have the following nature:

· filter rules: produce a filtered set of model elements to be processed in the documentation (for example, for the public operations of a class, the filter is the operation's visibility)

· generation rules: produce a description to be incorporated in the documentation

· scrolling rules: offer useful browsing through model elements, through an interface which does not require knowledge of the metamodel

UML profiles

The generation of documentation using document templates is defined on the "default#external#Documentation" UML profile. It is, therefore, necessary to define your document template on a UML profile which specializes this UML profile.

Furthermore, in order to use the commands defined for the Objecteering Documentation module, it is necessary to make the MDAC that contains your document template specialize this module.