Creating a list

We are now going to create a list, which will display the name and description of each attribute of a class, as shown in Figure 42 below.

Steps:

1. Select the “Class chapter” section.

2. Click on the icon.

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

4. Change the name of the new paragraph by simply selecting it, clicking on it once and entering the name “List of attributes”.

5. Define the “Title” property of the new itemized list by entering the following information in the “Value” field associated with the “Title” property: "Attributes" (please note that the double quotes are mandatory). For more information on entering J code, please see “Inserting J code”.

Figure 42. Creating an itemized list

For more information on creating production node, please see “Documentation templates”.

Continue by carrying out the steps shown in Figure 43.

Steps:

1. Select the “List of attributes” itemized list.

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

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

Figure 43. Creating the “Attributes” navigation node

For more information on creating navigation node, please see “Creating navigation nodes”.

Next, proceed with the steps shown in Figure 44, 45 and 46.

Steps:

1. Select the “Attributes” navigation node.

2. Click on the icon.

3. Select “List item” from the list of possible production nodes and confirm by clicking on “OK”. Please note that we have a general title for all list elements, and a list item for each attribute.

4. Change the name of the new paragraph by simply selecting it, clicking on it once and entering the name “Current attribute”.

Figure 44. Creating a list item

For more information on creating production node, please see “Documentation templates”.

Steps:

1. Select the “Current attribute” list item.

2. Click on the icon. The “Reference a template node” window then appears.

3. Select “Package documentation template/Package chapter/Description” to reference this node.

Figure 45. Selecting the “Description” node

4. Confirm by clicking on “OK”.

Figure 46. Referencing the “Description” paragraph for each attribute

For more information on referencing nodes, please see “Referencing nodes”.

Repeat the steps shown in Figures 42 to 46, but this time name your itemized list “List of operations” (the “Title” property has the value "Operations", please note that the double quotes are mandatory), your list item “Current operation” and select “Operations” as your navigation node.

Once you have carried out these operations, your documentation template will look like the one shown in Figure 47 below.

Figure 47. The documentation template we have built so far