diff --git a/app/templates/views/guidance b/app/templates/views/guidance new file mode 100644 index 000000000..0ff87462e --- /dev/null +++ b/app/templates/views/guidance @@ -0,0 +1,183 @@ +{% extends "content_template.html" %} +{% from "components/table.html" import mapping_table, row, text_field, edit_field, field with context %} +{% from "components/sub-navigation.html" import sub_navigation %} + +{% block per_page_title %} + Get started +{% endblock %} + +{% block content_column_content %} + +

Get started

+ +

This guidance is for teams using GOV.UK Notify to send emails, text messages and letters.

+ +

It includes information about how to:

+ + + +

Create and send messages

+ +

Create an account to see a short tutorial explaining how to create and send messages.

+ +

Edit and format messages

+ +

Formatting

+ +

You can see a list of formatting instructions on the edit template page:

+ +
    +
  1. Sign in to Notify.
  2. +
  3. Go to the Templates page.
  4. +
  5. Add a new template or choose an existing template and select Edit.
  6. +
+ +

Email templates can include:

+ + +

Letter templates can include headings and bullets.

+ +

Notify does not allow bold, italics, subheadings, underlined text, HTML formatting or different fonts. This is because they can make it harder for users to read what you've written.

+ +

Links

+ +

When composing an email or text message, write URLs in full and Notify will convert them into links for you.

+ +

You cannot convert text into a link. Research shows that recipients like to read the URL to check a link looks genuine before they click it. This is hard to do if the URL is hidden behind clickable link text.

+ +

If your links are very long, we do not recommend using a third-party link shortening service because:

+ + + +

Personalised content

+ +

To personalise the content of your messages, add a placeholder to the template.

+ +

Placeholders are filled in with details, like a name or reference number, each time you send a message.

+ +

To add a placeholder to the template:

+ +
    +
  1. Sign in to Notify.
  2. +
  3. Go to the Templates page.
  4. +
  5. Add a new template or choose an existing template and select Edit.
  6. +
  7. Add a placeholder using double brackets. For example: Hello ((first name)), your reference is ((ref number)).
  8. +
  9. Select Save.
  10. +
+ +

When you send a message you can either:

+ + + +

If you upload a list, the column names need to match the placeholders in your template.

+ +

Optional content

+ +

To add optional content to your emails and text messages:

+ +
    +
  1. Sign in to Notify.
  2. +
  3. Go to the Templates page.
  4. +
  5. Add a new template or choose an existing template and select Edit.
  6. +
  7. Use double brackets and ?? to define optional content. For example, if you only want to show something to people who are under 18: ((under18??Please get your application signed by a parent or guardian.))
  8. +
  9. Select Save.
  10. +
+ +

For each person you send this message to, specify ‘yes’ or ‘no’ to show or hide this content. You can either:

+ + + +

If you upload a list, the column names need to match the optional content in your template.

+ +

You cannot add optional content to a letter.

+ +

Send files by email

+ +

Contact us if you want to send files by email.

+ +

Follow the instructions to send a file by email in our API documentation.

+ +

Upload your own letters

+ +

You can upload and send your own letters instead of creating a reusable letter template.

+ +

To upload and send your own letter from a PDF file:

+ +
    +
  1. Sign in to Notify.
  2. +
  3. Go to the Uploads page.
  4. +
  5. Select Upload a letter.
  6. +
  7. Select Choose file.
  8. +
+ +

Your file must meet our letter specification.

+ +

Branding and customisation

+ +

Change email branding

+ +

To change your email branding:

+ +
    +
  1. Sign in to Notify.
  2. +
  3. Go to the Settings page.
  4. +
  5. In the Email settings section, select Change on the Email branding row.
  6. +
+ +

Add a reply-to email address

+ +

Notify lets you choose the email address that users reply to. You must add at least one reply-to address before your service can go live.

+ +

To add a reply-to email address:

+ +
    +
  1. Sign in to Notify.
  2. +
  3. Go to the Settings page.
  4. +
  5. In the Email settings section, select Manage on the Reply-to email addresses row.
  6. +
  7. Select Add reply-to address.
  8. + +
+ +

Change the text message sender

+ +

The text message sender name tells your users who the message is from.

+ +

To change the text message sender from the default of ‘GOVUK’:

+ +
    +
  1. Sign in to Notify.
  2. +
  3. Go to the Settings page.
  4. +
  5. In the Text message settings section, select Manage on the Text message senders row.
  6. + +

    Change letter branding

    + +

    To change your letter branding:

    + +
      +
    1. Sign in to Notify.
    2. +
    3. Go to the Settings page.
    4. +
    5. In the Letter settings section, select Change on the Letter branding row.
    6. +
    + +{% endblock %}