diff options
author | Ulrich Müller <ulm@gentoo.org> | 2020-01-15 22:25:12 +0100 |
---|---|---|
committer | Ulrich Müller <ulm@gentoo.org> | 2020-01-15 22:28:48 +0100 |
commit | e01f0401b79a3de5a0bb29e98918ee72cef249c7 (patch) | |
tree | b2eb578a9010d1d74b65226a5dbc08e46471f700 /appendices | |
parent | devbook-guide: Rename from "GuideXML guide" to "DevBook XML guide". (diff) | |
download | devmanual-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.xml | 21 |
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><version></c>, <c><date></c>, <c><title></c>, -<c><th></c>, <c><ti></c>, -<c><li></c>, <c><i></c>, <c><e></c>, -<c><uri></c>, <c><path></c>, <c><b></c>, <c><c></c>, -<c><mail></c>. +<c><title></c>, +<c><th></c>, <c><ti></c>, <c><li></c>, +<c><dt></c>, <c><dd></c>, +<c><b></c>, <c><c></c>, <c><e></c>, <c><d/></c>, +<c><uri></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><pre></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><pre></c> elements within 80 -columns to help console users. +<c><pre></c> and <c><codesample></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><pre></c> and <c><codesample></c> elements within 80 columns +to help console users. </p> <p> |