Creating sections

Creating a new section

The next step in our example is to create a section in our documentation template. The aim of this section is to create a chapter for the package on which the template is executed. This operation is illustrated in Figure 36.

Steps:

1. Select the documentation template root in the “Documentation template creation” window.

2. Click on the icon.

3. Select “Section” from the list of possible production nodes.

4. Change the name of the new section by simply selecting it, clicking on it once and entering the name “Package chapter”.

5. Define the “Title” property of the new section by entering the following information in the “Value” field associated with the “Title” property (on the top right of the window): "Package " + Name. Don't forget to leave a space after the word Package and before the double quote, so as to have a space between the word itself and the package name which will appear after it in the generated documentation. For more information on entering J code, please see “Inserting J code”.

Note: When defining the properties of a production node, you must use double quotes to surround the text that is not J code. In the example above, the word "Package" is not J code, and must, therefore, be surrounded by double quotes in the property value field.

Figure 36. Creating the “Package chapter” section

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