Creating a table for each diagram

 

Creating a table for each diagram of the package

In order to be able to access the different classes belonging to the package by clicking on their graphic representation within a diagram, we are now going to create a table for each of the package's diagram with:

·         a column containing the name of the diagram

·         a column containing the diagram in the form of an image

 

Figure 55 shows the result we are going to obtain for “Multiple HTML” generation.

 

Figure 55. The result of the operations we are going to carry out

 

First of all, given that for the current example we want to create one table per diagram, the navigation node relative to diagrams must be created, by carrying out the following steps:

1.      Select the “Package chapter” section.

2.      Click on the  icon. The “Create a navigation node” window then appears.

3.      In this window, select “Diagrams UML 2.0” from the list and confirm by clicking on “OK”.

 

Continue by carrying out the following steps.

1.      Select the “Diagrams UML 2.0” navigation node you have just created.

2.      Click on the  icon.

3.      Select “Table” from the list of possible production nodes and confirm by clicking on “OK”.

4.      Change the name of the new table by simply selecting it, clicking on it once and entering the name “Table of a diagram”.

5.      Define the “Title” property of the table by entering the following information in the “Value” field associated with the “Title” property: "Table of the diagram " + Name. Please note that the double quotes around Table of the diagram are mandatory. For more information on entering J code, please see “Inserting J code”.

 

Next, proceed as follows:

1.      Select the “Table of a diagram” table you have just created.

2.      Click on the  icon.

3.      Select “Group” from the list of possible production nodes and confirm by clicking on “OK”.

4.      Define the “Number of columns” property by entering “2” in the “Value” field of the “Number of columns” property (you must surround the number by double quotes).

5.      Select the “Group” group you have just created.

6.      Click on the  icon.

7.      Select “Table body” from the list of possible production nodes and confirm by clicking on “OK”.

8.      Select the “Table body” table body you have just created.

9.      Click on the  icon.

10.  Select “Row” from the list of possible production nodes and confirm by clicking on “OK”. This will created the header line.

11.  Select the “Row” row you have just created.

12.  Click on the  icon.

13.  Select “Cell” from the list of possible production nodes and confirm by clicking on “OK”.

14.  Define the “Value” property by entering "Name" in the “Value” field associated with the “Value” property of the cell. Please note that Name must be surrounded by double quotes.

15.  Repeat steps 11 to 14, but this time define the “Value” property of the cell by entering "Description". Please note that Description must be surrounded by double quotes.

 

The result of these operations is shown in Figure 56 below.

 

Figure 56. The documentation template we have built so far

 

 

To finish, carry out the following steps:

1.      Select the “Table body” table body you have just created.

2.      Click on the  icon.

3.      Select “Row” from the list of possible production nodes and confirm by clicking on “OK”.

4.      Select the “Row” row you have just created.

5.      Click on the  icon.

6.      Select “Cell” from the list of possible production nodes and confirm by clicking on “OK”.

7.      Define the “Value” property by entering “Name” in the “Value” field associated with the “Value” property of the cell (please note that Name must be entered without double quotes before and after it). For more information on entering J code, please see “Inserting J code”.

8.      Repeat steps 4 to 6.

9.      Select the second “Cell” cell you have just created.

10.  Click on the  icon.

11.  Select “Media object” from the list of possible production nodes and confirm by clicking on “OK”.

12.  Select the “Media object” media object you have just created.

13.  Click on the  icon.

14.  Select “Image object” from the list of possible production nodes and confirm by clicking on “OK”.

15.  Select the “Image object” image object you have just created.

16.  Click on the  icon.

17.  Select “Image data” from the list of possible production nodes and confirm by clicking on “OK”.

 

 

The result of these operations is shown in Figure 57 below.

 

Figure 57. The completed documentation template