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>
