commit: 3a84fac87dd431fbfbdddf51dcf34e6bcc71b6c6 Author: Ulrich Müller <ulm <AT> gentoo <DOT> org> AuthorDate: Sat Jan 11 20:05:40 2020 +0000 Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org> CommitDate: Wed Jan 15 21:28:46 2020 +0000 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=3a84fac8
devbook-guide: Section on including sub-documents. Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org> appendices/devbook-guide/text.xml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/appendices/devbook-guide/text.xml b/appendices/devbook-guide/text.xml index 3b583f2..1e73104 100644 --- a/appendices/devbook-guide/text.xml +++ b/appendices/devbook-guide/text.xml @@ -122,6 +122,33 @@ any number of section elements of the next lower level. Skipping of levels is not allowed, e.g., a subsection cannot be directly below a chapter. </note> +</body> +</subsection> +<subsection> +<title>Including sub-documents</title> +<body> + +<p> +The manual is organized as a tree. Each directory contains one document, which +can include multiple sub-documents using the <c><include href="foo/"/></c> +tag. Note that the trailing slash in the <c>href</c> value is mandatory. +</p> + +<p> +A table of contents can be generated with <c><contentsTree></c>. +Typically, this tag would be the only element in its own section body, as in +the following example: +</p> + +<codesample lang="sgml"> +<section> +<title>Contents</title> +<body> +<contentsTree/> +</body> +</section> +</codesample> + </body> </subsection> <subsection>
