Merge pull request #289 from nhsuk/develop

Release 1.8.0

CHANGELOG.md

@@ -1,5 +1,18 @@
 # NHS digital service manual Changelog
 
+## 1.8.0 - 09 August 2019
+
+:new: **New content**
+
+- Add entries to A to Z of NHS health writing: health record and related terms
+
+:wrench: **Fixes**
+
+- Remove duplicate entry from the XML sitemap
+- Accessibility: Updated home link aria label, it now reads as "NHS digital service manual homepage"
+- Fix a few minor content formatting issues, like apostrophes
+- Update package dependencies to latest versions
+
 ## 1.7.0 - 06 August 2019
 
 :new: **New content**

app.js

@@ -75,6 +75,7 @@ app.get('/service-manual/design-example/:example', (req, res) => {
   res.render('includes/design-example-wrapper.njk', { body: exampleHtml });
 });
 
+/*
 app.get('/service-manual/search', (req, res) => {
   var query = req.query['search-field'] || '';
   res.render('includes/search.njk', { results: pageIndex.search(query), query: query });
@@ -84,6 +85,7 @@ app.get('/service-manual/suggestions', (req, res) => {
   res.set({ 'Content-Type': 'application/json' });
   res.send(JSON.stringify(pageIndex.search(req.query.search)));
 });
+*/
 
 app.get('/', (req, res) => {
   res.redirect('/service-manual');

app/views/accessibility/how-to-make-digital-services-accessible.njk

@@ -30,12 +30,12 @@
 
     <h2 id="consider-accessibility-at-every-stage">Consider accessibility at every stage</h2>
     <p>Think about how you are going to address accessibility at the beginning and at every stage of your project.</p>
-    <p>It’s much harder to make a service accessible if you only address it later on.</p>
+    <p>It's much harder to make a service accessible if you only address it later on.</p>
     <ul>
       <li><a href="https://www.gov.uk/service-manual/helping-people-to-use-your-service/making-your-service-accessible-an-introduction#what-to-do-in-discovery">Making your service accessible: an introduction</a> (GOV.UK service manual) explains what to do at different stages.</li>
     </ul>
 
-    <h2 id="make-it-the-whole-teams-responsibility">Make it the whole team’s responsibility</h2>
+    <h2 id="make-it-the-whole-teams-responsibility">Make it the whole team's responsibility</h2>
     <p>Every member of the team should contribute to making your service inclusive.</p>
     <p>You should all:</p>
     <ul>

app/views/accessibility/partials/look-after-your-team.njk

@@ -1,6 +1,6 @@
 <h2 id="look-after-your-team">Look after your team</h2>
 <p class="nhsuk-body-s">For: <a href="/service-manual/accessibility/user-research">User research</a></p>
 <p>It's important that the team supports one another. User research in health can be tiring and emotional. Sometimes users might tell you stories that are hard to hear or you might see them struggle.</p>
-<p>It’s OK to take some time out during a day of research or, as a user researcher, to ask for someone to stand in for you.</p>
+<p>It's OK to take some time out during a day of research or, as a user researcher, to ask for someone to stand in for you.</p>
 <p>Check in with your team mates during and after research and take time to reflect together.</p>
 <hr>

app/views/content/a-to-z-of-nhs-health-writing.njk

@@ -357,6 +357,9 @@
         <h3 id="haemorrhage">haemorrhage</h3>
         <p>We often use the words "a very heavy bleed" instead of "haemorrhage".</p>
         <p>If you need to use the word "haemorrhage", for example, in the name of a condition like a subarachnoid haemorrhage, explain what it is.</p>
+        <h3 id="health-record">health record</h3>
+        <p>We use "health record" rather than "medical record". "Health record" is more accurate as someone's record may cover social care as well as medical content. In our user research, we haven’t seen anyone confused by "health record". People see it as the same as a "medical record".</p>
+        <p>In some contexts, for example in forms, rather than asking about someone's "health record", we ask about "your health, and any health problems or treatments you've had in the past".</p>
         <h3 id="healthcare">healthcare</h3>
         <p>One word.</p>
         <h3 id="home-help">home help</h3>
@@ -426,6 +429,8 @@
         <p>We use "<a href="#CJD">CJD</a>".</p>
         <h3 id="measurement">measurement</h3>
         <p>See our guidance on <a href="/service-manual/content/numbers-measurement-dates-time">numbers, measurement, dates and time</a>.</p>
+        <h3 id="medical-record">medical record</h3>
+        <p>We prefer "<a href="#health-record">health record</a>".</p>
         <h3 id="medication">medication</h3>
         <p>We use "medicine".</p>
         <h3 id="metric-measurements">metric measurements</h3>
@@ -533,6 +538,9 @@
         <p>See our guidance on <a href="/service-manual/content/numbers-measurement-dates-time">numbers, measurement, dates and time</a>.</p>
         <h3 id="persist">persist</h3>
         <p>We use "carry on" or "keep going".</p>
+        <h3 id="personal-child-health-record-(red-book)">personal child health record (red book)</h3>
+        <p>All lower case. We include the phrase "red book" in brackets the first time we mention "personal child health record". Then we usually call it the "red book" after the first mention.</p>
+        <p>Also see <a href="#health-record">health record</a>.</p>
         <h3 id="poo">poo</h3>
         <p>We mostly use "poo", rather than "stool". We know that everyone can understand "poo", including people who find reading difficult.</p>
         <p>We don’t use "opening your bowels" or "bowel movements".</p>
@@ -628,6 +636,8 @@
         <h3 id="suffering-from">suffering from</h3>
         <p>We don’t use "suffering from". We talk about people having or living with a disability or condition.</p>
         <p>See the section on <a href="/service-manual/content/inclusive-language">disabilities and conditions in Inclusive language.</a></p>
+        <h3 id="summary-care-record">summary care record</h3>
+        <p>Lower case. Also see <a href="#health-record">health record</a>.</p>
         <h3 id="surgery">surgery</h3>
         <p>When we’re writing for the public, we use "GP surgery" or "surgery" rather than "practice", because our research shows us that this is the word patients are more likely to search for and use.</p>
         <p>When we’re writing for healthcare staff, we may use the word "practice". For example, for "practice managers".</p>

app/views/content/how-we-write.njk

@@ -32,9 +32,9 @@
     <h2>Accurate</h2>
     <p>Qualified clinicians check our clinical information and check that it is accurate, clinically safe and has been developed using relevant evidence-based guidance.</p>
     <p>Our content is factual, neutral and unambiguous. We do not use metaphors - we say what we mean.</p>
-    <p>We avoid making subjective statements. Use words like "good", "bad", or "easy" with care. For example, don’t talk about "a good chance of recovery".</p>
+    <p>We avoid making subjective statements. Use words like "good", "bad", or "easy" with care. For example, don't talk about "a good chance of recovery".</p>
     <p>We do use "good" and "bad" where our users do to describe their symptoms, for example "bad pain" or "bad breath".</p>
-    <p>We also use them when there’s a good evidence base. For example, we talk about "a good source of iron" or "lack of sleep is bad for your health".</p>
+    <p>We also use them when there's a good evidence base. For example, we talk about "a good source of iron" or "lack of sleep is bad for your health".</p>
     {{ table({
       panel: false,
       firstCellIsHeader: false,
@@ -92,7 +92,7 @@
       <h3>Research insight</h3>
       <p>Research has shown that <a href=\"https://gds.blog.gov.uk/2014/02/17/guest-post-clarity-is-king-the-evidence-that-reveals-the-desperate-need-to-re-think-the-way-we-write/\" title=\"External website\">most people prefer to read plain English</a>, and that the more specialist a person's knowledge is, the greater their preference."
     }) }}
-    <p>Read <a href="/service-manual/content/health-literacy">our guidance on health literacy</a> to see why it’s important to create content that’s simple to read.</p>
+    <p>Read <a href="/service-manual/content/health-literacy">our guidance on health literacy</a> to see why it's important to create content that's simple to read.</p>
     <h2>Concise</h2>
     <p>We keep content to the point.</p>
     <p>We use short words. For example, we prefer "have" or "get" to "experience" in phrases like "if you experience headaches".</p>

app/views/content/index.njk

@@ -59,7 +59,7 @@
     <p>It's meant as a guide, not a rulebook. You're welcome to adapt a style pattern if it does not meet your users' needs.</p>
     <h2 class="nhsuk-u-margin-top-8">In progress</h2>
     <p>The guide will grow and change as we learn more about the language and writing styles that work best for our users.</p>
-    <p>Join the <a href="https://join.slack.com/t/nhs-service-manual/shared_invite/enQtNTIyOTEyNjU3NDkyLWUwOWM5MWY5MGRhYTYxZmY4ZWI0NDA1N2NhNTRiMGY3MTQxNjk5YTc3ZTAzMTA4YmE3ZDAxYmQ3MTQxNDgzOTQ">NHS.UK service manual Slack workspace</a> or email <a href="mailto:service-manual@nhs.net">service-manual@nhs.net</a> to hear about and discuss changes.</p>
+    <p>Join the <a href="https://join.slack.com/t/nhs-service-manual/shared_invite/enQtNTIyOTEyNjU3NDkyLWUwOWM5MWY5MGRhYTYxZmY4ZWI0NDA1N2NhNTRiMGY3MTQxNjk5YTc3ZTAzMTA4YmE3ZDAxYmQ3MTQxNDgzOTQ">service manual Slack workspace</a> or email <a href="mailto:service-manual@nhs.net">service-manual@nhs.net</a> to hear about and discuss changes.</p>
     <p>Check the <a href="https://www.gov.uk/guidance/style-guide/a-to-z-of-gov-uk-style">GOV.UK A to Z style guide</a> and <a href="https://www.gov.uk/guidance/content-design/writing-for-gov-uk">GOV.UK content design guide</a> for any points of style that you do not find here. If it's not there, we recommend using the Oxford Dictionary for Writers and Editors.</p>
 
     <h2 class="nhsuk-u-margin-top-8">Contribute</h2>

app/views/design-principles/index.njk

@@ -58,7 +58,7 @@
             <div class="featured-item__number nhsuk-heading-xl">4</div>
             Design for context
           </h2>
-          <p>Don’t just design your part of a service. Consider people's entire experience, and the infrastructure and processes involved. Think about how people begin and end their time with what you are designing.</p>
+          <p>Don't just design your part of a service. Consider people's entire experience, and the infrastructure and processes involved. Think about how people begin and end their time with what you are designing.</p>
         </div>
       </li>
 

app/views/includes/header.njk

@@ -3,6 +3,7 @@
 {%- if pageTitle == 'Search' %}
   {{ header({
     "homeHref": "/service-manual/",
+    "ariaLabel": "NHS digital service manual homepage",
     "service": {
       "name": "Digital service manual",
       "longName": "true"
@@ -15,6 +16,7 @@
 {% else %}
   {{ header({
     "homeHref": "/service-manual/",
+    "ariaLabel": "NHS digital service manual homepage",
     "service": {
       "name": "Digital service manual",
       "longName": "true"

app/views/includes/layout.njk

@@ -51,6 +51,7 @@
     <meta name="twitter:site" content="@nhsuk">
     <meta name="twitter:creator" content="@nhsuk">
     <meta name="twitter:image:alt" content="nhs.uk">
+
   </head>
 
   <body>

app/views/includes/search.njk

@@ -4,4 +4,45 @@
 {% extends 'includes/layout.njk' %}
 
 {% block body %}
+  <div class="nhsuk-grid-row">
+    <div class="nhsuk-grid-column-two-thirds">
+      <h1 class="nhsuk-heading-xl nhsuk-u-margin-bottom-4">Search</h1>
+      <form class="nhsuk-header__search-form nhsuk-header__search-form--search-results" id="search" action="/service-manual/search/" method="get" role="search">
+        <label class="nhsuk-u-visually-hidden" for="search-results-field">Search the NHS digital service manual</label>
+        <input class="nhsuk-search__input" id="search-results-field" name="search-field" type="search" value="{{query}}" autocomplete="off">
+        <button class="nhsuk-search__submit" type="submit">
+          <svg class="nhsuk-icon nhsuk-icon__search" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" aria-hidden="true" focusable="false">
+            <path d="M19.71 18.29l-4.11-4.1a7 7 0 1 0-1.41 1.41l4.1 4.11a1 1 0 0 0 1.42 0 1 1 0 0 0 0-1.42zM5 10a5 5 0 1 1 5 5 5 5 0 0 1-5-5z"></path>
+          </svg>
+          <span class="nhsuk-u-visually-hidden">Search</span>
+        </button>
+      </form>
+    </div>
+  </div>
+  <article>
+    <div class="nhsuk-grid-row">
+      <div class="nhsuk-grid-column-two-thirds">
+        {% if results | length > 0 %}
+          <ul class="nhsuk-list nhsuk-list--border">
+            {% for item in results %}
+              <li>
+                <a href="{{item.url}}" class="app-search-results-item">{{item.title}}</a>
+                <p class="nhsuk-body-s nhsuk-u-margin-top-1 nhsuk-u-secondary-text-color">{{item.description}}</p>
+              </li>
+            {% endfor %}
+          </ul>
+        {% else %}
+          {% if query != "" %}
+            <p>Your search - <span class="nhsuk-u-font-weight-bold">{{query}}</span> - had no matching results.</p>
+            <p>Improve your search results by:</p>
+            <ul>
+              <li>double-checking your spelling</li>
+              <li>using fewer keywords</li>
+              <li>searching for something less specific</li>
+            </ul>
+          {% endif %}
+        {% endif %}
+        </div>
+    </div>
+  </article>
 {% endblock %}

app/views/sitemap.xml

@@ -208,9 +208,6 @@
   <url>
     <loc>https://beta.nhs.uk/service-manual/contribute/work-new-thing</loc>
   </url>
-  <url>
-    <loc>https://beta.nhs.uk/service-manual/content/a-to-z-of-nhs-health-writing</loc>
-  </url>
   <url>
     <loc>https://beta.nhs.uk/service-manual/content/health-literacy/</loc>
   </url>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "nhsuk-service-manual",
-  "version": "1.7.0",
+  "version": "1.8.0",
   "description": "NHS digital service manual",
   "main": "app.js",
   "directories": {
@@ -53,7 +53,7 @@
     "highlight.js": "^9.15.9",
     "iframe-resizer": "^3.6.6",
     "jest": "^24.8.0",
-    "js-beautify": "^1.10.1",
+    "js-beautify": "^1.10.2",
     "nhsuk-frontend": "^2.3.0",
     "node-sass": "^4.12.0",
     "nodemon": "^1.19.1",