aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUlrich Müller <ulm@gentoo.org>2020-01-15 22:25:12 +0100
committerUlrich Müller <ulm@gentoo.org>2020-01-15 22:28:48 +0100
commite01f0401b79a3de5a0bb29e98918ee72cef249c7 (patch)
treeb2eb578a9010d1d74b65226a5dbc08e46471f700 /appendices
parentdevbook-guide: Rename from "GuideXML guide" to "DevBook XML guide". (diff)
downloaddevmanual-e01f0401b79a3de5a0bb29e98918ee72cef249c7.tar.gz
devmanual-e01f0401b79a3de5a0bb29e98918ee72cef249c7.tar.bz2
devmanual-e01f0401b79a3de5a0bb29e98918ee72cef249c7.zip
devbook-guide: Update "Internal Coding Style" section.
Describe only the tags that are actually used in DevBook XML. Signed-off-by: Ulrich Müller <ulm@gentoo.org>
Diffstat (limited to 'appendices')
-rw-r--r--appendices/devbook-guide/text.xml21
1 files changed, 11 insertions, 10 deletions
diff --git a/appendices/devbook-guide/text.xml b/appendices/devbook-guide/text.xml
index 35ecace..b14a2a7 100644
--- a/appendices/devbook-guide/text.xml
+++ b/appendices/devbook-guide/text.xml
@@ -546,11 +546,11 @@ Both sections are described next.
<p>
<b>Newlines</b> must be placed immediately after <e>every</e> DevBook XML tag
(both opening as closing), except for:
-<c>&lt;version&gt;</c>, <c>&lt;date&gt;</c>, <c>&lt;title&gt;</c>,
-<c>&lt;th&gt;</c>, <c>&lt;ti&gt;</c>,
-<c>&lt;li&gt;</c>, <c>&lt;i&gt;</c>, <c>&lt;e&gt;</c>,
-<c>&lt;uri&gt;</c>, <c>&lt;path&gt;</c>, <c>&lt;b&gt;</c>, <c>&lt;c&gt;</c>,
-<c>&lt;mail&gt;</c>.
+<c>&lt;title&gt;</c>,
+<c>&lt;th&gt;</c>, <c>&lt;ti&gt;</c>, <c>&lt;li&gt;</c>,
+<c>&lt;dt&gt;</c>, <c>&lt;dd&gt;</c>,
+<c>&lt;b&gt;</c>, <c>&lt;c&gt;</c>, <c>&lt;e&gt;</c>, <c>&lt;d/&gt;</c>,
+<c>&lt;uri&gt;</c>.
</p>
<p>
@@ -564,11 +564,12 @@ Both sections are described next.
<p>
<b>Word-wrapping</b> must be applied at 80 characters except inside
-<c>&lt;pre&gt;</c>. You may only deviate from this rule when there is no other
-choice (for instance when a URL exceeds the maximum amount of characters). The
-editor must then wrap whenever the first whitespace occurs. You should try to
-keep the <e>rendered</e> content of <c>&lt;pre&gt;</c> elements within 80
-columns to help console users.
+<c>&lt;pre&gt;</c> and <c>&lt;codesample&gt;</c>. You may only deviate from
+this rule when there is no other choice (for instance when a URL exceeds the
+maximum amount of characters). The editor must then wrap whenever the first
+whitespace occurs. You should try to keep the <e>rendered</e> content of
+<c>&lt;pre&gt;</c> and <c>&lt;codesample&gt;</c> elements within 80 columns
+to help console users.
</p>
<p>