Once you have downloaded the source, you should have a series of folders inside of the repository directory.
Place all files in a folder in the following format
/src/docbkx/content/XXXX. XXXX represents one of the thematic folders which are used to organize the documentation.Place images that you linked to in the
/dhis2docs/src/docbkx/XX/resources/imagesfolder. Link these inside your DocBook file using a relative file link. When the documentation is built, in a separate step, the images will be automatically copied over to the correct 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. |
|
|
r |
Reference |
This topic contains relevant reference information, for example operators and functions to use in program rule expressions. |
|
|
t |
Task |
This topic contains detailed step-by-step instructions of how to perform a task. |
|
|
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. |
|
|
wf |
- |
This topic contains the process the user must go through to complete a complicated task, for example create a program rule. |
|
