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: <1579123724.46fe68d000cd1dfd48ddbb829ce8a3a1ad24e19f.ulm@gentoo> (raw)
commit: 46fe68d000cd1dfd48ddbb829ce8a3a1ad24e19f
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Sat Jan 11 09:03:49 2020 +0000
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Wed Jan 15 21:28:44 2020 +0000
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=46fe68d0
devbook-guide: Make codesamples agree with their rendering.
Mention <figure> and <codesample> as subelements of <body>.
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>
appendices/devbook-guide/text.xml | 35 ++++++++++++++++++++---------------
1 file changed, 20 insertions(+), 15 deletions(-)
diff --git a/appendices/devbook-guide/text.xml b/appendices/devbook-guide/text.xml
index 025a8b1..5ae077b 100644
--- a/appendices/devbook-guide/text.xml
+++ b/appendices/devbook-guide/text.xml
@@ -135,18 +135,20 @@ an example <c><body></c> element:
<codesample lang="sgml"><!-- Example of a body element -->
<p>
-This is a paragraph. <path>/etc/passwd</path> is a file.
+This is a paragraph. <c>/etc/passwd</c> is a file.
<uri>https://forums.gentoo.org</uri> is my favorite website.
-Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now.
+Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now.
</p>
<pre>
This is text output or code.
-# <i>this is user input</i>
+# this is user input
+</pre>
+<codesample lang="sgml">
Make HTML/XML easier to read by using selective emphasis:
-<foo><i>bar</i></foo>
-</pre>
+&lt;foo&gt;bar&lt;/foo&gt;
+</codesample>
<note>
This is a note.
@@ -166,15 +168,17 @@ Now, here's how the <c><body></c> element above is rendered:
</p>
<p>
-This is a paragraph. <c>/etc/passwd</c> is a file.
+This is a paragraph. <c>/etc/passwd</c> is a file.
<uri>https://forums.gentoo.org</uri> is my favorite web site.
-Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now.
+Type <c>ls</c> if you feel like it. I <e>really</e> want to go to sleep now.
</p>
-<codesample lang="sgml"><!-- Code Sample -->
+<pre>
This is text output or code.
# this is user input
+</pre>
+<codesample lang="sgml">
Make HTML/XML easier to read by using selective emphasis:
<foo>bar</foo>
</codesample>
@@ -199,21 +203,22 @@ This is important.
<p>
We introduced a lot of new tags in the previous section <d/> here's what you
-need to know. The <c><p></c> (paragraph), <c><pre></c> (code block),
-<c><note></c>, <c><warning></c> (warning) and
-<c><important></c> (important) tags all can contain one or more lines of
-text. Besides the <c><table></c>, <c><ul></c>, <c><ol></c>
+need to know. The <c><p></c> (paragraph), <c><pre></c>
+(preformatted block), <c><codesample></c> (code block),
+<c><note></c>, <c><warning></c> and <c><important></c> tags
+all can contain one or more lines of text. Besides the <c><figure></c>,
+<c><table></c>, <c><ul></c>, <c><ol></c>
and <c><dl></c> elements (which we'll cover in just a bit), these are the
only tags that should appear immediately inside a <c><body></c> element.
Another thing <d/> these tags <e>should not</e> be stacked <d/> in other words,
don't put a <c><note></c> element inside a <c><p></c> element. As
-you might guess, the <c><pre></c> element preserves its whitespace
-exactly, making it well-suited for code excerpts:
+you might guess, the <c><pre></c> and <c><codesample></c> elements
+preserve their whitespace exactly, making them well-suited for code excerpts:
</p>
<codesample lang="sgml"><!-- Named <pre> -->
<pre>
-# <i>uptime</i>
+# uptime
16:50:47 up 164 days, 2:06, 5 users, load average: 0.23, 0.20, 0.25
</pre>
</codesample>
next 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=1579123724.46fe68d000cd1dfd48ddbb829ce8a3a1ad24e19f.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