Creating a new documentation template

 

Creating a new J profile implementation

Documentation templates, like code templates and diagram templates, are created inside J profile implementations in the "Behavior profiles" folder of a J MDA component. This means that the next step in this quick tour project is to create a J profile implementation inside which you will then create and develop your new documentation template.

 

To create your new J profile implementation, select the “Behavior profiles” folder and click on the  icon. In the window that then appears, name the J profile implementation ("MyTemplates") and confirm by clicking on the “OK” button.

 

For more information on creating J profile implementation, please see “Defining a J profile implementation”.

 

 

Creating a new documentation template

To create your new documentation template, select the "MyTemplates" J profile implementation that you just created, and then click on the   "Create a documentation template" icon.

 

The “Documentation template creation” window then appears.

 

Note:      Documentation templates can only be created on J profile implementations in J MDA components.  It is not possible to create a documentation template for a Java MDA component.

 

For the purposes of our example, we are going to change the name of the documentation template we have just created, by carrying out the following steps:

1.      Select the name of the documentation template on the top left of the window shown in Figure 35.

2.      Click once on it (or press F2).

3.      Enter the new name (in our example, “Package documentation template”) for the documentation template.

 

Note:      This operation can also be carried out in the MDA Modeler explorer.

 

Figure 35. The “Documentation template creation” window