diff --git a/docs/_includes/components/button.html b/docs/_includes/components/button.html index bcb8caa..a2e8131 100644 --- a/docs/_includes/components/button.html +++ b/docs/_includes/components/button.html @@ -1,5 +1,4 @@ - + diff --git a/docs/pages/features/emails.md b/docs/pages/features/emails.md index f943f45..6073f8a 100644 --- a/docs/pages/features/emails.md +++ b/docs/pages/features/emails.md @@ -20,12 +20,10 @@ Use NHS Notify to send free unlimited emails to patients and members of the publ ## What you need to know -{% include components/action-link.html - url='/using-nhs-notify/email-templates' - text='Learn how to set up email templates' -%} - You might also want to understand more about: - [email delivery times]({% link pages/using-nhs-notify/delivery-times.md %}) - [how to tell recipients who your emails are from]({% link pages/using-nhs-notify/tell-recipients-who-your-messages-are-from.md %}) +- [formatting]({% link pages/using-nhs-notify/formatting.md %}) +- [links and URLs]({% link pages/using-nhs-notify/links-and-urls.md %}) +- [personalisation]({% link pages/using-nhs-notify/personalisation.md %}) diff --git a/docs/pages/features/letters.md b/docs/pages/features/letters.md index 68dbfa6..5460300 100644 --- a/docs/pages/features/letters.md +++ b/docs/pages/features/letters.md @@ -26,8 +26,8 @@ This page will tell you: - [what envelopes we use](#envelopes) {% include components/action-link.html - url='/using-nhs-notify/letter-templates' - text='Learn how to set up letter templates' + url='/using-nhs-notify/upload-a-letter' + text='Learn how to upload a letter' %} You might also want to understand more about: @@ -37,6 +37,9 @@ You might also want to understand more about: - [return addresses]({% link pages/using-nhs-notify/tell-recipients-who-your-messages-are-from.md %}) - [sending letters to people with access needs]({% link pages/using-nhs-notify/accessible-formats.md %}) - [sending letters to people who speak other languages]({% link pages/using-nhs-notify/letters-in-other-languages.md %}) +- [formatting]({% link pages/using-nhs-notify/formatting.md %}) +- [links and URLs]({% link pages/using-nhs-notify/links-and-urls.md %}) +- [personalisation]({% link pages/using-nhs-notify/personalisation.md %}) ## Letter specification diff --git a/docs/pages/features/nhs-app-messages.md b/docs/pages/features/nhs-app-messages.md index 3aa3693..2adfef3 100644 --- a/docs/pages/features/nhs-app-messages.md +++ b/docs/pages/features/nhs-app-messages.md @@ -24,15 +24,13 @@ Recipients can receive NHS App messages in their NHS App inbox. [Push notifications](#push-notifications) are generated when recipients have an unopened message in their NHS App inbox. -{% include components/action-link.html - url='/using-nhs-notify/nhs-app-templates' - text='Learn how to set up NHS App message templates' -%} - You might also want to understand more about: - [delivery times for NHS App messages]({% link pages/using-nhs-notify/delivery-times.md %}) - [how to tell recipients who your NHS App messages are from]({% link pages/using-nhs-notify/tell-recipients-who-your-messages-are-from.md %}) +- [formatting]({% link pages/using-nhs-notify/formatting.md %}) +- [links and URLs]({% link pages/using-nhs-notify/links-and-urls.md %}) +- [personalisation]({% link pages/using-nhs-notify/personalisation.md %}) ## Push notifications diff --git a/docs/pages/features/text-messages.md b/docs/pages/features/text-messages.md index 501e576..28f2bd9 100644 --- a/docs/pages/features/text-messages.md +++ b/docs/pages/features/text-messages.md @@ -20,14 +20,12 @@ Use NHS Notify to send text messages such as invitations, alerts, notifications ## What you need to know -{% include components/action-link.html - url='/using-nhs-notify/text-message-templates' - text='Learn how to set up text message templates' -%} - You might want to understand more about: - [text message pricing]({% link pages/pricing/text-messages.md %}) - [delivery times for text messages]({% link pages/using-nhs-notify/delivery-times.md %}) - [how to tell audiences who your text messages are from]({% link pages/using-nhs-notify/tell-recipients-who-your-messages-are-from.md %}) - [sending text messages to international numbers]({% link pages/pricing/text-messages.md %}#sending-text-messages-to-international-numbers) +- [formatting]({% link pages/using-nhs-notify/formatting.md %}) +- [links and URLs]({% link pages/using-nhs-notify/links-and-urls.md %}) +- [personalisation]({% link pages/using-nhs-notify/personalisation.md %}) diff --git a/docs/pages/get-started/get-started.md b/docs/pages/get-started/get-started.md index 58e14ce..5e430ab 100644 --- a/docs/pages/get-started/get-started.md +++ b/docs/pages/get-started/get-started.md @@ -35,4 +35,5 @@ Complete the following form to register your interest with NHS Notify. This will {% include components/button.html text="Register your interest" + url="https://forms.office.com/Pages/ResponsePage.aspx?id=slTDN7CF9UeyIge0jXdO4-wXWyN79ZdLkmec1Fsc491UNUNJUkpPTjBXMjdZM0xZT0ZHRUxBNFVWMy4u" %} diff --git a/docs/pages/using-nhs-notify/(draft)editing-and-formatting.md b/docs/pages/using-nhs-notify/(draft)editing-and-formatting.md deleted file mode 100644 index 3cee636..0000000 --- a/docs/pages/using-nhs-notify/(draft)editing-and-formatting.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -# Feel free to add content and custom Front Matter to this file. -# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults - -layout: page -title: Editing and formatting -parent: Using NHS Notify -nav_order: 1 -permalink: /using-nhs-notify/editing-and-formatting -section: Writing a message -published: false ---- - -NHS Notify uses Markdown to format content for emails and letters. - -You can see formatting instructions while you’re editing a template. - -## Formatting options - -Email templates can include: - -- [bullet points](#bullet-points) -- [headings](#headings) -- [horizontal lines](#horizontal-lines) -- [numbered lists](#numbered-lists) -- [page breaks](#page-breaks) - -Letter templates can include: - -- [bullet points](#bullet-points) -- [headings](#headings) -- [horizontal lines](#horizontal-lines) -- [numbered lists](#numbered-lists) -- [page breaks](#page-breaks) - -## Guidance - -### Bullet points - -Use bullet points to help words or phrases stand out in your emails and letters. - -You can either: - -- add the same bullet points to every message you send -- add personalised bullet points each time you send a message - -Copy this example to add bullet points: - -{% include components/inset-text.html - text='Introduce bullet points with a lead-in line ending with a colon:

- leave one empty line space after the lead-in line
- use an asterisk or a dash followed by a space to add an item
 ' - %} - -To create sub-items, add an indent of 2 spaces before the asterisk or dash. - -#### How to add personalised bullet points - -Copy this example to add a placeholder to your message template: - -{% include components/inset-text.html -text='Introduce bullet points with a lead-in line ending in a colon:

((bullet points))

Leave one empty line space before the next paragraph. To send the message, upload a list of recipient details.

Your spreadsheet should include one column for each bullet point. The column names must match the placeholder in the template.

NHS 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 - -Use a heading to tell recipients what your email or letter is about. - -For emails, use subheadings to break up the rest of your content. Your first subheading must come after a heading. - -For letters, use headings to break up the rest of your content. - -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: - -{% 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: - -{% 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: - -{% include components/inset-text.html -text='First paragraph

---

Second paragraph' -%} - -### Numbered lists - -Use numbered lists instead of bullet points to guide a user through a process, or when the order of the items in a list is relevant. - -You do not need a lead-in line for a numbered list. - -Copy this example to add numbered steps: - -{% 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. - -There’s more guidance about numbered lists in the GOV.UK Design System. - -### Page breaks - -To insert a page break in a letter template, use 3 asterisks. For example: - -{% include components/inset-text.html -text='Content on page 1

***

Content on page 2' -%} - -Test test test diff --git a/docs/pages/using-nhs-notify/(draft)links-and-urls.md b/docs/pages/using-nhs-notify/(draft)links-and-urls.md deleted file mode 100644 index 1060238..0000000 --- a/docs/pages/using-nhs-notify/(draft)links-and-urls.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -# Feel free to add content and custom Front Matter to this file. -# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults - -layout: page -title: Links and URLs -parent: Using NHS Notify -nav_order: 2 -permalink: /using-nhs-notify/links-and-urls -section: Writing a message -published: false ---- - -When composing a message, write URLs in full. For example: - -{% include components/inset-text.html - text='Book now at https://www.nhs.uk/example' -%} - -URLs should be easy to read. - -We do not recommend using a third-party link shortening service because: - -- your users cannot see where the link will take them -- your link might stop working if there’s a service outage -- you can no longer control where the redirect goes - -## Link texts in emails - -When writing an email, you can convert text into a link instead of writing the full web address. - -Link text may be useful if you have: - -- long, complex URLs -- unsubscribe links -- emails that contain more than 2 links - -If the recipient is not expecting to receive an email from you, we recommend using the url instead of link text. - -Link text should tell the recipient what action they need to take and where the link goes. - -Never use ‘click here’, ‘click link’, ‘this link’ or ‘more’, as these do not make sense when read out of context. - -### How to add link text to an email - -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: - -{% 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. - -To see message formatting instructions while you’re editing an email template: - -1. Go to the Templates page. -2. Create a new email template or choose an existing email template and select Edit. -3. The formatting guide with the available Markdown is on the right-hand side of the page. - -CCM-6061 and CCM-6075 commit workaround. diff --git a/docs/pages/using-nhs-notify/accessible-formats.md b/docs/pages/using-nhs-notify/accessible-formats.md index 1a5f27e..a796c37 100644 --- a/docs/pages/using-nhs-notify/accessible-formats.md +++ b/docs/pages/using-nhs-notify/accessible-formats.md @@ -5,7 +5,7 @@ layout: page title: Accessible formats parent: Using NHS Notify -nav_order: 5 +nav_order: 6 permalink: /using-nhs-notify/accessible-formats section: Writing a message --- diff --git a/docs/pages/using-nhs-notify/approve-your-messages.md b/docs/pages/using-nhs-notify/approve-your-messages.md index 9393648..d588b80 100644 --- a/docs/pages/using-nhs-notify/approve-your-messages.md +++ b/docs/pages/using-nhs-notify/approve-your-messages.md @@ -22,7 +22,7 @@ It's your responsibility to review your templates in a way that meets your organ - does not have any spelling errors - is formatted correctly -Provide us with your final [NHS App message]({% link pages/using-nhs-notify/nhs-app-templates.md %}), [email]({% link pages/using-nhs-notify/email-templates.md %}) or [text message]({% link pages/using-nhs-notify/text-message-templates.md %}) Microsoft Word template. Provide your final [letter template as a PDF]({% link pages/using-nhs-notify/letter-templates.md %}). +Provide us with your final NHS App message, email or text message templates in Create and submit a template. Upload your final letter template. ## Getting proofs of your templates @@ -42,4 +42,4 @@ If your proof matches the final template you provided to us, reply to our email If the content or formatting of your proof does not match the template you originally provided, reply to our email to describe what's wrong with the proof. We'll update the proof message and email it to you again. -If you need to make further changes to your original template, update your original [NHS App message]({% link pages/using-nhs-notify/nhs-app-templates.md %}), [email]({% link pages/using-nhs-notify/email-templates.md %}), [text message]({% link pages/using-nhs-notify/text-message-templates.md %}) or [letter template]({% link pages/using-nhs-notify/letter-templates.md %}) and send it to us again so that we can create a new proof. +If you need to make further changes to your original template, update your original template in Create and submit a template (or upload your letter template) and send it to us again so that we can create a new proof. diff --git a/docs/pages/using-nhs-notify/create-and-submit-a-template.md b/docs/pages/using-nhs-notify/create-and-submit-a-template.md new file mode 100644 index 0000000..5dbc3c9 --- /dev/null +++ b/docs/pages/using-nhs-notify/create-and-submit-a-template.md @@ -0,0 +1,33 @@ +--- +# Feel free to add content and custom Front Matter to this file. +# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults + +layout: page +title: Create and submit a template +parent: Using NHS Notify +nav_order: 1 +permalink: /using-nhs-notify/create-and-submit-a-template +section: Writing a message +--- +To send an NHS App message, email, text message or letter with NHS Notify, you need to add a message template. + +Templates let you send the same thing to lots of people without writing a new message each time. + +You can: + +- create new templates +- add formatting, links and personalisation +- copy an existing template +- save a template as a draft and edit it later +- submit your final templates to NHS Notify to set up the messages you want to send + +## Before you start + +You can only create and submit templates when you're accepted to [onboard with NHS Notify]({% link pages/get-started/get-started.md %}) and have access to our integration environment. + +You can sign in with your Care Identity. We'll support you to set this up. + +{% include components/button.html + text="Sign in" + url="https://notify.nhs.uk/auth?redirect=%2Ftemplates%2Fmessage-templates" +%} diff --git a/docs/pages/using-nhs-notify/email-templates.md b/docs/pages/using-nhs-notify/email-templates.md index e880a0c..5dc35da 100644 --- a/docs/pages/using-nhs-notify/email-templates.md +++ b/docs/pages/using-nhs-notify/email-templates.md @@ -8,6 +8,7 @@ parent: Using NHS Notify nav_order: 2 permalink: /using-nhs-notify/email-templates section: Writing a message +published: false --- Provide a Word document of your email and NHS Notify will send it for you. diff --git a/docs/pages/using-nhs-notify/formatting.md b/docs/pages/using-nhs-notify/formatting.md new file mode 100644 index 0000000..1102754 --- /dev/null +++ b/docs/pages/using-nhs-notify/formatting.md @@ -0,0 +1,171 @@ +--- +# Feel free to add content and custom Front Matter to this file. +# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults + +layout: page +title: Formatting +parent: Using NHS Notify +nav_order: 2 +permalink: /using-nhs-notify/formatting +section: Writing a message +--- + +NHS Notify uses Markdown to format message content. + +You can see formatting instructions while you’re editing NHS App message, email and text message templates. + +To add formatting to a letter, download our blank template, apply the styles then [upload your letter as a PDF](https://notify.nhs.uk/using-nhs-notify/upload-a-letter). + +## Formatting options + +NHS App message templates can include: + +- [bullet points](#bullet-points) +- [headings](#headings) +- [numbered lists](#numbered-lists) +- [line breaks and paragraphs](#line-breaks-and-paragraphs) +- [bold text](#bold-text) +- [links and URLs]({% link pages/using-nhs-notify/links-and-urls.md %}) + +Email templates can include: + +- [bullet points](#bullet-points) +- [headings](#headings) +- [horizontal lines](#horizontal-lines) +- [numbered lists](#numbered-lists) +- [line breaks and paragraphs](#line-breaks-and-paragraphs) +- [links and URLs]({% link pages/using-nhs-notify/links-and-urls.md %}) + +Text message templates can include [links and URLs]({% link pages/using-nhs-notify/links-and-urls.md %}). + +Letter templates can include: + +- [bullet points](https://notify.nhs.uk/using-nhs-notify/upload-a-letter#bullet-points) +- [headings](https://notify.nhs.uk/using-nhs-notify/upload-a-letter#headings) +- [numbered lists](https://notify.nhs.uk/using-nhs-notify/upload-a-letter#numbered-lists) +- [page breaks](https://notify.nhs.uk/using-nhs-notify/upload-a-letter#page-breaks) +- [paragraphs](https://notify.nhs.uk/using-nhs-notify/upload-a-letter#paragraphs-and-body-text) +- [links and URLs]({% link pages/using-nhs-notify/links-and-urls.md %}) +- [images](https://notify.nhs.uk/using-nhs-notify/upload-a-letter#images) + +You can also find out about: + +- attachments +- images +- [telling recipients who your message is from]({% link pages/using-nhs-notify/tell-recipients-who-your-messages-are-from.md %}) + +## Guidance + +### Bullet points + +Use bullet points to help words or phrases stand out in your content. + +Put each item on a separate line with an asterisk and a space in front of each one. + +Leave an empty line before the first bullet point and after the last bullet point. + +Copy this example to add bullet points to NHS App messages and emails: + +{% include components/inset-text.html + text='Introduce bullet points with a lead-in line ending with a colon:

* bullet point 1
* bullet point 2
 ' + %} + +You cannot use bullet points in text message templates. + +Find out how to use [bullet points in letter templates](https://notify.nhs.uk/using-nhs-notify/upload-a-letter#bullet-points). + +### Headings + +Use a heading to tell recipients what your message is about. + +Use subheadings to break up the rest of your content. Your first subheading must come after a heading. + +Use one hash symbol followed by a space for a heading in NHS App messages and emails. For example: + +{% include components/inset-text.html + text='# This is a heading' +%} + +Use 2 hash symbols followed by a space for a subheading in NHS App messages and emails. For example: + +{% include components/inset-text.html + text='## This is a subheading' +%} + +You cannot use headings in text message templates. + +Find out how to use [headings in letter templates](https://notify.nhs.uk/using-nhs-notify/upload-a-letter#headings). + +### Horizontal lines + +Use a horizontal line to create separate sections in emails. + +To add a horizontal line between 2 paragraphs, use 3 dashes. Leave one empty line space after the first paragraph. For example: + +{% include components/inset-text.html +text='First paragraph

---

Second paragraph' +%} + +You cannot use headings in NHS App message, text message and letter templates. + +### Numbered lists + +Use numbered lists instead of bullet points to guide a user through a process, or when the order of the items in a list is relevant. + +You do not need a lead-in line for a numbered list. + +Copy this example to add numbered steps to NHS App messages and emails: + +{% 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.' +%} + +You cannot use numbered lists in text message templates. + +Find out how to use [numbered lists in letter templates](https://notify.nhs.uk/using-nhs-notify/upload-a-letter#numbered-lists). + +### Line breaks and paragraphs + +To add a line break, use 2 spaces at the end of your text. + +Copy this example to add line breaks to NHS App messages and emails: + +{% include components/inset-text.html +text='line 1
line 2
line 3 ' +%} + +To add a paragraph, use a blank line between each paragraph. + +Copy this example to add paragraphs to NHS App messages and emails: + +{% include components/inset-text.html +text='line 1

line 2

line 3' +%} + +You cannot use line breaks and paragraphs in text message templates. + +Find out how to use [paragraphs in letter templates](https://notify.nhs.uk/using-nhs-notify/upload-a-letter#paragraphs-and-body-text). + +### Bold text + +Use 2 asterisk symbols on either side of the words you want to be bold. + +Copy this example to add bold text to NHS App messages: + +{% include components/inset-text.html +text='**this is bold text**' +%} + +You cannot use bold text in emails or text message templates. + +To use bold text in letter templates, highlight the font you want to make bold then select 'bold' in the font menu in the home tab. + +## Attachments and images + +Attachments and images are not currently available for NHS App messages, emails and text messages. + +If you need to send an attachment or image, host it separately on a website and add a link to it in your message content. + +Find out about [images in letters](https://notify.nhs.uk/using-nhs-notify/upload-a-letter#images). + +If you need to include attachments such as leaflets with your letters, email us at . diff --git a/docs/pages/using-nhs-notify/letter-templates.md b/docs/pages/using-nhs-notify/letter-templates.md index 22ffa81..d7e79c3 100644 --- a/docs/pages/using-nhs-notify/letter-templates.md +++ b/docs/pages/using-nhs-notify/letter-templates.md @@ -3,11 +3,12 @@ # To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults layout: page -title: Letter templates +title: Upload a letter parent: Using NHS Notify nav_order: 4 permalink: /using-nhs-notify/letter-templates section: Writing a message +published: false --- Upload a PDF of your letter and NHS Notify will print and post it for you. @@ -57,7 +58,7 @@ Find out how to use: - [personalisation](#personalisation) - [headings](#headings) - [paragraphs and body text](#paragraphs-and-body-text) -- [links](#links) +- [links and URLs](#links-and-urls) - [bullet points](#bullet-points) - [images](#images) - [QR codes](#qr-codes) @@ -113,6 +114,10 @@ Use the main heading to summarise what your letter is about. Use headings to break your content up and to help recipients find what they need. +## Numbered lists + +Use the style 'List paragraph' in the template for numbered lists. Then select 'Numbering' in the 'Paragraph' section of the 'Home' tab. + ## Paragraphs and body text Use the style 'Normal' in the template for body text. @@ -121,7 +126,13 @@ Paragraphs can be split across 2 pages. If you do not want a paragraph to run over different pages, add a page break before the paragraph. -## Links +## Page breaks + +1. Go to 'Insert' in the top menu. +2. Select 'Pages'. +3. Select 'Page break'. + +## Links and URLs Use the style 'Hyperlink' in the template for links. diff --git a/docs/pages/using-nhs-notify/letters-in-other-languages.md b/docs/pages/using-nhs-notify/letters-in-other-languages.md index d0ce40e..e46c3ea 100644 --- a/docs/pages/using-nhs-notify/letters-in-other-languages.md +++ b/docs/pages/using-nhs-notify/letters-in-other-languages.md @@ -5,7 +5,7 @@ layout: page title: Letters in other languages parent: Using NHS Notify -nav_order: 6 +nav_order: 7 permalink: /using-nhs-notify/letters-in-other-languages section: Writing a message --- diff --git a/docs/pages/using-nhs-notify/links-and-urls.md b/docs/pages/using-nhs-notify/links-and-urls.md new file mode 100644 index 0000000..b1656ce --- /dev/null +++ b/docs/pages/using-nhs-notify/links-and-urls.md @@ -0,0 +1,63 @@ +--- +# Feel free to add content and custom Front Matter to this file. +# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults + +layout: page +title: Links and URLs +parent: Using NHS Notify +nav_order: 3 +permalink: /using-nhs-notify/links-and-urls +section: Writing a message +--- + +You can include links in your messages. How you do this depends on the message channel. + +You can see instructions on links and URLs while you’re editing a template. + +## Using the full URL + +To add a link to a message, you can write the URL in full. For example: + +{% include components/inset-text.html + text='Book now at https://www.nhs.uk/example' +%} + +For NHS App messages and emails, use square brackets around the full URL to make it the link text and use round brackets around the full URL. + +Make sure there are no spaces between the brackets or the link will not work. For example: + +{% include components/inset-text.html + text='[https://www.nhs.uk/example](https://www.nhs.uk/example)' +%} + +URLs should be easy to read. + +{% include components/details.html + heading='Short URLs' + text=' +If you have a long, complex web address, you can request a short URL from GOV.UK. This can take some time and may delay your template creation. + +We do not recommend using a third-party link shortening service because: + +- your users cannot see where the link will take them +- your link might stop working if there’s a service outage +- you can no longer control where the redirect goes' +%} + +## Converting text into a link + +For NHS App messages and emails, you can convert text into a link. + +Use square brackets around the link text and round brackets around the full URL. Make sure there are no spaces between the brackets or the link will not work. For example: + +{% include components/inset-text.html + text='[Read more](https://www.nhs.uk/example)' +%} + +Link text should tell the recipient what action they need to take and where the link goes. + +Never use ‘click here’, ‘click link’, ‘this link’ or ‘more’, as these do not make sense when read out of context. + +If the recipient is not expecting to receive an email from you, we recommend using the full URL instead of link text. + +You cannot convert text into a link in text message or letter templates. diff --git a/docs/pages/using-nhs-notify/routing-plans.md b/docs/pages/using-nhs-notify/message-plans.md similarity index 97% rename from docs/pages/using-nhs-notify/routing-plans.md rename to docs/pages/using-nhs-notify/message-plans.md index f46ba08..b4439d6 100644 --- a/docs/pages/using-nhs-notify/routing-plans.md +++ b/docs/pages/using-nhs-notify/message-plans.md @@ -38,4 +38,4 @@ Use primary message cascades to send a message with a different channel as a fal ### Secondary cascades -Use secondary message cascades to send a message with another channel at the same time as your primary channel. For example, sending a text message at the same time as an email. You cannot fallback to another channel with secondary cascades. +Use secondary message cascades to send a message with another channel at the same time as your primary channel. For example, sending a text message at the same time as an email. You cannot fall back to another channel with secondary cascades. diff --git a/docs/pages/using-nhs-notify/nhs-app-templates.md b/docs/pages/using-nhs-notify/nhs-app-templates.md index 5734a27..0d43f2e 100644 --- a/docs/pages/using-nhs-notify/nhs-app-templates.md +++ b/docs/pages/using-nhs-notify/nhs-app-templates.md @@ -8,6 +8,7 @@ parent: Using NHS Notify nav_order: 1 permalink: /using-nhs-notify/nhs-app-templates section: Writing a message +published: false --- Provide a Word document of your NHS App message and NHS Notify will send it for you. diff --git a/docs/pages/using-nhs-notify/personalisation.md b/docs/pages/using-nhs-notify/personalisation.md index c0bd830..d9af74f 100644 --- a/docs/pages/using-nhs-notify/personalisation.md +++ b/docs/pages/using-nhs-notify/personalisation.md @@ -5,7 +5,7 @@ layout: page title: Personalisation parent: Using NHS Notify -nav_order: 7 +nav_order: 4 permalink: /using-nhs-notify/personalisation section: Writing a message --- @@ -23,6 +23,8 @@ You can use: - [Personal Demographics Service (PDS) personalisation fields](#personal-demographics-service-pds-personalisation-fields) - [custom personalisation fields](#custom-personalisation-fields) +You can see personalisation instructions while you’re editing a template. + ## Personal Demographics Service (PDS) personalisation fields NHS Notify uses the [Personal Demographics Service (PDS)](https://digital.nhs.uk/services/personal-demographics-service) to find and populate certain personalisation fields for each recipient. This happens automatically when you [tell us who you want to message]({% link pages/using-nhs-notify/tell-us-who-you-want-to-message.md %}) using recipients' NHS numbers. diff --git a/docs/pages/using-nhs-notify/tell-recipients-who-your-messages-are-from.md b/docs/pages/using-nhs-notify/tell-recipients-who-your-messages-are-from.md index 0055180..d0bd3b1 100644 --- a/docs/pages/using-nhs-notify/tell-recipients-who-your-messages-are-from.md +++ b/docs/pages/using-nhs-notify/tell-recipients-who-your-messages-are-from.md @@ -21,7 +21,7 @@ You can change the: You cannot change the return addresses of letters. These are set by NHS Notify’s suppliers and are printed on the envelopes. -If you want users to reply to your letters, include your organisation or service's address in the content of your [letter templates]({% link pages/using-nhs-notify/letter-templates.md %}). +If you want users to reply to your letters, include your organisation or service's address in the content of your [letter templates]({% link pages/using-nhs-notify/upload-a-letter.md %}). ## NHS App sender name diff --git a/docs/pages/using-nhs-notify/text-message-templates.md b/docs/pages/using-nhs-notify/text-message-templates.md index f738343..cf580b8 100644 --- a/docs/pages/using-nhs-notify/text-message-templates.md +++ b/docs/pages/using-nhs-notify/text-message-templates.md @@ -8,6 +8,7 @@ parent: Using NHS Notify nav_order: 3 permalink: /using-nhs-notify/text-message-templates section: Writing a message +published: false --- Provide a Word document of your text message and NHS Notify will send it for you. diff --git a/docs/pages/using-nhs-notify/upload-a-letter.md b/docs/pages/using-nhs-notify/upload-a-letter.md new file mode 100644 index 0000000..d27983c --- /dev/null +++ b/docs/pages/using-nhs-notify/upload-a-letter.md @@ -0,0 +1,227 @@ +--- +# Feel free to add content and custom Front Matter to this file. +# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults + +layout: page +title: Upload a letter +parent: Using NHS Notify +nav_order: 4 +permalink: /using-nhs-notify/upload-a-letter +section: Writing a message + +--- + +Upload a PDF of your letter and we'll print and post it for you. + +Your PDF must meet our letter specification. The page size and layout is A4 portrait (210mm x 297mm). + +You'll need to: + +1. [Download our blank Word letter template](#download-our-blank-letter-template). +2. [Format your letter](#formatting-your-letter). +3. [Convert your letter to a PDF](#converting-your-letter-to-a-pdf). +4. Email your letter PDF to our onboarding team at . + +## Download our blank letter template + +Download the relevant blank letter template to set up your letter: + +- [standard letter template]({% link assets/worddocs/letter-template-nhs-notify_.docx %}) +- [large print letter template]({% link assets/worddocs/letter-template-nhs-notify-large-print_.docx %}) +- [other language letter template]({% link assets/worddocs/letter-template-nhs-notify-other-language_.docx %}) +- [other language (right-aligned) letter template]({% link assets/worddocs/letter-template-nhs-notify-other-language-right-aligned_.docx %}) +- [parent or guardian letter template]({% link assets/worddocs/letter-template-nhs-notify-parent-or-guardian_.docx %}) + +You'll need the desktop Microsoft Word app. + +Save the template then add your message content. + +## Formatting your letter + +Do not change the page margins in the letter template. It has the correct layout for printing. + +Organise your message content using the styles in the template. + +If you're copying and pasting text from another document, paste it without any formatting. Then [apply the styles](https://support.microsoft.com/en-gb/office/apply-styles-f8b96097-4d25-4fac-8200-6139c8093109) in the template. + +You can also use [Microsoft Word's format painter](https://support.microsoft.com/en-gb/office/use-the-format-painter-4bb415a9-d4e4-42b7-b579-170adc594e40) to copy the formatting of the styles and apply it to your text. + +{% include components/inset-text.html + text="Keep the comments and pre-formatted text in the template until you've finished adding your message content. They'll help you to apply the styles." +%} + +Find out how to use: + +- [font and font size](#font-and-font-size) +- [personalisation](#personalisation) +- [headings](#headings) +- [paragraphs and body text](#paragraphs-and-body-text) +- [links and URLs](#links-and-urls) +- [bullet points](#bullet-points) +- [images](#images) +- [QR codes](#qr-codes) + +You can also find out about content you should not edit, including the: + +- [address field](#address-field) +- [NHS logo](#nhs-logo) +- [NHS number](#nhs-number) +- [date](#date) +- [page count](#page-count) + +## Font and font size + +The font size for standard letters is 12 points. The font size for large print is 16 points. + +NHS Notify prints letters in the font Noto Sans. + +### Downloading your font + +You must download and use Noto Sans as the font for all of your letters, including [letters in other languages]({% link pages/using-nhs-notify/letters-in-other-languages.md %}). If you're sending letters in other languages that use different character sets, download Noto Sans in those languages. + +Go to [Noto Sans on Google Fonts](https://fonts.google.com/noto/fonts) and choose the languages you need by selecting 'Get font'. Then select 'Download all' to download Noto Sans to your device as a zip file. + +Noto Sans is a free font. + +{% include components/details.html + heading='Downloading Noto Sans for Windows' + text=' + +1. Right click the zip file and select ‘Extract all’. +2. Open the file. Open each folder. Select all of the TrueType font files, right click and select ‘Install’. +3. If the folder contains a sub-folder called ‘static’, open this. +4. Select all of the TrueType font files in this folder. Right click and select ‘Install’. + ' +%} + +{% include components/details.html + heading='Downloading Noto Sans for Mac' + text=' +Follow the [install fonts guidance](https://support.apple.com/en-gb/guide/font-book/fntbk1000/mac). Make sure you install the static fonts. + +Read [Google’s guidance on installing fonts](https://fonts.google.com/knowledge/using_type/installing_and_managing_fonts) for more information.' +%} + +## Personalisation + +[Learn how to use personalisation]({% link pages/using-nhs-notify/personalisation.md %}). + +## Headings + +Use the style 'Heading 2, NHS letter heading' in the template for headings. + +Headings are in bold. They are not in italics or underlined. + +Use the main heading to summarise what your letter is about. + +Use headings to break your content up and to help recipients find what they need. + +## Paragraphs and body text + +Use the style 'Normal' in the template for body text. + +Paragraphs can be split across 2 pages. + +If you do not want a paragraph to run over different pages, add a page break before the paragraph. + +## Links and URLs + +Use the style 'Hyperlink' in the template for links. + +Links in letters are in bold to make them stand out. Do not use underlined text or italics. + +Do not split links across different pages. Add a page break before the paragraph with the link if needed. + +Learn more about [links and URLs]({% link pages/using-nhs-notify/links-and-urls.md %}). + +## Bullet points + +Use the style 'List paragraph' in the template for bullet points. + +You can use bullet points to make your text easier to read. Make sure that: + +- you use a lead-in line +- the bullets make sense running on from the lead-in line +- you use lower case at the start of the bullet +- there are no commas, full stops or semicolons at the end of bullets + +## Images + +Images must be black and white. Position them within the same page margins as the text. + +## QR codes + +If you want to include a QR code, put it in the body of your letter. Insert it as an image. + +You'll need to generate the QR code yourself. + +You must also provide a short URL or written instructions for how to find your webpage. For example: + +{% include components/inset-text.html + text='scan the QR code or visit https://www.notify.nhs.uk' +%} + +## Content you should not edit + +### Address field + +The address field fits inside the address window on the envelope. + +The address is a personalisation field and is set automatically. + +The recipient's name is always included as the first line of the address. + +If your letter is about a child, use the [parent or guardian letter template](#download-our-blank-letter-template). This template includes 'Parent or guardian of' in the first line of the address. + +### NHS logo + +The NHS logo is black and white. It's positioned in the top right of the letter. + +### NHS number + +The recipient's NHS number appears above the body content of the letter and is right aligned. + +It's a personalisation field and is set automatically. + +### Date + +The date that will be printed is the date when the letter is dispatched. It's set automatically. + +It appears above the body content of the letter and is right aligned. + +### Page count + +The page count shows the current page number and the total number of pages. For example: + +{% include components/inset-text.html + text='Page 1 of 2' +%} + +It updates automatically. + +## Converting your letter to a PDF + +When you've finished editing your template in Microsoft Word, you'll need to save it as a PDF. + +Before you start, check that your English message content is in the Noto Sans font and any message content in other languages is in the relevant language variant of the Noto Sans font. + +1. In the 'Review' tab, go to 'Markup'. Select 'No markup' from the drop-down list to hide any comments or tracked changes. +2. Select 'File' and 'Save as'. Select 'PDF' from the drop-down list. +3. For Windows, select 'Standard (publishing online and printing)' in the 'Optimize for' section. Then select 'Save'. For Mac, select 'Best for printing' in the 'File format' section. Then select 'Save'. + +### Naming your PDF + +Name your PDF template clearly so that it's easy to identify. Make sure you include the following details: + +- organisation or service name +- cohort or topic of your message +- language used, including English +- accessible format or standard format used +- message channel - letter +- version number + +For example: + +{% include components/inset-text.html + text='vaccinations_under-16_english_standard_letter_v1' +%} diff --git a/docs/pages/using-nhs-notify/using-nhs-notify.md b/docs/pages/using-nhs-notify/using-nhs-notify.md index 37f6299..3be890e 100644 --- a/docs/pages/using-nhs-notify/using-nhs-notify.md +++ b/docs/pages/using-nhs-notify/using-nhs-notify.md @@ -24,20 +24,20 @@ This guidance is to help teams understand how to use NHS Notify. ## Writing a message -- [NHS App message templates]({% link pages/using-nhs-notify/nhs-app-templates.md %}) -- [Email templates]({% link pages/using-nhs-notify/email-templates.md %}) -- [Text message templates]({% link pages/using-nhs-notify/text-message-templates.md %}) -- [Letter templates]({% link pages/using-nhs-notify/letter-templates.md %}) +- [Create and submit a template]({% link pages/using-nhs-notify/create-and-submit-a-template.md %}) +- [Upload a letter]({% link pages/using-nhs-notify/upload-a-letter.md %}) +- [Formatting]({% link pages/using-nhs-notify/formatting.md %}) +- [Links and URLs]({% link pages/using-nhs-notify/links-and-urls.md %}) +- [Personalisation]({% link pages/using-nhs-notify/personalisation.md %}) - [Accessible formats]({% link pages/using-nhs-notify/accessible-formats.md %}) - [Letters in other languages]({% link pages/using-nhs-notify/letters-in-other-languages.md %}) -- [Personalisation]({% link pages/using-nhs-notify/personalisation.md %}) ## Sending a message - [Tell recipients who your messages are from]({% link pages/using-nhs-notify/tell-recipients-who-your-messages-are-from.md %}) - [Delivery times]({% link pages/using-nhs-notify/delivery-times.md %}) - [Tell us who you want to message]({% link pages/using-nhs-notify/tell-us-who-you-want-to-message.md %}) -- [Routing plans]({% link pages/using-nhs-notify/routing-plans.md %}) +- [Message plans]({% link pages/using-nhs-notify/message-plans.md %}) - [Recipients you cannot message]({% link pages/using-nhs-notify/recipients-you-cannot-message.md %}) - [Approve your messages before we send them]({% link pages/using-nhs-notify/approve-your-messages.md %}) - [Message, channel and supplier status]({% link pages/using-nhs-notify/message-status.md %}) diff --git a/scripts/config/markdownlint.yaml b/scripts/config/markdownlint.yaml index bf901c5..1868189 100644 --- a/scripts/config/markdownlint.yaml +++ b/scripts/config/markdownlint.yaml @@ -18,3 +18,6 @@ MD003: false # https://github.com/DavidAnson/markdownlint/blob/main/doc/md022.md MD022: false + +# https://github.com/DavidAnson/markdownlint/blob/main/doc/md037.md +MD037: false