Using nhs notify components (#40)

* Added NHS components

* Added the NHS components of inset text on the applicable Using NHS Notify pages.

Added table markdown to the Accessible formats page.

Updated Finding recipients with access or language needs, Accessible formats and Letters in other languages in line with the minor content changes detailed in Figma. These changes come as a result of a conversation with Jonny Stuart, Laura Mountain and Michael Houston about the product direction regarding PDS checks. They confirmed that while PDS checks for access or language needs, NHS Notify only sends messages in these formats if users provide templates that match. Users need to do their own lookups before providing us with NHS numbers - we don't tell them this information in advance.

* Removed spaces before bulleted lists.

* Added spaces before and after headings in the inset text.

* Changed headings in the inset text back to how they were.

* Added new markdown rules.

* Add gemfile gitleaks ignore.

---------

Co-authored-by: Jake Cosgrove <[email protected]>
Co-authored-by: Ross Buggins <[email protected]>

Author: 3 people

docs/pages/using-nhs-notify/accessible-formats.md

@@ -5,8 +5,9 @@
 layout: page
 title: Accessible formats
 parent: Using NHS Notify
-nav_order: 10
+nav_order: 5
 permalink: /using-nhs-notify/accessible-formats
+section: Writing a message
 ---
 
 Before you start to send messages, consider the access needs of your recipients.
@@ -17,7 +18,11 @@ All organisations that provide NHS care or publicly-funded adult social care are
 
 NHS Notify offers the following letter formats so you can reach people with access needs.
 
-[insert 3 column table here]
+| Accessible format    | Description |
+| -------- | ------- |
+| Large print  | Letters that have a larger font than usual. Large print letters typically have a point size of 16 and above.    |
+| Braille | Includes the original letter and a Braille insert. NHS Notify uses the Royal National Institute of Blind People (RNIB) to translate your content into Braille so that blind and partially sighted people can read your messages.    |
+| Audio CD | Includes the original letter and a CD that plays a spoken recording of your letter's content.  |
 
 ## Other accessible formats
 
@@ -32,15 +37,32 @@ This is available for NHS App messages, emails, text messages and letters
 
 ## How to send messages in accessible formats
 
-You'll need to tell us if you require letters in accessible formats. Do this by:
+### 1. Tell us if you’ll need accessible formats
+
+Do this by:
 
 - speaking to our engagement team when you first [get started]({% link pages/get-started/get-started.md %}) with NHS Notify
-- raising a [support request on our service portal](https://nhsdigitallive.service-now.com/csm) if you're already using NHS Notify and have existing templates
+- raising a [Service Now request](https://nhsdigitallive.service-now.com/csm) if you're already using NHS Notify and have existing templates
+
+### 2. Create your templates and routing plans
 
 Set up a routing plan that requests accessible formats.
 
-Create your messages using standard templates.
+Create separate templates for each type of accessible format you’ll need. Select the ‘standard letter’ template type.
+
+### 3. Provide recipients' NHS numbers
 
 Provide recipients' NHS numbers as separate data files for each type of accessible format.
 
-NHS Notify will arrange for your letters to be sent in your required accessible format.
+### 4. We'll check for recipients with access needs
+
+It’s your responsibility to message recipients based on their access needs.
+
+NHS Notify can check who needs accessible formats, but we’ll only send them an accessible format if you've created a template that matches.
+
+We’ll send the accessible letter format if:
+
+- you've given us the accessible template
+- PDS confirms there are recipients with access needs
+
+We’ll send the standard letter if you've not given us the accessible template, even if PDS says there are recipients with access needs.

docs/pages/using-nhs-notify/api.md

@@ -7,6 +7,7 @@ title: API
 parent: Using NHS Notify
 nav_order: 1
 permalink: /using-nhs-notify/api
+section: Accessing NHS Notify
 ---
 
 NHS England organisations and services can integrate the NHS Notify API with their web applications or back office systems.

docs/pages/using-nhs-notify/delivery-times.md

@@ -5,8 +5,9 @@
 layout: page
 title: Delivery times
 parent: Using NHS Notify
-nav_order: 9
+nav_order: 7
 permalink: /using-nhs-notify/delivery-times
+section: Writing a message
 ---
 
 It can take different amounts of time for messages to be delivered depending on the message channel used.

docs/pages/using-nhs-notify/editing-and-formatting.md

@@ -5,8 +5,9 @@
 layout: page
 title: Editing and formatting
 parent: Using NHS Notify
-nav_order: 5
+nav_order: 1
 permalink: /using-nhs-notify/editing-and-formatting
+section: Writing a message
 ---
 
 NHS Notify uses Markdown to format content for emails and letters.
@@ -17,18 +18,22 @@ You can see formatting instructions while you’re editing a template.
 
 Email templates can include:
 
+<!-- no toc -->
 - [bullet points](#bullet-points)
 - [headings](#headings)
 - [horizontal lines](#horizontal-lines)
 - [inset text](#inset-text)
 - [numbered steps](#numbered-steps)
+- [page breaks](#page-breaks)
 
 Letter templates can include:
-
+<!-- no toc -->
 - [bullet points](#bullet-points)
 - [headings](#headings)
 - [horizontal lines](#horizontal-lines)
 - [inset text](#inset-text)
+- [numbered steps](#numbered-steps)
+- [page breaks](#page-breaks)
 
 ## Guidance
 
@@ -52,21 +57,26 @@ Copy this example to add bullet points:
 - leave one empty line space after the last item'
 %}
 
-Introduce bullet points with a lead-in line ending with a colon:
+To create sub-items, add an indent of 2 spaces before the asterisk or dash.
+
+#### How to add personalised bullet points
 
-• leave one empty line space after the lead-in line
-• use an asterisk or a dash followed by a space to add an item
-• start each item with a lowercase letter, do not end with a full stop
-• leave one empty line space after the last item
+Copy this example to add a placeholder to your message template:
 
-[end inset text]
+{% include components/inset-text.html
+    text='Introduce bullet points with a lead-in line ending in a colon:
 
-To create sub-items, add an indent of 2 spaces before the asterisk or dash.
+((bullet points))
 
-[details component]
-How to add personalised bullet points
+Leave one empty line space before the next paragraph.
+To send the message, upload a list of recipient details.
 
-There's more guidance about bullet points on GOV.UK.
+Your spreadsheet should include one column for each bullet point. The column names must match the placeholder in the template.
+
+Notify will fill in the placeholder with your bullet points.'
+%}
+
+There's more [guidance about bullet points on GOV.UK](https://www.gov.uk/guidance/style-guide/a-to-z-of-gov-uk-style#bullet-points-steps).
 
 ### Headings
 
@@ -80,24 +90,27 @@ Write all headings and subheadings in sentence case.
 
 Use one hash symbol followed by a space for a heading in emails and letters, for example:
 
-[inset text]
-| # This is a heading
+{% include components/inset-text.html
+    text='# This is a heading'
+%}
 
 Use 2 hash symbols followed by a space for a subheading in emails, for example:
 
-[inset text]
-| ## This is a subheading
+{% include components/inset-text.html
+    text='## This is a subheading'
+%}
 
 ### Horizontal lines
 
 Use a horizontal line to create separate sections in an email template.
 
 To add a horizontal line between 2 paragraphs, use 3 dashes. Leave one empty line space after the first paragraph. For example:
 
-[inset text]
-| First paragraph
-| ---
-| Second paragraph
+{% include components/inset-text.html
+    text='First paragraph
+ ---
+Second paragraph'
+%}
 
 ### Inset text
 
@@ -109,12 +122,13 @@ Use inset text to differentiate a block of text from the content that surrounds
 
 To add inset text, use a caret. For example:
 
-[inset text]
-| ^ You must tell us if your circumstances change.
+{% include components/inset-text.html
+    text='^ You must tell us if your circumstances change.'
+%}
 
 Use inset text very sparingly – it’s less effective if it’s overused.
 
-There’s more guidance about inset text in the GOV.UK Design System.
+There’s more [guidance about inset text in the GOV.UK Design System](https://design-system.service.gov.uk/components/inset-text/).
 
 ### Numbered steps
 
@@ -124,11 +138,16 @@ You do not need a lead-in line for a numbered list.
 
 Copy this example to add numbered steps:
 
-[inset text]
-| 1. Leave one empty line space before starting your list.
-| 2. Enter a number followed by a full stop and a space to add an item.
-| 3. Start each item with a capital letter and end it with a full stop.
-| 4. Leave one empty line space after the last item.
+{% include components/inset-text.html
+    text='
+
+1. Leave one empty line space before starting your list.
+2. Enter a number followed by a full stop and a space to add an item.
+3. Start each item with a capital letter and end it with a full stop.
+4. Leave one empty line space after the last item.
+
+'
+%}
 
 To create sub-items, add an indent of 2 spaces before the number.
 
@@ -138,7 +157,8 @@ There’s more guidance about numbered lists in the GOV.UK Design System.
 
 To insert a page break in a letter template, use 3 asterisks. For example:
 
-[inset text]
-| Content on page 1
-| •••
-| Content on page 2
+{% include components/inset-text.html
+    text='Content on page 1
+***
+Content on page 2'
+%}

docs/pages/using-nhs-notify/find-recipients-with-access-or-language-needs.md

@@ -3,10 +3,11 @@
 # To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults
 
 layout: page
-title: Find recipients with access or language needs
+title: Finding recipients with access or language needs
 parent: Using NHS Notify
-nav_order: 15
+nav_order: 11
 permalink: /using-nhs-notify/find-recipients-with-access-or-language-needs
+section: Writing a message
 ---
 
 NHS Notify identifies people who need messages in accessible formats or other languages (sometimes called preferences).
@@ -17,10 +18,10 @@ You need to decide whether to message recipients based on their access or langua
 
 ## Sending messages in accessible formats and other languages
 
-To send messages in accessible formats or other languages, you need to create templates for them.
+We’ll only send messages in accessible formats or other languages if you’ve created templates that meet recipients’ access or language needs.
 
 Read more about sending messages in [accessible formats]({% link pages/using-nhs-notify/accessible-formats.md %}) or [other languages]({% link pages/using-nhs-notify/letters-in-other-languages.md %}).
 
 ## Message channel preferences
 
-NHS Notify does not currently check for recipients’ message channel preferences.
+NHS Notify does not currently check for recipients’ message channel preferences, for example NHS App, email, text message or letter.

docs/pages/using-nhs-notify/image.png

@@ -5,8 +5,9 @@
 layout: page
 title: Letters in other languages
 parent: Using NHS Notify
-nav_order: 11
+nav_order: 6
 permalink: /using-nhs-notify/letters-in-other-languages
+section: Writing a message
 ---
 
 NHS Notify allows you to message patients and members of the public using other languages, including their matching character sets.
@@ -46,29 +47,36 @@ We currently support the following languages and their character sets:
 - Turkish
 - Urdu
 
-[inset text here]
-| You can request additional languages, as long as they're in PDS. We’ll need to test these languages so make sure you leave enough time for this.
+{% include components/inset-text.html
+  text="You can request additional languages, as long as they’re in PDS. We’ll need to test these languages so make sure you leave enough time for this."
+%}
 
 ## How to send letters in other languages
 
-### 1. Create your templates
+### Create your templates
 
 You're responsible for translating your message content. NHS Notify does not offer a translation service.
 
-Create your messages using standard templates.
+Create your messages using the 'standard letter' template type.
 
-You’ll need to include both the English version and the translated version in a single template.
+Include both the English version and the translated version in a single template.
 
 The letter will be on double-sided paper.
 
-Aim to keep your message content to 2 double-sided sheets to save costs. This will include the English version on one double-sided sheet and the translation on another double-sided sheet.
+Aim to keep your message content to 2 double-sided sheets to save costs. This will include:
 
-### 2. Find recipients who need letters in other languages
+- the English version on one double-sided sheet
+- the translation on another double-sided sheet
 
-NHS Notify checks recipients’ language preferences in PDS.
+### We'll check for recipients who need letters in other languages
 
 You can decide whether to message recipients based on their language preferences.
 
-We’ll send the letter with the translation and the English version if you've given us the translation and PDS says it's the recipient's preferred language.
+NHS Notify checks who needs letters in other languages, but we’ll only send them these if you've created a template that matches.
 
-We’ll send the letter in English if you've not given us the translation, even if PDS says the recipient has another preferred language.
+We’ll send the translation (along with the English version) if:
+
+- you've given us the translation
+- PDS confirms there are recipients who need messages in this language
+
+We’ll send the letter in English if you've not given us the translation, even if PDS says recipients need messages in other languages.

docs/pages/using-nhs-notify/letters-in-other-languages.md

@@ -5,14 +5,16 @@
 layout: page
 title: Links and URLs
 parent: Using NHS Notify
-nav_order: 6
+nav_order: 2
 permalink: /using-nhs-notify/links-and-urls
+section: Writing a message
 ---
 
 When composing a message, write URLs in full. For example:
 
-[inset text here]
-| Book now at https://www.nhs.uk/example
+{% include components/inset-text.html
+    text='Book now at https://www.nhs.uk/example'
+%}
 
 URLs should be easy to read.
 
@@ -44,8 +46,9 @@ NHS Notify uses Markdown to format link text.
 
 To convert text into a link, use square brackets around the link text and round brackets around the url. Make sure there are no spaces between the brackets or the link will not work. For example:
 
-[inset text here]
-| [Book now](https://www.nhs.uk/example)
+{% include components/inset-text.html
+    text='[Book now](https://www.nhs.uk/example)'
+%}
 
 You cannot use Markdown to add link text to a text message or letter template.
 

docs/pages/using-nhs-notify/links-and-urls.md

@@ -7,6 +7,7 @@ title: MESH
 parent: Using NHS Notify
 nav_order: 2
 permalink: /using-nhs-notify/mesh
+section: Accessing NHS Notify
 ---
 
 NHS England organisations and services can use the Message Exchange for Social care and Health (MESH) to send messages with NHS Notify.

docs/pages/using-nhs-notify/mesh.md

@@ -5,15 +5,17 @@
 layout: page
 title: Personalisation
 parent: Using NHS Notify
-nav_order: 7
+nav_order: 3
 permalink: /using-nhs-notify/personalisation
+section: Writing a message
 ---
 
 You can send personalised messages using a single template.
 
 To personalise a message, use double brackets to add a placeholder to your content. For example:
 
-[inset text here]
-| Hello ((firstName)), your NHS Number is ((nhsNumber))
+{% include components/inset-text.html
+    text='Hello ((firstName)), your NHS Number is ((nhsNumber))'
+%}
 
 NHS Notify uses the Personal Demographics Service to find and populate certain personalisation fields.