landmarks, skiplink, remove bad attrs, autocomplete search

rouilj · rouilj · commit 75807f3f1d56 · 2022-07-12T15:00:30.000-04:00
layout.html:
  Add main and nav landmarks to layout templte.
  Add skiplink to get to main.
  Remove Description meta tag from layout template in favor of
     description metadata in individual files.
  Remove obsolete border attribute from sourceforge logo.
  Add autocomplete="on" attribute for search input box.

doc/*.txt
  Remove language attribute from description meta tags.


These changes also occur for other files not in this commit. Thse
other files have changes to files for the 2.2.0 release not yet tobe
committed.
diff --git a/doc/admin_guide.txt b/doc/admin_guide.txt
@@ -1,5 +1,5 @@
 .. meta::
-    :description language=en:
+    :description:
         How to administer, backup, upgrade a Roundup installation.
         System and user security, configuring web compression,
         documentation on using roundup-server and running
diff --git a/doc/customizing.txt b/doc/customizing.txt
@@ -1,5 +1,5 @@
 .. meta::
-    :description language=en:
+    :description:
         How to customize and extend the Roundup Issue
         Tracker. Includes many cookbook and how-to
         examples. Reference for the design and internals
diff --git a/doc/features.txt b/doc/features.txt
@@ -1,5 +1,5 @@
 .. meta::
-    :description language=en:
+    :description:
         Features of using the Roundup Issue Tracker. Describes
         all access methods, configuration and workflow capabilities.
 	Links to detailed documentation.
diff --git a/doc/glossary.txt b/doc/glossary.txt
@@ -1,5 +1,5 @@
 .. meta::
-    :description language=en:
+    :description:
         Definitions of terms used in the Roundup Issue Tracker
 	documentation.
 
diff --git a/doc/index.txt b/doc/index.txt
@@ -1,5 +1,5 @@
 .. meta::
-    :description language=en:
+    :description:
         Table of contents for documentation on the Roundup Issue Tracker.
 
 =======================================================
diff --git a/doc/installation.txt b/doc/installation.txt
@@ -1,5 +1,5 @@
 .. meta::
-    :description language=en:
+    :description:
         Everything about installing the Roundup issue tracker web and
 	mail interfaces and configuring a tracker. How to download and
 	demonstrate Roundup using using command line or
diff --git a/doc/overview.txt b/doc/overview.txt
@@ -1,5 +1,5 @@
 .. meta::
-    :description language=en:
+    :description:
         Original proposal for the Roundup Issue Tracker. The problem
         it solves, and guiding principles. Presents the
         components of Roundup and how they interact.
diff --git a/doc/rest.txt b/doc/rest.txt
@@ -1,5 +1,5 @@
 .. meta::
-    :description language=en:
+    :description:
         Documentation on the RESTful interface to the Roundup Issue
 	Tracker.
 
diff --git a/doc/upgrading.txt b/doc/upgrading.txt
@@ -1,5 +1,5 @@
 .. meta::
-    :description language=en:
+    :description:
         Critical documentation on how to upgrade the Roundup Issue
 	Tracker. Actions that must or can be taken when upgrading from
 	one version to another are documented here.
diff --git a/doc/user_guide.txt b/doc/user_guide.txt
@@ -1,5 +1,5 @@
 .. meta::
-    :description language=en:
+    :description:
         Describes how to interact with and use a tracker with the
         Roundup Issue Tracker.
 
diff --git a/doc/xmlrpc.txt b/doc/xmlrpc.txt
@@ -1,5 +1,5 @@
 .. meta::
-    :description language=en:
+    :description:
         Documentation on the XMLRPC interface to the Roundup Issue
 	Tracker. Includes sample clients.
 
diff --git a/website/www/_static/style.css b/website/www/_static/style.css
@@ -161,3 +161,22 @@ div.highlight pre { overflow: auto;}
 }
 /* set background when using borland pygments style */
 div.highlight pre { background: lightyellow;}
+
+#skiplink { display: block;
+                   margin-block-start: 1em;
+                   margin-inline-start: 1em;}
+#skiplink a {
+  /* force stuff for screenreader off screen */
+  position:absolute;
+  left:-10000px;
+  top:auto;
+  width:1px;
+  height:1px;
+  overflow:hidden;
+  padding: 0 0.75em;
+  font-weight: bold;
+}
+#skiplink a:focus { position: static;
+                    width: auto;
+                    height: auto; }
+
diff --git a/website/www/_templates/layout.html b/website/www/_templates/layout.html
@@ -3,8 +3,6 @@
   <head>
     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1">
-    <meta name="Description"
-	  content="Documentation on the Roundup issue tracker, version {{ release|e }}.">
     {{ metatags }}
     {%- if builder != 'htmlhelp' %}
       {%- set titlesuffix = docstitle|e %}
@@ -65,12 +63,13 @@
 {%- block extrahead %} {% endblock %}
   </head>
   <body>
+    <div id="skiplink"><a href="#main">Skip to main content</a></div>
     <div class="header"><h1>Roundup</h1>
       {%- if pagename != "search" %}
         <div id="searchbox" style="display: none">
           <form class="search" action="{{ pathto('search') }}" method="get">
             <input type="text" aria-label="Enter search terms"
-		   name="q" size="18" />
+		   name="q" size="18" autocomplete="on" />
             <input type="submit" value="{{ _('Search') }}" />
             <input type="hidden" name="check_keywords" value="yes" />
             <input type="hidden" name="area" value="default" />
@@ -79,9 +78,11 @@
       {%- endif %}
     </div>
     <div class="navigation">
+      <nav>
       <div class="menu">
        {{ toctree() }}
       </div>
+      </nav>
     </div>
     <div class="content">
 	<div id="subnav">
@@ -96,7 +97,9 @@
         <a title="{{ _('Index') }}" href="{{ pathto('genindex') }}">
 	  Index</a>
 	</div>
+	<main id="main" tabindex="-1">
        {% block body %} {% endblock %}
+	</main>
     </div>
 {%- block footer %}
     <div class="footer">
@@ -114,7 +117,7 @@
       {%- if last_updated %}
         {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
       {%- endif %}
-      <span>Hosted by <a href="https://sourceforge.net"><img src="https://sflogo.sourceforge.net/sflogo.php?group_id=31577&amp;type=1" width="88" height="31" border="0" alt="SourceForge.net Logo" /></a></span>
+      <span>Hosted by <a href="https://sourceforge.net"><img src="https://sflogo.sourceforge.net/sflogo.php?group_id=31577&amp;type=1" width="88" height="31" alt="SourceForge.net Logo" /></a></span>
       </div>
     </div>
 {%- endblock %}
