www/server/staging/standards gnu-website-guidel...

[Therese Godefroy]

CVSROOT:        /webcvs/www
Module name:    www
Changes by:     Therese Godefroy <th_g> 21/02/23 11:44:51

Modified files:
        server/staging/standards: gnu-website-guidelines.html 

Log message:
        More rewriting and small edits.

CVSWeb URLs:
http://web.cvs.savannah.gnu.org/viewcvs/www/server/staging/standards/gnu-website-guidelines.html?cvsroot=www&r1=1.19&r2=1.20

Patches:
Index: gnu-website-guidelines.html
===================================================================
RCS file: /webcvs/www/www/server/staging/standards/gnu-website-guidelines.html,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -b -r1.19 -r1.20
--- gnu-website-guidelines.html 23 Feb 2021 13:49:58 -0000      1.19
+++ gnu-website-guidelines.html 23 Feb 2021 16:44:51 -0000      1.20
@@ -249,7 +249,7 @@
 when the former is supported and has a valid certificate (this is expressed by
 a locked/green lock on most web browsers).</li>
 
-<li>Protocol-relative URLs (e.g. <code>//www.example.org</code>) are not
+<li>Protocol-relative URLs (e.g., <code>//www.example.org</code>) are not
 recommended when linking to external, third-party domains.</li>
 
 <li>Collections of files produced automatically from Texinfo source
@@ -272,8 +272,8 @@
 
 <li>Consider others linking to your page when either removing an element
 that carries an <code>id</code> attribute, or changing an <code>id</code>.
-Place the old one on a block element nearby. If there is none, create one.
-Here is a typical example from the Philosophy main page:
+Place the old one on a block element nearby. If there is no suitable
+element, add one. Here is a typical example from the Philosophy main page:
 
 <pre class="emph-box">
 <samp>&lt;!-- please leave both these ID attributes here. ... --&gt;
@@ -297,11 +297,20 @@
 URL does not need updating, on this and other sites, as new
 versions are released into that directory.</li>
 
-<li><p>Cite people with e-mail addresses this way:</p>
-<p class="emph-box"><code>
-&lt;a href="https://www.stallman.org/"&gt;Richard Stallman&lt;/a&gt;
-&lt;a href="mailto:rms@gnu.org"&gt;&amp;lt;rms@gnu.org&amp;gt;&lt;/a&gt;
-</code></p>
+<li>Place angle brackets around <code>mailto:</code> anchors (which will
+bring up a mail form to fill out and send, if this is supported by the
+client) to clearly distinguish them from hypertext links.  See
+<a href="https://tools.ietf.org/html/rfc6068#section-6";>RFC 6068</a> for
+advanced examples of how to use mailto URIs to specify a subject, the
+body, etc.</li>
+
+<li>When citing people, place the <code>mailto:</code> anchor next to
+their name, so that the email address is retained in printed copies of
+the page; for example,
+<pre class="emph-box">
+<samp>&lt;a href="https://www.stallman.org/"&gt;Richard 
Stallman&lt;/a&gt;</samp>
+<samp>&lt;a 
href="mailto:rms@gnu.org"&gt;&amp;lt;rms@gnu.org&amp;gt;&lt;/a&gt;</samp>
+</pre>
 <p>which browsers display this way:</p>
 <p class="emph-box" style="background-color: inherit">
     <samp>
@@ -309,17 +318,8 @@
         <a href="mailto:rms@gnu.org";>&lt;rms@gnu.org&gt;</a>
     </samp>
 </p>
-<p>It is less confusing to the user, because it's clear what is a link
-to another web page and what is a
-<code>mailto:</code> anchor that will bring up a mail form to fill out
-and send, if this is supported by the client.  Also, if users save a copy
-of the page, they will have a copy of the email address they can use without
-going back to their web browser.  If the person doesn't have a web
-page, leave the name unanchored.  See
-<a href="https://tools.ietf.org/html/rfc6068#section-6";>RFC 6068</a> for
-advanced examples of how to use mailto URIs to specify a subject, the
-body, etc.
-</p></li>
+<p>If the person doesn't have a web page, leave the name unanchored.</p>
+</li>
 
 <li>When embedding static resources like videos that are not in
 the <code>www</code> CVS repository along with the rest of the
@@ -391,16 +391,16 @@
 
 <li>Acronyms/abbreviations:
   <ul>
+      <li>Never use <code>&lt;acronym&gt;</code>: HTML&nbsp;5 obsoletes it in
+      favor of <code>&lt;abbr&gt;</code>. The latter must be expanded in a
+      <code>title</code> attribute.</li>
+
       <li>When an abbreviation may be unfamiliar to a reader, give its
       expansion <i>only the first time</i> it is used in a document.<br />
       Example: <code>&lt;abbr title="Expanded
       Abbreviation"&gt;EA&lt;/abbr&gt;</code> or <code>EA
       (Expanded Abbreviation)</code>.</li>
 
-      <li>Never use <code>&lt;acronym&gt;</code>: HTML&nbsp;5 obsoletes it in
-      favor of <code>&lt;abbr&gt;</code>. The latter must be expanded in a
-      <code>title</code> attribute.</li>
-
       <li>Make sure <code>&lt;abbr&gt;</code> is styled via CSS to meet the
       accessibility guidelines.  By default some browsers render it in an
       ugly way.</li>
@@ -459,8 +459,8 @@
 <li>The templated pages must follow the <a
 href="https://www.w3.org/TR/xhtml1/";>XHTML-1.0 guidelines</a>.</li>
 
-<li>Our <abbr title="Server-Side Includes">SSIs</abbr> declare UTF-8 as the
-character encoding, so using any other encoding is problematic.<br />See the
+<li>Our <abbr title="Server-Side Includes">SSI</abbr>s declare UTF-8 as the
+character encoding; using any other encoding is problematic.<br />See the
 <a href="https://httpd.apache.org/docs/current/howto/ssi.html";>
     Introduction to Apache SSIs</a> to learn more on this topic.</li>
 </ul>
@@ -501,7 +501,7 @@
 style applies to a single element, it should normally be added as an 
attribute.</li>
 
 <li>If you specify any color attribute in the HTML, you should specify all of
-them that are allowed for that tag.  This is because some browsers
+them that are allowed for that element.  This is because some browsers
 allow users to specify defaults for the color attributes, and the
 user's choices could conflict with your choices, as your choices
 override the user's choices.  In the worse case, the foreground and
@@ -539,7 +539,7 @@
 </ul>
 
 
-<h4 id="text-only">Text-only web browsers</h4>
+<h4 id="text-only">Text-only browsers</h4>
 
 <p>Even if the main web development target is composed by modern graphical web
 browsers, browsability through terminal web browsers is an indication of good
@@ -1291,7 +1291,7 @@
 
 <p class="unprintable">Updated:
 <!-- timestamp start -->
-$Date: 2021/02/23 13:49:58 $
+$Date: 2021/02/23 16:44:51 $
 <!-- timestamp end --></p>
 </div>
 </div><!-- for class="inner", starts in the banner include -->