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

[Lorenzo L. Ancora]

CVSROOT:        /web/www
Module name:    www
Changes by:     Lorenzo L. Ancora <lorenzoancora>       21/02/17 07:19:07

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

Log message:
        Fix corruption introduced by 1.8; new references and wordings; fix style

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

Patches:
Index: gnu-website-guidelines.html
===================================================================
RCS file: /web/www/www/server/staging/standards/gnu-website-guidelines.html,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -b -r1.11 -r1.12
--- gnu-website-guidelines.html 17 Feb 2021 11:17:21 -0000      1.11
+++ gnu-website-guidelines.html 17 Feb 2021 12:19:06 -0000      1.12
@@ -10,9 +10,9 @@
   Keeping the site design simple helps accomplish that.
 </p>
 
+<style>.summary li {list-style: none;}</style>
 <div class="summary">
-<hr class="no-display" />
-<h3 class="no-display">Table of Contents</h3>
+<h3>Table of Contents</h3>
 <ul>
   <li><a href="#GeneralGuidelines">1. General Guidelines</a></li>
   <li><a href="#CopyrightGuidelines">2. Copyright Guidelines</a></li>
@@ -40,8 +40,8 @@
 </div>
 
 <p>Please be considerate of all who access our web pages, and accommodate
-them, including those who use text-only browsers or old browsers, as well
-as those with slow connections.  We wish to prevent web designs that look
+them, including those who use devices with limited computing power, as well as
+those with slow Internet connections. We wish to prevent web designs that look
 great under one version of one browser, and ugly under many others.  Of
 course, please don't install any of the proprietary web browsers
 available if you don't already use them anyway.</p>
@@ -62,12 +62,12 @@
 href="mailto:gnu@gnu.org";>&lt;gnu@gnu.org&gt;</a>.</li>
 
 <li>The GNU website gives priority to software covered by either
-the GNU General Public License or GNU Lesser General Public
-License.</li>
+the <a href="/licenses/gpl-3.0.html">GNU General Public License</a> or
+<a href="/licenses/lgpl-3.0.en.html">GNU Lesser General Public 
License</a>.</li>
 
-<li>The GNU website is more interested in substance than style.
-The use of graphics should be minimized so pages load fast over
-slow links.</li>
+<li>The use of heavy graphics should be minimized so pages load fast over
+slow Internet connections. If an image slows down a page, consider using
+lossless compression.</li>
 
 <li>Offer a document in as many formats as the GNU Project has it.
 For an example, see <a href="/licenses/fdl.html">The GNU Free
@@ -101,7 +101,8 @@
 by the FSF.</li>
 
 <li>Generally, the use of JavaScript is not allowed.  Exceptions to
-this need to be reviewed and approved by the Chief GNUisance on a
+this need to be reviewed and approved by the
+<a href="/people/webmeisters.html"> Chief GNUisance</a> on a
 case-by-case basis.</li>
 </ul>
 
@@ -193,11 +194,14 @@
 
 <li id="NamingTranslations">If you translate your web page in different
 languages, please name the English file <code><var>article</var>.html</code>, 
and
-its translations <code><var>article</var>.<var>lang</var>.html</code>&mdash;
-<code><var>lang</var></code> should contain the two-letter language code from 
<a
-href="//www.loc.gov/standards/iso639-2/php/code_list.php">ISO 639</a>,
-and optionally an hyphen followed the two-letter country code given in
-ISO 3166 (lowercase).  For example, the German translation of 
<code>not-ipr.html</code>
+its translations <code><var>article.lang</var>.html</code>&mdash;
+<code><var>lang</var></code> should contain a two-letter code from <a
+href="https://www.loc.gov/standards/iso639-2/php/code_list.php";
+rel="noopener">ISO 639-1</a>,
+and optionally an hyphen followed by the two-letter <i>Alpha-2</i> country code
+given in
+<a href="https://www.iso.org/obp/ui/#search/code/"rel="noopener";>ISO 
3166-1</a>.
+For example, the German translation of <code>not-ipr.html</code>
 should be named <code>not-ipr.de.html</code>; the Brazilian Portuguese
 translation should be named <code>not-ipr.pt-br.html</code>.</li>
 </ul>
@@ -210,14 +214,19 @@
 <li>Hand-written URLs that refer to other files on www.gnu.org should be
 absolute, starting from the root page.  That is, paths should start
 with <code>/</code> (e.g., <code>/gnu/about-gnu.html</code>; <em>not</em>
-<code>http://www.gnu.org/gnu/about-gnu.html</code>, and <em>not</em>
+<code>http://www.gnu.org/gnu/about-gnu.html</code> nor
+<code>https://gnu.org/gnu/about-gnu.html</code>, and <em>not</em>
 <code>about-gnu.html</code>).  This makes it easier to copy and paste
 links from other pages.  Besides, links like
 <code>http://www.gnu.org/</code> will be wrong when the visitor uses
 HTTPS.</li>
 
-<li>Check if the linked host supports both HTTPS and HTTP and use
-protocol-relative URLs (e.g. <code>//www.example.org</code>) if it does.</li>
+<li>Check if the linked host supports HTTPS and always prefer HTTPS over HTTP
+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
+recommended when linking to external, 3rd-party domains.</li>
 
 <li>Collections of files produced automatically from Texinfo source
 contain links with relative file names.  They always refer to another
@@ -237,8 +246,10 @@
 <li>Be sure to omit the filename entirely when linking to an anchor in
 the same file and double-check that the anchor actually works.</li>
 
-<li>Consider others linking to your page when removing an anchor or
-<code>id</code> attribute.</li>
+<li>Consider others linking to your page when removing an <code>id</code>
+attribute from any header tag (<code>&lt;h1 id="example"&gt;&hellip;</code>,
+<code>&lt;h2&hellip;</code>, <code>&lt;h3&hellip;</code>, &hellip;) or
+anchor (e.g. <code>&lt;a id="example"&gt;#example&lt;/a&gt;</code>).</li>
 
 <li>We encourage FTP sites to use a directory for each package, and only put
 one package's files in each directory, so that the users can see what
@@ -259,10 +270,11 @@
 <a href="mailto:rms@gnu.org";>&lt;rms@gnu.org&gt;</a>
 </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 e-mail address they can use without
+to another web page and what is an
+<a href="https://tools.ietf.org/html/rfc6068"; rel="noopener">RFC6068</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 e-mail address they can use without
 going back to their web browser.  If the person doesn't have a web
 page, leave the name unanchored.</p></li>
 
@@ -283,12 +295,16 @@
 
 
 <ul class="para">
-<li>HTML on the GNU web server should be strictly compliant with
-<a href="//www.w3.org/standards/">W3C standards</a>.</li>
+<li>HTML 5 and CSS3 are preferred over older (X)HTML and CSS standards.</li>
+
+<li>All public pages of the GNU website should be strictly compliant with the
+<a href="https://www.w3.org/standards/";>W3C standards</a> and the subsets
+of HTML and CSS used must be composed only by official
+W3C Recommendations (RECs) supported by the most used web browsers.</li>
 
 <li>Please follow the above mentioned web standards strictly.  Don't
 neglect <a
-href="//www.w3.org/TR/html401/struct/global.html#h-7.1">required
+href="https://www.w3.org/TR/html401/struct/global.html#h-7.1";>required
 elements</a> such as <code>&lt;html&gt;</code>, <code>&lt;head&gt;</code>,
 <code>&lt;title&gt;</code>, <code>&lt;body&gt;</code>, etc. when using (X)HTML,
 and always include the appropriate DTD or Schema reference.
@@ -356,7 +372,7 @@
 from left to right, ignoring any tables that you make.  If you use
 tables, you should make sure that reading a whole
 page left to right doesn't confuse such software.  Please follow the
-<a href="//www.w3.org/WAI/">W3C web accessibility guidelines</a>
+<a href="https://www.w3.org/WAI/";>W3C web accessibility guidelines</a>
 to ensure that tables are properly marked for accessibility.</li>
 
 <li>Some people like to organize links as a menu to
@@ -388,7 +404,7 @@
 in it.</li>
 
 <li>The XHTML templated pages must follow the <a
-href="//www.w3.org/TR/xhtml1/">XHTML-1.0 guidelines</a>.</li>
+href="https://www.w3.org/TR/xhtml1/";>XHTML-1.0 guidelines</a>.</li>
 
 <li>Our server-side includes declare UTF-8 as the character encoding, so
 using any other encoding is problematic.</li>
@@ -488,7 +504,7 @@
 <li>Always have a textual alternative for in-line images, to ensure
 indexability by search engines and accessibility.  For instance:
 <p class="emph-box"><code>&lt;img src="/graphics/*.jpg"
-alt="&amp;nbsp;[DESCRIPTIVE TEXT]&amp;nbsp;"&gt;</code></p>
+title="[BRIEF TEXT]" alt="&amp;nbsp;[DESCRIPTIVE 
TEXT]&amp;nbsp;"&gt;</code></p>
 We add the non-breaking spaces (&amp;nbsp;) and square brackets to
 separate the DESCRIPTIVE TEXT from adjacent text, and help the user
 realize that this is a stand-in for an image.  The point of using
@@ -500,15 +516,16 @@
 when displayed at its original size, using the browser's default font
 size.</li>
 
-<li><p>Adjust image width or height in a style attribute, using scalable
-units such as <code>em</code> or <code>%</code>; for instance:</p>
+<li>Adjust image width or height in a style attribute, using scalable
+units such as <code>em</code> or <code>%</code>; for instance:
 
 <p class="emph-box"><code>&lt;img src="/graphics/*.jpg"
 alt="&amp;nbsp;[DESCRIPTIVE TEXT]&amp;nbsp;"
-style="width: 10em; height: auto;" /&gt;</code></p>
-
-<p>This way, the page will look the same if the reader increases or
-decreases font size.</p></li>
+style="width: 10em; height: auto;" width="77px" height="77px" /&gt;</code></p>
+This way, the page will look the same if the reader increases or
+decreases font size.<br>Specifying both <code>width</code> and
+<code>height</code> will reserve the space required for the image during
+the page loading phase.</li>
 
 <li>If you are adding a small floating image to a page that uses
 <code>layout.css</code> (the stylesheet for <a
@@ -539,16 +556,21 @@
 <p class="imgleft">
 <a href="/graphics/agnuhead.html"><img
    src="/graphics/gnu-head-sm.jpg"
-   alt="&nbsp;[Image of the Head of a GNU]&nbsp;"
-   style="width: 8em" /></a>
-</p>
+   title="Head of a GNU"
+   alt="&nbsp;[Black and white sketch of the Head of a GNU]&nbsp;"
+   style="width: 8em; height: auto"
+   width="129px" height="122px" />
+</a></p>
 
 <pre class="emph-box">
 &lt;p class="imgleft"&gt;
-&lt;a href="/graphics/agnuhead.html"&gt;
-&lt;img src="/graphics/gnu-head-sm.jpg"
-     alt="&nbsp;[Image of the Head of a GNU]&nbsp;"
-     style="width: 8em" /&gt;&lt;/a&gt;
+  &lt;a href="/graphics/agnuhead.html"&gt;
+    &lt;img src="/graphics/gnu-head-sm.jpg"
+          title="Head of a GNU"
+          alt="&nbsp;[Black and white sketch of the Head of a GNU]&nbsp;"
+          style="width: 8em; height: auto"
+          width="129px" height="122px" /&gt;
+  &lt;/a&gt;
 &lt;/p&gt;
 </pre>
 <div style="clear: both"></div>
@@ -721,11 +743,14 @@
 <h4 id="cvs">Basic CVS commands</h4>
 
 <ul class="para">
-<li>For reference manual, execute <kbd>info cvs</kbd>.</li>
+<li>For the offline reference manual, execute <kbd>info cvs</kbd>.</li>
 
 <li>
 Before the initial checkout, set the environment variable
-<code>CVS_RSH=ssh</code>.</li>
+<code>CVS_RSH=ssh</code>.<br>In alternative, you can replace
+<code>:ext:</code> with
+<a href="/software/trans-coord/manual/cvs/cvs.html#Connecting-with-rsh-or-ssh">
+<code>:extssh:</code></a> to use an external ssh program.</li>
 
 <li>
 <p>If you have write access to www, check out the main www repository
@@ -878,9 +903,10 @@
 symlinks to redirect to and from HTML files whose names look like
 translations, that is, <code><var>page</var>.<var>ll</var>.html</code> or
 <code><var>page</var>.<var>ll</var>-<var>cc</var>.html</code>, where
-<var>ll</var> and <var>cc</var> are two-letter
-codes.  When you need such redirections, use the <a
-href="#htaccess">htaccess mechanism</a>.</p>
+<var>ll</var> and <var>cc</var> are two-letter codes, as seen in
+the <a href="#filenames">Filenames</a> section.
+When you need such redirections, use the
+<a href="#htaccess">htaccess mechanism</a>.</p>
 
 <p>These days, the .symlinks handling happens on www.gnu.org
 via a cron job that runs twice an hour.  Webmasters do not have
@@ -900,6 +926,9 @@
   url=https://www.gnu.org/<var>target</var>"&gt;
 </code></p>
 
+However, the latter must be implemented so as
+<a href="https://www.w3.org/WAI/WCAG21/Techniques/failures/F41";
+rel="noopener">WCAG 2.1 F41</a> does not occur in any circumstance.
 
 <h4 id="scripts">Server-side scripts</h4>
 
@@ -923,19 +952,25 @@
 <li>Outside gnu.org:
   <ul>
     <li>We follow the guidelines of the <a
-    href="//www.anybrowser.org/campaign/">Best Viewed with Any
-    Browser</a> campaign.</li>
-
-    <li>Basic info on the web and its technical specifications can be
-    found at <a href="//www.w3.org/">The World Wide Web
-    Consortium</a>.</li>
-
-    <li>The GNU web server follows the w3.org <a
-    href="//www.w3.org/Provider/Style/Overview.html">Style
-    Guide</a>.</li>
-
-    <li>Use of <a href="//w3.org/TR/WCAG21/">WCAG 2.1</a> helps
-    ensure accessibility for a wide range of people with disabilities.</li>
+    href="https://www.anybrowser.org/campaign/"; rel="noopener"
+    style="text-decoration: none;">
+      <img src="../graphics/icons/anybrowser.png" width="96px" height="18px"
+      title="Visit the 'Best Viewed on Any Browser' campaign website"
+      alt="Best Viewed on Any Browser"
+      style="vertical-align: middle" /></a>
+      campaign.</li>
+
+    <li>Use of <a href="https://w3.org/TR/2021/SPSD-html52-20210128/";
+    rel="noopener">HTML&nbsp;5.2</a> allows for consistent backwards
+    compatibility among web browsers.</li>
+
+    <li>Use of <a href="https://www.w3.org/TR/2020/NOTE-css-2020-20201222/";
+    rel="noopener">CSS3 RECs</a> in place of WDs and CRs allows for stable
+    cross-browser styling.</li>
+
+    <li>Use of <a href="https://www.w3.org/TR/2018/REC-WCAG21-20180605/";
+    rel="noopener">WCAG&nbsp;2.1</a> ensures accessibility for a wide range of
+    people with disabilities.</li>
   </ul>
 </li>
 
@@ -1037,7 +1072,7 @@
 
 <p class="unprintable">Updated:
 <!-- timestamp start -->
-$Date: 2021/02/17 11:17:21 $
+$Date: 2021/02/17 12:19:06 $
 <!-- timestamp end --></p>
 </div>
 </div><!-- for class="inner", starts in the banner include -->