govuk_tech_docs 2.0.5 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54582060cbb5418946468de3ee6f0107a683bbbdb70d0829983650043a55789c
-  data.tar.gz: 58249828f2d7b07ce75f7a7429c00084e20cb3af631d1416f8b9a43c2f82ea0a
+  metadata.gz: 3fc8ffc6ed311d6d660cb4a74861e65dac415ca396e47def8b9e6564cc58a6ed
+  data.tar.gz: 6d69b38114fe3853c7f3f3c379a87cdd50778563e885ba807503f0cb1af2025c
 SHA512:
-  metadata.gz: 361ab74bdaa5363f0405384b0aa15a04b604ad4d871cbb87055ef877e16579934fe070389a4abd9fda45b2cf9fc7093fa1782afb4d50bd448af5372d964898e3
-  data.tar.gz: 9bed0275d9a8757cf0ca3c8cf0dd672e152bae9844fc042223fd80479099cec18206e9be9313919e059b85586c1165a2bc6f08fa8ddbea3e74340ff54d2391f0
+  metadata.gz: 4e6127e6a526eb2d7683d29b5872101e6556c4df2d13ef45aaa5db26ac3ec4f06618bfec24a5966d6585d0f12806161600a4ab6bf9d79a8cf7736d27c287c795
+  data.tar.gz: bc119e8201e69cef00b2f6a97dc42f272f593c06ce8f1d82c055c38ff88650f2705d923d73dcdd1f980fcc3b08cbc5c277e143a2bc783a467498701fb6ba722d

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 2.0.6
+
+This release contains accessibility fixes:
+
+- anchor header links are now properly hidden to assistive technologies
+- side navigation items now have consistent visible focus when tabbing between them
+- side navigation items have unique Ids
+- code elements now scale properly when you enlarge your text
+- links with code elements now look correct
+- contribution links are now within a landmark
+
+You can look at the [2.0.6 milestone](https://github.com/alphagov/tech-docs-gem/milestone/2?closed=1) for the closed issues, and [pull request #129: Accessibility improvements](https://github.com/alphagov/tech-docs-gem/pull/129) for details on how these issues were fixed.
+
 ## 2.0.5
 
 

data/example/source/index.html.md.erb

@@ -19,3 +19,5 @@ If you want slightly more control, you can always use <strong>HTML</strong>.
 For more detail and troubleshooting, take a look at the `README.md` file in the root of this project.
 
 <%= warning_text "Look out! A warning!" %>
+
+<a href="#"><code>code element within a link</code></a>

data/example/source/nested-page/another-nested-page/index.html.md

@@ -0,0 +1,5 @@
+---
+title: Another nested page
+---
+
+# Another nested page

data/example/source/nested-page/index.html.md

@@ -0,0 +1,5 @@
+---
+title: Nested page
+---
+
+# Nested page

data/lib/assets/javascripts/_modules/anchored-headings.js

@@ -11,7 +11,7 @@
       var $this = $(this)
       $this.addClass('anchored-heading')
       $this.prepend(
-        '<a href="#' + $this.attr('id') + '" class="anchored-heading__icon" aria-hidden="true"></a>'
+        '<a href="#' + $this.attr('id') + '" class="anchored-heading__icon" aria-hidden="true" tabindex="-1"></a>'
       )
     }
   }

data/lib/assets/javascripts/_modules/collapsible-navigation.js

@@ -22,7 +22,7 @@
         var $topLevelItem = $($topLevelItems[i])
         var $heading = $topLevelItem.find('> a')
         var $listing = $topLevelItem.find('> ul')
-        var id = 'toc-' + $heading.text().toLowerCase().replace(' ', '-')
+        var id = 'toc-' + $heading.text().toLowerCase().replace(/\s+/g, '-')
         // Only add collapsible functionality if there are children.
         if ($listing.length === 0) {
           continue

data/lib/assets/stylesheets/modules/_technical-documentation.scss

@@ -1,13 +1,10 @@
 .technical-documentation {
-  @include govuk-font($size: 19);
+  @include govuk-font($size: 19, $line-height: 1.4);
   // Required for IE11 to render <main> correctly
   display: block;
   margin: govuk-spacing(3);
-  font-size: 19px;
   max-width: 40em;
 
-  line-height: 1.4;
-
   color:  $govuk-text-colour;
 
   @include govuk-media-query(tablet) {
@@ -135,10 +132,12 @@
 
     font-family: monaco, Consolas, "Lucida Console", monospace;
     font-size: 15px;
+    font-size: 0.9375rem;
     color: $code-0E;
 
     @include govuk-media-query(tablet) {
       font-size: 16px;
+      font-size: 1rem;
     }
 
     // Handle long strings (URLs, long variable names, etc) by allowing them
@@ -163,6 +162,16 @@
     }
   }
 
+  // Ensure that if a code element is wrapped with a link that it renders correctly.
+  a code {
+    color: inherit;
+  }
+
+  a:focus code {
+    background: inherit;
+    color: inherit;
+  }
+
   .table-container {
     display: block;
     max-width: 100%;

data/lib/govuk_tech_docs/table_of_contents/helpers.rb

@@ -63,7 +63,7 @@ module GovukTechDocs
             end
 
           if resource.children.any? && resource.url != home_url
-            output += %{<ul><li><a href="#{resource.url}">#{resource.data.title}</a>\n}
+            output += %{<ul><li><a href="#{resource.url}"><span>#{resource.data.title}</span></a>\n}
             output += render_page_tree(resource.children, current_page, config, current_page_html)
             output += '</li></ul>'
           else

data/lib/govuk_tech_docs/version.rb

@@ -1,3 +1,3 @@
 module GovukTechDocs
-  VERSION = "2.0.5".freeze
+  VERSION = "2.0.6".freeze
 end

data/lib/source/layouts/core.erb

@@ -62,13 +62,15 @@
             <%= partial "layouts/page_review" %>
           </main>
 
-          <% if config[:tech_docs][:show_contribution_banner] %>
-            <ul class="contribution-banner">
-              <li><%= link_to "View source", source_urls.view_source_url %></li>
-              <li><%= link_to "Report problem", source_urls.report_issue_url %></li>
-              <li><%= link_to "GitHub Repo", source_urls.repo_url %></li>
-            </ul>
-          <% end %>
+          <aside>
+            <% if config[:tech_docs][:show_contribution_banner] %>
+              <ul class="contribution-banner">
+                <li><%= link_to "View source", source_urls.view_source_url %></li>
+                <li><%= link_to "Report problem", source_urls.report_issue_url %></li>
+                <li><%= link_to "GitHub Repo", source_urls.repo_url %></li>
+              </ul>
+            <% end %>
+          </aside>
 
           <%= partial "layouts/footer" %>
         </div>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_tech_docs
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.0.6
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-11 00:00:00.000000000 Z
+date: 2019-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -364,6 +364,8 @@ files:
 - example/source/hidden-page.html.md
 - example/source/index.html.md.erb
 - example/source/javascripts/application.js
+- example/source/nested-page/another-nested-page/index.html.md
+- example/source/nested-page/index.html.md
 - example/source/not-expired-page.html.md
 - example/source/pets.yml
 - example/source/stylesheets/print.css.scss