21.5. Editing the documentation

Once you have downloaded the source, you should have a series of folders inside of the repository directory.

Table 21.1. File naming conventions for modularization

File prefix

Topic type

Description

Example

c

Concept

This topic contains a short description about the feature.

c_pg_rule.xml

r

Reference

This topic contains relevant reference information, for example operators and functions to use in program rule expressions.

r_pg_indicator_expression.xml

t

Task

This topic contains detailed step-by-step instructions of how to perform a task.

t_pg_rule_create.xml

toc

-

This topic contains the xi:include links that together create a complete section.

You shouldn't mix xi:include links and content in the same topic.

toc_pg_rule.xml

wf

-

This topic contains the process the user must go through to complete a complicated task, for example create a program rule.

wf_pg_rule.xml


Example 21.1. File naming of program rule topics