public inbox for gentoo-commits@lists.gentoo.org
 help / color / mirror / Atom feed
From: "Ulrich Müller" <ulm@gentoo.org>
To: gentoo-commits@lists.gentoo.org
Subject: [gentoo-commits] proj/devmanual:master commit in: appendices/contributing/devbook-guide/
Date: Mon,  9 Dec 2019 21:39:56 +0000 (UTC)	[thread overview]
Message-ID: <1575804725.6a1c35efce4347c22c94680e39a84d3f1df794d0.ulm@gentoo> (raw)

commit:     6a1c35efce4347c22c94680e39a84d3f1df794d0
Author:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
AuthorDate: Wed Dec  4 17:25:41 2019 +0000
Commit:     Ulrich Müller <ulm <AT> gentoo <DOT> org>
CommitDate: Sun Dec  8 11:32:05 2019 +0000
URL:        https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=6a1c35ef

devbook-guide: Don't mention caption as attribute of <pre>.

Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org>

 appendices/contributing/devbook-guide/text.xml | 15 +++++----------
 1 file changed, 5 insertions(+), 10 deletions(-)

diff --git a/appendices/contributing/devbook-guide/text.xml b/appendices/contributing/devbook-guide/text.xml
index 5aa5525..672a083 100644
--- a/appendices/contributing/devbook-guide/text.xml
+++ b/appendices/contributing/devbook-guide/text.xml
@@ -189,7 +189,7 @@ This is a paragraph.  &lt;path&gt;/etc/passwd&lt;/path&gt; is a file.
 Type &lt;c&gt;ls&lt;/c&gt; if you feel like it.  I &lt;e&gt;really&lt;/e&gt; want to go to sleep now.
 &lt;/p&gt;
 
-&lt;pre caption="Code Sample"&gt;
+&lt;pre&gt;
 This is text output or code.
 # &lt;i&gt;this is user input&lt;/i&gt;
 
@@ -257,12 +257,11 @@ only tags that should appear immediately inside a <c>&lt;body&gt;</c> element.
 Another thing -- these tags <e>should not</e> be stacked -- in other words,
 don't put a <c>&lt;note&gt;</c> element inside a <c>&lt;p&gt;</c> element. As
 you might guess, the <c>&lt;pre&gt;</c> element preserves its whitespace
-exactly, making it well-suited for code excerpts.  You must name the
-<c>&lt;pre&gt;</c> tag with a <c>caption</c> attribute:
+exactly, making it well-suited for code excerpts:
 </p>
 
 <codesample lang="sgml"><!-- Named &lt;pre&gt; -->
-&lt;pre caption="Output of uptime"&gt;
+&lt;pre&gt;
 # &lt;i&gt;uptime&lt;/i&gt;
 16:50:47 up 164 days,  2:06,  5 users,  load average: 0.23, 0.20, 0.25
 &lt;/pre&gt;
@@ -551,8 +550,8 @@ and the attribute value. As an example:
 </p>
 
 <codesample lang="sgml"><!-- Attributes -->
-Wrong  :     &lt;pre caption = "Attributes"&gt;
-Correct:     &lt;pre caption="Attributes"&gt;
+Wrong  :     &lt;uri link = "https://forums.gentoo.org/"&gt;
+Correct:     &lt;uri link="https://forums.gentoo.org/"&gt;
 </codesample>
 
 </body>
@@ -580,10 +579,6 @@ with a capital letter.
 &lt;/ul&gt;
 </codesample>
 
-<p>
-Code Listings should <e>always</e> have a <c>caption</c>.
-</p>
-
 <p>
 Try to use <c>&lt;uri&gt;</c> with the <c>link</c> attribute as much as
 possible. In other words, the <uri link="https://forums.gentoo.org">Gentoo


             reply	other threads:[~2019-12-09 21:40 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-12-09 21:39 Ulrich Müller [this message]
  -- strict thread matches above, loose matches on Subject: below --
2019-12-26 21:36 [gentoo-commits] proj/devmanual:master commit in: appendices/contributing/devbook-guide/ Ulrich Müller
2019-12-26 21:36 Ulrich Müller
2019-12-09 21:39 Ulrich Müller
2019-11-29  9:28 Ulrich Müller
2019-03-19 20:25 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=1575804725.6a1c35efce4347c22c94680e39a84d3f1df794d0.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