Merge pull request #441 from nhsuk/develop

Release 1.13.2

.gitignore

@@ -4,3 +4,4 @@ public
 .DStore
 .DS_Store
 app/.DS_Store
+.vscode

CHANGELOG.md

@@ -1,5 +1,11 @@
 # NHS digital service manual Changelog
 
+## 1.13.2 - 18 November 2019
+
+:wrench: **Fixes**
+
+- Update PDF and links pages and related content
+
 ## 1.13.1 - 12 November 2019
 
 :wrench: **Fixes**

app/views/accessibility/content.njk

@@ -20,11 +20,11 @@
   {% include './partials/use-tables-to-show-relationships-between-data.njk' %}
   {% include './partials/make-video-and-multimedia-accessible.njk' %}
   {% include './partials/do-not-rely-on-colour-or-position-alone.njk' %}
-
+  {% include './partials/use-html-rather-than-pdfs.njk' %}
   {% include './partials/get-in-touch-accessibility.njk' %}
 
   <div class="nhsuk-review-date">
-    <p class="nhsuk-body-s">Updated: July 2019</p>
+    <p class="nhsuk-body-s">Updated: November 2019</p>
   </div>
 
 {% endblock %}

app/views/accessibility/partials/use-html-rather-than-pdfs.njk

@@ -0,0 +1,6 @@
+<h2 id="pdfs">Use HTML rather than PDFs</h2>
+<p class="nhsuk-body-s">For: <a href="/service-manual/accessibility/content">Content</a>, <a href="/service-manual/accessibility/testing">Testing</a></p>
+<p>Avoid using PDFs as they are not accessible. If you must use a PDF, make sure the content is also available in HTML form.</p>
+<p>Read more about <a href="/service-manual/content/pdfs">PDFs in the content style guide</a>.</p>
+
+<hr>

app/views/accessibility/testing.njk

@@ -41,13 +41,13 @@
   {% include './partials/do-not-play-audio-automatically.njk' %}
   {% include './partials/do-not-rely-on-touch-gestures.njk' %}
   {% include './partials/do-not-rely-on-motion-sensors.njk' %}
-
+  {% include './partials/use-html-rather-than-pdfs.njk' %}
   {% include './partials/get-in-touch-accessibility.njk' %}
 
   <div class="nhsuk-review-date">
-    <p class="nhsuk-body-s">Updated: July 2019</p>
+    <p class="nhsuk-body-s">Updated: November 2019</p>
   </div>
-
+</div>
 {% endblock %}
 
 {% block asideContent %}

app/views/content/index.njk

@@ -51,8 +51,15 @@
     <p>From abbreviations to question marks.</p>
   </div>
   <div class="nhsuk-grid-column-one-third">
-    <h2 class="nhsuk-heading-s nhsuk-u-margin-bottom-3"><a href="/service-manual/content/links-and-pdfs">Links and PDFs</a></h2>
-    <p>Writing good links and making PDFs accessible.</p>
+    <h2 class="nhsuk-heading-s nhsuk-u-margin-bottom-3"><a href="/service-manual/content/pdfs">PDFs</a></h2>
+    <p>Why we avoid PDFs and how we manage them</p>
+  </div>
+</div>
+
+<div class="nhsuk-grid-row nhsuk-u-margin-top-4">
+  <div class="nhsuk-grid-column-one-third">
+    <h2 class="nhsuk-heading-s nhsuk-u-margin-bottom-3"><a href="/service-manual/content/links">Links</a></h2>
+    <p>Writing good links, including linking to PDFs</p>
   </div>
 </div>
 
@@ -69,7 +76,7 @@
     <h2 class="nhsuk-u-margin-top-8">Contribute</h2>
     <p>Let us know <a href="/service-manual/contribute">if you design a new content pattern or find new evidence</a> on content style.</p>
     <div class="nhsuk-review-date">
-      <p class="nhsuk-body-s">Updated: August 2019</p>
+      <p class="nhsuk-body-s">Updated: November 2019</p>
     </div>
   </div>
 </div>

app/views/content/links-and-pdfs.njk → app/views/content/links.njk

@@ -1,6 +1,6 @@
-{% set pageTitle = 'Links and PDFs' %}
+{% set pageTitle = 'Links' %}
 {% set pageSection = 'Content style guide' %}
-{% set pageDescription = 'How to handle links and PDFs.' %}
+{% set pageDescription = 'How to handle links, including links to PDFs' %}
 
 {% extends 'includes/app-layout-two-thirds.njk' %}
 
@@ -10,7 +10,7 @@
 
 {% block bodyContent %}
 
-  <h2>Links</h2>
+<h2>Write good links</h2>
   <p>Make links active, specific and concise.</p>
   <p>Links should describe where they're taking the user. Where you can, use the same words as the title of the page you're linking to. That way, the user will know what to expect.</p>
   <p>We do not use link text such as "click here" or anything that does not make sense when read out of context. Screen readers can move between links without reading the surrounding content.</p>
@@ -45,7 +45,8 @@
     ]
   }) }}
 
-  <h3>External links</h3>
+  <h2>Avoid opening new windows or tabs</h2>
+
   <p>Avoid using links or buttons that open new windows or tabs.</p>
   <p>There are 2 exceptions to this:</p>
   <ul>
@@ -55,16 +56,11 @@
   <p><a href="https://www.w3.org/TR/WCAG20-TECHS/G200.html">Read more about opening new windows and tabs on W3C</a>.</p>
   <p>If links do go to a new tab or window, warn the user by saying: "Link name (opens in new window)". (Include all of this in the link text.)</p>
 
-  <h2>PDFs</h2>
-  <p>PDFs can be bad for accessibility. Often they do not work well with assistive technologies like screen readers.</p>
-
-  <h3>Publishing PDFs</h3>
-  <p>We avoid publishing PDFs. Wherever possible, we create content in HTML. If we do need to publish a PDF, we provide an HTML version as well.</p>
-  <p>Any PDFs must meet level AA of the <a href="https://www.w3.org/TR/WCAG21/">Web Content Accessibility Guidelines (WCAG) 2.1</a>.</p>
-  <p>Check the GOV.UK guidance on <a href="https://www.gov.uk/guidance/how-to-publish-on-gov-uk/accessible-pdfs">publishing accessible documents</a>.</p>
+  <h2>Avoid linking to PDFs</h2>
+  <p>Wherever possible, we avoid publishing PDFs or linking to them. Read our <a href="/service-manual/content/pdfs">guidance on PDFs</a>.</p>
 
-  <h3>Linking to PDFs</h3>
   <p>We prefer to link to an HTML page containing the PDF. That way, if the PDF is changed or updated, users can still find the latest information.<p>
+
   <p>If we need to link to a PDF, we:</p>
   <ul>
     <li>open it in the same tab</li>
@@ -73,8 +69,8 @@
   <p>Round up values over 1MB to 2 decimal places to keep it as accurate as possible.</p>
   <p>Round up values under 1MB to the nearest KB. For example, round up 835.74KB to 836KB.</p>
 
-  <div class="nhsuk-review-date">
-    <p class="nhsuk-body-s">Updated: August 2019</p>
+<div class="nhsuk-review-date">
+    <p class="nhsuk-body-s">Updated: November 2019</p>
   </div>
 
 {% endblock %}

app/views/content/partials/related-nav.njk

@@ -38,11 +38,18 @@
       </li>
       {% endif %}
 
-      {% if pageTitle != 'Links and PDFs' %}
+        {% if pageTitle != 'PDFs' %}
       <li class="nhsuk-related-nav__item">
-        <a href="/service-manual/content/links-and-pdfs">Links and PDFs</a>
+        <a href="/service-manual/content/pdfs">PDFs</a>
       </li>
       {% endif %}
+
+      {% if pageTitle != 'Links' %}
+      <li class="nhsuk-related-nav__item">
+        <a href="/service-manual/content/links">Links</a>
+      </li>
+      {% endif %}
+
     </ul>
   </nav>
 </div>

app/views/content/pdfs.njk

@@ -0,0 +1,56 @@
+{% set pageTitle = 'PDFs' %}
+{% set pageSection = 'Content style guide' %}
+{% set pageDescription = 'Wherever possible, we avoid PDFs. Instead we create content as structured web pages in HTML. '%}
+
+{% extends 'includes/app-layout-two-thirds.njk' %}
+
+{% block breadcrumb %}
+  {% include 'content/_breadcrumb.njk' %}
+{% endblock %}
+
+{% block bodyContent %}
+
+  <h2>The problem with PDFs</h2>
+  <p>We avoid PDFs because:</p>
+  <ul>
+    <li>they cannot meet the range of users' accessibility needs, for example, users cannot change colours or font size</li>
+    <li>they give people a poor user experience, especially on mobile</li>
+    <li>many browsers, tools and extensions do not work with them - they often have problems with zoom, scroll, audio, image and keyboard navigation</li>
+    <li>they take users away from the website, opening in a new tab, window or software - and not all users have the right software</li>
+    <li>they are hard to maintain and update, so users may get out of date and unreliable content</li>
+    <li>if users find PDFs in search results, they get them without any supporting context or material</li>
+    <li>search engines do not rank PDFs high in search results</li>
+    <li>it's difficult to collect data on how people use PDFs, and that makes it difficult to identify problems and improve them</li>
+  </ul>
+
+  <h2>Publishing PDFs with an HTML version</h2>
+  <p>In a few cases, where there is a clear, evidenced user need for it, we publish a PDF. But, as far as possible, we also make the same content available as HTML web pages.</p>
+  <p>The instances where we may publish a PDF (as well as a web page) are:</p>
+  <ul>
+    <li>for niche audiences, where there is a clear user need for special formats (like Easy Read or foreign language leaflets designed to be printed out)</li>
+    <li>for other downloads designed for printing, such as posters</li>
+    <li>downloads of reports or publications designed to be published on paper</li>
+    <li>where there's a legal or regulatory requirement to have a formal, signed document</li>
+  </ul>
+  <p>If you do create a new PDF, it must meet the PDF/A standard, which is more accessible. (Follow the <a href="https://www.gov.uk/guidance/how-to-publish-on-gov-uk/accessible-pdfs">GOV.UK guidance on publishing accessible documents</a>.)</p>
+
+  <h2>Older PDFs</h2>
+  <p>Teams should make sure that:</p>
+  <ul>
+    <li>they keep their content up to date</li>
+    <li>they replace old PDFs with an HTML page or an accessible PDF, or they delete them</li>
+  </ul>
+
+  <h2>Linking to PDFs</h2>
+  <p>It's better to link to HTML pages containing PDF content rather than to PDFs themselves. This makes it easier for users to find the latest information.</p>
+  <p>Read more about writing good <a href="/service-manual/content/links">links</a>, including linking to PDFs.</p>
+
+  <div class="nhsuk-review-date">
+    <p class="nhsuk-body-s">Updated: November 2019</p>
+  </div>
+
+{% endblock %}
+
+{% block asideContent %}
+  {% include './partials/related-nav.njk' %}
+{% endblock %}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nhsuk-service-manual",
-  "version": "1.13.1",
+  "version": "1.13.2",
   "description": "NHS digital service manual",
   "main": "app.js",
   "directories": {