For various reasons, the contributor documentation is more complex in structure than the user documentation. Particularly, pay attention to the following when working with the subteam documentation:
If you want to create an introductory paragraph that is shown on the subteam main page, simply do not wrap it inside a <section> element. Otherwise this will be chunked into a separate HTML file.
If you want a subsection of a section to be visible in the Table of Contents, add the <role="toc"> attribute for the <section> element. For an actual example, see the qa-* files.
The sections are chunked up to the first level; this means all direct <section> ascendants of <chapter> elements will be chunked into separate HTML files. If you want to avoid this (for example if your chapter is very short), insert the <?dbhtml stop-chunking?> after the <title> element of your chapter. Note that doing this will not stop the Table of Contents from being printed with each section. You can use the <simplesect> element again to hide sections from the Table of Contents. If you do this, make sure you don't insert any elements after the <simplesect> elements in your chapter, as this will invalidate the document.
 |
|
 |
| Editing the documentation |
|
Translations |