public inbox for gentoo-commits@lists.gentoo.org
 help / color / mirror / Atom feed
From: "Ulrich Müller" <ulm@gentoo.org>
To: gentoo-commits@lists.gentoo.org
Subject: [gentoo-commits] proj/devmanual:master commit in: appendices/devbook-guide/
Date: Wed, 15 Jan 2020 21:29:59 +0000 (UTC)	[thread overview]
Message-ID: <1579123726.3a84fac87dd431fbfbdddf51dcf34e6bcc71b6c6.ulm@gentoo> (raw)

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>&lt;include href="foo/"/&gt;</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>&lt;contentsTree&gt;</c>.
+Typically, this tag would be the only element in its own section body, as in
+the following example:
+</p>
+
+<codesample lang="sgml">
+&lt;section&gt;
+&lt;title&gt;Contents&lt;/title&gt;
+&lt;body&gt;
+&lt;contentsTree/&gt;
+&lt;/body&gt;
+&lt;/section&gt;
+</codesample>
+
 </body>
 </subsection>
 <subsection>


             reply	other threads:[~2020-01-15 21:30 UTC|newest]

Thread overview: 30+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-01-15 21:29 Ulrich Müller [this message]
  -- strict thread matches above, loose matches on Subject: below --
2024-10-31 18:59 [gentoo-commits] proj/devmanual:master commit in: appendices/devbook-guide/ Ulrich Müller
2024-10-25 11:21 Ulrich Müller
2024-05-08  5:57 Ulrich Müller
2023-11-05 16:48 Ulrich Müller
2023-11-05 16:45 Ulrich Müller
2023-10-05 20:29 Ulrich Müller
2022-02-16 18:56 Ulrich Müller
2021-07-31 17:59 Ulrich Müller
2021-03-19 19:23 Ulrich Müller
2021-03-19 19:23 Ulrich Müller
2021-03-19 19:22 Ulrich Müller
2021-03-12 19:32 Ulrich Müller
2021-03-11 11:24 Ulrich Müller
2020-12-14 19:35 Ulrich Müller
2020-08-21 16:53 Ulrich Müller
2020-03-06 16:30 Ulrich Müller
2020-03-06 16:30 Ulrich Müller
2020-03-01 12:32 Ulrich Müller
2020-02-22 21:27 Ulrich Müller
2020-01-28  5:55 Ulrich Müller
2020-01-16 18:50 Ulrich Müller
2020-01-15 22:36 Ulrich Müller
2020-01-15 22:14 Ulrich Müller
2020-01-15 21:30 Ulrich Müller
2020-01-15 21:30 Ulrich Müller
2020-01-15 21:29 Ulrich Müller
2020-01-15 21:29 Ulrich Müller
2020-01-15 21:29 Ulrich Müller
2020-01-15 21:29 Ulrich Müller

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1579123726.3a84fac87dd431fbfbdddf51dcf34e6bcc71b6c6.ulm@gentoo \
    --to=ulm@gentoo.org \
    --cc=gentoo-commits@lists.gentoo.org \
    --cc=gentoo-dev@lists.gentoo.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox