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: Fri, 19 Mar 2021 19:23:47 +0000 (UTC) [thread overview]
Message-ID: <1616181579.91b323cd575dff579191a767190e9d56ff255d44.ulm@gentoo> (raw)
commit: 91b323cd575dff579191a767190e9d56ff255d44
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Fri Mar 12 17:51:37 2021 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Fri Mar 19 19:19:39 2021 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=91b323cd
devbook-guide: Clearer section structure
Drop the "Devbook XML" section header which was not very useful.
Instead, promote "Basic structure" from subsection to section,
and introduce two new sections "Body elements" and "Inline elements".
So, the resulting section structure is:
DevBook XML design goals
Basic structure
Sections and subsections
Including sub-documents
An example <body>
Body elements
Code samples and colour-coding
Figures
Tables
Lists
Inline elements
<c>, <b>, and <e>
<uri>
Intra-document references
Coding Style
Internal Coding Style
External Coding Style
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
appendices/devbook-guide/text.xml | 16 ++++++++++------
1 file changed, 10 insertions(+), 6 deletions(-)
diff --git a/appendices/devbook-guide/text.xml b/appendices/devbook-guide/text.xml
index 28fbacd..64d1178 100644
--- a/appendices/devbook-guide/text.xml
+++ b/appendices/devbook-guide/text.xml
@@ -24,8 +24,6 @@ documents.
</section>
<section>
-<title>Devbook XML</title>
-<subsection>
<title>Basic structure</title>
<body>
@@ -71,7 +69,7 @@ All tags must be closed of course, so the document ends with:
</codesample>
</body>
-</subsection>
+
<subsection>
<title>Sections and subsections</title>
<body>
@@ -221,8 +219,10 @@ This is a warning.
</body>
</subsection>
-<subsection>
-<title>The <body> tags</title>
+</section>
+
+<section>
+<title>Body elements</title>
<body>
<p>
@@ -248,7 +248,7 @@ preserve their whitespace exactly, making them well-suited for code excerpts:
</codesample>
</body>
-</subsection>
+
<subsection>
<title>Code samples and colour-coding</title>
<body>
@@ -454,6 +454,10 @@ together:
</body>
</subsection>
+</section>
+
+<section>
+<title>Inline elements</title>
<subsection>
<title><c>, <b>, and <e></title>
<body>
next reply other threads:[~2021-03-19 19:23 UTC|newest]
Thread overview: 33+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-19 19:23 Ulrich Müller [this message]
-- strict thread matches above, loose matches on Subject: below --
2025-09-09 5:10 [gentoo-commits] proj/devmanual:master commit in: appendices/devbook-guide/ Ulrich Müller
2025-06-22 9:29 Ulrich Müller
2025-06-15 14:06 Sam James
2024-10-31 18:59 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: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
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=1616181579.91b323cd575dff579191a767190e9d56ff255d44.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