www-commits
[Top][All Lists]
Advanced
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

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

From: Therese Godefroy
Subject: www/server/staging/standards gnu-website-guidel...
Date: Thu, 25 Feb 2021 05:02:01 -0500 (EST) 
CVSROOT:        /webcvs/www
Module name:    www
Changes by:     Therese Godefroy <th_g> 21/02/25 05:02:01

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

Log message:
        [WIP] New section, 'Creating a New Page', made of
        - 'Filenames' (--> 'Naming the file')
        - 'Doctype and required HTML elements'
        - 'Page footer': 2 items about placing copyright & contact info at the
          bottom
        - 'Using our page template'.

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

Patches:
Index: gnu-website-guidelines.html
===================================================================
RCS file: /webcvs/www/www/server/staging/standards/gnu-website-guidelines.html,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -b -r1.25 -r1.26
--- gnu-website-guidelines.html 25 Feb 2021 09:26:45 -0000      1.25
+++ gnu-website-guidelines.html 25 Feb 2021 10:02:01 -0000      1.26
@@ -103,13 +103,6 @@
 Documentation License</a>.  This lets users get the document in the
 format most useful to them.</li>
 
-<li>In addition to <a href="#CopyrightGuidelines">copyright and license
-notices</a>, all pages should have contact info for both the FSF (or
-responsible party) and the address for bug reports (webmasters for
-general pages, but project-specific addresses otherwise) at the bottom
-of each page.  The reason to note this at the bottom is so the user
-always finds this information at the same place on each page.</li>
-
 <li>Before you take any graphics or text from another website,
 please ask for permission to use it.  It's polite to do so.  It is also
 essential for us to avoid copyright infringement.</li>
@@ -159,13 +152,6 @@
 modify, put the text &ldquo;Posted in 20XX without FSF permission to
 modify&rdquo; inside an HTML comment, just after the copyright notice.</li>
 
-<li>The user of our pages should always find the copyright information
-at the same place on each page.  If the page is copyrighted by some
-other person or entity, use per or its copyright notice instead of the
-FSF copyright notice.  Use the rest of the FSF's normal footer
-material, except when there is a specific reason to change something
-in it.</li>
-
 <li>All pages that explain how to do something, such as how to use
 certain programs, are documentation.  This includes all the pages in
 <code>/software/</code> that describe specific programs.  By our
@@ -223,9 +209,11 @@
 </ul>
 
 
-<a id="FilenameAndURLGuidelines"></a>
-<h3 id="filenames" class="subheader">4. Filenames</h3>
+<h3 id="new-page" class="subheader">2. Creating a New Page</h3>
+
 
+<a id="FilenameAndURLGuidelines"></a>
+<h4 id="filenames">Naming the file</h4>
 
 <ul class="para">
 <li>To make simultaneous edition of many files easier,
@@ -254,6 +242,90 @@
 </ul>
 
 
+<h4 id="html-required">Doctype and required HTML elements</h4> 
+
+<ul class="para"
+<li>Please follow the above mentioned web standards strictly, even when you are
+forced to follow superseded W3C recommendations: don't neglect
+<a 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> and <code>&lt;body&gt;</code> when using HTML 4,
+and always include the appropriate DTD or Schema reference in all markup
+standards older than HTML 5.
+This appeases overly pedantic web browsers.</li>
+
+<li>Do not add <code>&lt;!-- comments --&gt;</code> at the top of a
+document.  Old web browsers expect the doctype, XML declaration, or Schema to 
be
+at the top.  Comments will confuse them, and often cause them to
+incorrectly interpret your markup.<br />
+If you <i>must</i> add a comment before <code>&lt;!DOCTYPE html></code>, then
+use <code>&lt;!--[if !IE]> comments &lt;![endif]--></code>.</li>
+
+<li>The <code>&lt;head&gt;</code> element should contain this line:
+<p class="emph-box">
+<code>&lt;link rel="author" href="mailto:webmasters@gnu.org"&gt;</code></p>
+Some browsers use this information to allow users to easily report
+problems they find on a page.</li>
+
+<li>The first header tag, generally <code>&lt;h1&gt;</code> or 
<code>&lt;h2&gt;</code>, should have
+its text duplicated at the start of the <code>&lt;title&gt;</code> tag.
+The <code>&lt;title&gt;</code> tag
+is used by many browsers in menus like the history and bookmarks lists,
+as a link to that page.  Repeating the main heading in the
+<code>&lt;title&gt;</code> ensures that, when
+users click on an item in these menus, they get a page with the expected
+heading.  Please properly use your headers in numerical order: 1, 2,
+etc.  These are not used for looks, but for the organization of the
+document.</li>
+
+<li>The <code>&lt;title&gt;</code> tag should include the
+phrases <i>&ldquo;GNU Project&rdquo;</i>
+and <i>&ldquo;Free Software Foundation&rdquo;</i> so the pages can be better
+indexed by external search engines.  The default is to add this at the
+end: <code> - GNU Project - Free Software Foundation</code>.</li>
+
+
+<h4 id="page-footer">Page footer</h4>
+
+<ul class="para">
+<li>The user of our pages should always find the copyright information
+at the same place on each page.  If the page is copyrighted by some
+other person or entity, use per or its copyright notice instead of the
+FSF copyright notice.  Use the rest of the FSF's normal footer
+material, except when there is a specific reason to change something
+in it.</li>
+
+<li>In addition to <a href="#CopyrightGuidelines">copyright and license
+notices</a>, all pages should have contact info for both the FSF (or
+responsible party) and the address for bug reports (webmasters for
+general pages, but project-specific addresses otherwise) at the bottom
+of each page.  The reason to note this at the bottom is so the user
+always finds this information at the same place on each page.</li>
+</ul>
+
+<h4 id="templating">Using our page template</h4>
+
+<ul class="para">
+<li>To help people follow the above guidelines, a page template (or
+&ldquo;boilerplate&rdquo;) is provided for both the main part of the GNU
+website, and the software projects.  Its use is mandatory for new pages in
+www.gnu.org, and highly recommended for software pages.  Please don't start
+out with an existing page to create a new one; use the <a
+href="//web.cvs.savannah.gnu.org/viewvc/*checkout*/www/server/standards/
+boilerplate.html?root=www&amp;content-type=text%2Fplain">
+original source</a> of the boilerplate instead, and follow the instructions
+in it.</li>
+
+<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 Include">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>
+
+
 <h3 id="urls" class="subheader">5. URLs</h3>
 
 
@@ -349,49 +421,6 @@
 </ul>
 
 
-<h4 id="html-required">Doctype and required HTML elements</h4> 
-
-<ul class="para"
-<li>Please follow the above mentioned web standards strictly, even when you are
-forced to follow superseded W3C recommendations: don't neglect
-<a 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> and <code>&lt;body&gt;</code> when using HTML 4,
-and always include the appropriate DTD or Schema reference in all markup
-standards older than HTML 5.
-This appeases overly pedantic web browsers.</li>
-
-<li>Do not add <code>&lt;!-- comments --&gt;</code> at the top of a
-document.  Old web browsers expect the doctype, XML declaration, or Schema to 
be
-at the top.  Comments will confuse them, and often cause them to
-incorrectly interpret your markup.<br />
-If you <i>must</i> add a comment before <code>&lt;!DOCTYPE html></code>, then
-use <code>&lt;!--[if !IE]> comments &lt;![endif]--></code>.</li>
-
-<li>The <code>&lt;head&gt;</code> element should contain this line:
-<p class="emph-box">
-<code>&lt;link rel="author" href="mailto:webmasters@gnu.org"&gt;</code></p>
-Some browsers use this information to allow users to easily report
-problems they find on a page.</li>
-
-<li>The first header tag, generally <code>&lt;h1&gt;</code> or 
<code>&lt;h2&gt;</code>, should have
-its text duplicated at the start of the <code>&lt;title&gt;</code> tag.
-The <code>&lt;title&gt;</code> tag
-is used by many browsers in menus like the history and bookmarks lists,
-as a link to that page.  Repeating the main heading in the
-<code>&lt;title&gt;</code> ensures that, when
-users click on an item in these menus, they get a page with the expected
-heading.  Please properly use your headers in numerical order: 1, 2,
-etc.  These are not used for looks, but for the organization of the
-document.</li>
-
-<li>The <code>&lt;title&gt;</code> tag should include the
-phrases <i>&ldquo;GNU Project&rdquo;</i>
-and <i>&ldquo;Free Software Foundation&rdquo;</i> so the pages can be better
-indexed by external search engines.  The default is to add this at the
-end: <code> - GNU Project - Free Software Foundation</code>.</li>
-
-
 <h4 id="abbreviations">Acronyms and abbreviations</h4>
 
 <ul class="para">
@@ -444,29 +473,6 @@
 </ul>
 
 
-<h4 id="templating">Using our page template</h4>
-
-<ul class="para">
-<li>To help people follow the above guidelines, a page template (or
-&ldquo;boilerplate&rdquo;) is provided for both the main part of the GNU
-website, and the software projects.  Its use is mandatory for new pages in
-www.gnu.org, and highly recommended for software pages.  Please don't start
-out with an existing page to create a new one; use the <a
-href="//web.cvs.savannah.gnu.org/viewvc/*checkout*/www/server/standards/
-boilerplate.html?root=www&amp;content-type=text%2Fplain">
-original source</a> of the boilerplate instead, and follow the instructions
-in it.</li>
-
-<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 Include">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>
-
-
 <h3 id="styling" class="subheader">9. Page Styling</h3>
 
 
@@ -1305,7 +1311,7 @@
 
 <p class="unprintable">Updated:
 <!-- timestamp start -->
-$Date: 2021/02/25 09:26:45 $
+$Date: 2021/02/25 10:02:01 $
 <!-- timestamp end --></p>
 </div>
 </div><!-- for class="inner", starts in the banner include -->
reply via email to
[Prev in Thread] Current Thread [Next in Thread]