From f3c5d966f73d56db0d927e8d5a9312c197d1a8f1 Mon Sep 17 00:00:00 2001 From: karlchillmaid Date: Fri, 14 Feb 2020 13:59:54 +0000 Subject: [PATCH 1/6] Simplify numbered lists of instructions --- .../guidance/branding-and-customisation.html | 20 ++++++++----------- 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/app/templates/views/guidance/branding-and-customisation.html b/app/templates/views/guidance/branding-and-customisation.html index 1f22ce366..88a3ec9ba 100644 --- a/app/templates/views/guidance/branding-and-customisation.html +++ b/app/templates/views/guidance/branding-and-customisation.html @@ -26,9 +26,8 @@

To change your email branding:

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

Add a reply-to email address

@@ -38,9 +37,8 @@

To add a reply-to email address:

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

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

    -
  1. Sign in to Notify.
    2. -
  2. Go to the Settings page.
    3. -
  3. In the Text message settings section, select Manage on the Text message senders row.
    4. +
  4. Go to the Text message settings section of the Settings page.
    5. +
  5. Select Manage on the Text message senders row.
  6. Select Change or Add text message sender.
@@ -64,9 +61,8 @@

To add a logo to your letters:

    -
  1. Sign in to Notify.
    2. -
  2. Go to the Settings page.
    3. -
  3. In the Letter settings section, select Change on the Letter branding row.
    4. +
  4. Go to the Letter settings section of the Settings page.
    5. +
  5. Select Change on the Letter branding row.
{% endblock %} From 29c8050bc4700933914061825ad76a86252b50e1 Mon Sep 17 00:00:00 2001 From: karlchillmaid Date: Fri, 14 Feb 2020 14:02:08 +0000 Subject: [PATCH 2/6] Simplify numbered lists of instructions --- app/templates/views/guidance/create-and-send-messages.html | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/app/templates/views/guidance/create-and-send-messages.html b/app/templates/views/guidance/create-and-send-messages.html index 2fc567a6d..09b8334ba 100644 --- a/app/templates/views/guidance/create-and-send-messages.html +++ b/app/templates/views/guidance/create-and-send-messages.html @@ -16,8 +16,7 @@

To send a batch of messages at once:

    -
  1. Sign in to Notify.
    2. -
  2. Go to the Templates page and choose an existing template.
    3. +
  3. Go to the Templates page and choose an existing template.
  4. Select Send.
  5. If you’re sending emails, select Upload a list of email addresses. If you’re sending text messages, select Upload a list of phone numbers. If you’re sending letters, select Upload a list of addresses.
    6. From 390fcc2269200514940016c13d31e234d788c4f7 Mon Sep 17 00:00:00 2001 From: karlchillmaid Date: Fri, 14 Feb 2020 14:04:46 +0000 Subject: [PATCH 3/6] Simplify numbered lists of instructions --- .../views/guidance/edit-and-format-messages.html | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/app/templates/views/guidance/edit-and-format-messages.html b/app/templates/views/guidance/edit-and-format-messages.html index 96e22b191..6e80f3dee 100644 --- a/app/templates/views/guidance/edit-and-format-messages.html +++ b/app/templates/views/guidance/edit-and-format-messages.html @@ -23,8 +23,7 @@

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

      -
    1. Sign in to Notify.
      2. -
    2. Go to the Templates page.
      3. +
    3. Go to the Templates page.
    4. Add a new template or choose an existing template and select Edit.
    @@ -63,8 +62,7 @@

    To add a placeholder to the template:

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

      To add optional content to your emails and text messages:

        -
      1. Sign in to Notify.
        2. -
      2. Go to the Templates page.
        3. +
      3. Go to the Templates page.
      4. Add a new template or choose an existing template and select Edit.
      5. 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.))
      6. Select Save.
        7. From 2184f4c7047b0ba23570ca67ec930d7aa7e7f3ad Mon Sep 17 00:00:00 2001 From: karlchillmaid Date: Fri, 14 Feb 2020 14:09:32 +0000 Subject: [PATCH 4/6] Simplify numbered list of instructions Simplify numbered list of instructions and change file links --- app/templates/views/guidance/upload-a-letter.html | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/app/templates/views/guidance/upload-a-letter.html b/app/templates/views/guidance/upload-a-letter.html index 7d62565bb..2fbbec5d2 100644 --- a/app/templates/views/guidance/upload-a-letter.html +++ b/app/templates/views/guidance/upload-a-letter.html @@ -15,8 +15,7 @@

        To upload and send a letter from a PDF file:

          -
        1. Sign in to Notify.
          2. -
        2. Go to the Uploads page.
          3. +
        3. Go to the Uploads page.
        4. Select Upload a letter.
        5. Select Choose file.
        @@ -34,11 +33,11 @@

        The content of your letter must appear inside the printable area.

        -

        To help you set up your letter, you can download:

        +

        To help you set up your letter, you can download our:

        From f4e4de0d03b90c4150452c18958fee02fc5fa72c Mon Sep 17 00:00:00 2001 From: karlchillmaid Date: Tue, 18 Feb 2020 10:35:21 +0000 Subject: [PATCH 5/6] Fix settings links --- .../views/guidance/branding-and-customisation.html | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/app/templates/views/guidance/branding-and-customisation.html b/app/templates/views/guidance/branding-and-customisation.html index 88a3ec9ba..18bb83068 100644 --- a/app/templates/views/guidance/branding-and-customisation.html +++ b/app/templates/views/guidance/branding-and-customisation.html @@ -26,7 +26,7 @@

        To change your email branding:

          -
        1. Go to the Email settings section of the Settings page.
          2. +
        2. Go to the Email settings section of the Settings page.
        3. Select Change on the Email branding row.
        @@ -37,7 +37,7 @@

        To add a reply-to email address:

          -
        1. Go to the Email settings section of the Settings page.
          2. +
        2. Go to the Email settings section of the Settings page.
        3. Select Manage on the Reply-to email addresses row.
        4. Select Add reply-to address.
        @@ -49,7 +49,7 @@

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

          -
        1. Go to the Text message settings section of the Settings page.
          2. +
        2. Go to the Text message settings section of the Settings page.
        3. Select Manage on the Text message senders row.
        4. Select Change or Add text message sender.
        @@ -61,7 +61,7 @@

        To add a logo to your letters:

          -
        1. Go to the Letter settings section of the Settings page.
          2. +
        2. Go to the Letter settings section of the Settings page.
        3. Select Change on the Letter branding row.
        From 46a4e1c6124ad3a12a03d9e5082bce3017ba945e Mon Sep 17 00:00:00 2001 From: Chris Hill-Scott Date: Wed, 19 Feb 2020 08:20:38 +0000 Subject: [PATCH 6/6] Add a macro for generating current service links MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This is a convenient way of being able to link into pages of the the app from guidance. It handles the case where the current service is not known, either because the user hasn’t chosen one, or because they’re not signed in. This commit also cleans up some unused Jinja imports. --- .../components/current-service-link.html | 7 ++++ .../guidance/branding-and-customisation.html | 33 +++++++++---------- .../guidance/create-and-send-messages.html | 11 +++---- .../guidance/edit-and-format-messages.html | 9 +++-- .../views/guidance/send-files-by-email.html | 7 ++-- .../views/guidance/upload-a-letter.html | 15 ++++----- 6 files changed, 41 insertions(+), 41 deletions(-) create mode 100644 app/templates/components/current-service-link.html diff --git a/app/templates/components/current-service-link.html b/app/templates/components/current-service-link.html new file mode 100644 index 000000000..807ba8ac4 --- /dev/null +++ b/app/templates/components/current-service-link.html @@ -0,0 +1,7 @@ +{% macro current_service_link(endpoint, link_text) %} + {% if current_service %} + {{ link_text }} + {% else %} + {{ link_text|capitalize }} + {% endif %} +{% endmacro %} diff --git a/app/templates/views/guidance/branding-and-customisation.html b/app/templates/views/guidance/branding-and-customisation.html index 18bb83068..cc68bcb75 100644 --- a/app/templates/views/guidance/branding-and-customisation.html +++ b/app/templates/views/guidance/branding-and-customisation.html @@ -1,6 +1,5 @@ {% 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 %} +{% from "components/current-service-link.html" import current_service_link %} {% block per_page_title %} Branding and customisation @@ -9,59 +8,59 @@ {% block content_column_content %}

        Branding and customisation

        - +

        This page explains how to:

        - + - +

        Change your email branding

        The default branding for email templates is the GOV.UK logo.

        - +

        To change your email branding:

          -
        1. Go to the Email settings section of the Settings page.
          2. +
        2. Go to the Email settings section of the {{ current_service_link('main.service_settings', 'settings') }} page.
        3. Select Change on the Email branding row.

        Add a reply-to email address

        - +

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

        To add a reply-to email address:

          -
        1. Go to the Email settings section of the Settings page.
          2. +
        2. Go to the Email settings section of the {{ current_service_link('main.service_settings', 'settings') }} page.
        3. Select Manage on the Reply-to email addresses row.
        4. Select Add reply-to address.
        - +

        Change the text message sender

        - +

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

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

        - +
          -
        1. Go to the Text message settings section of the Settings page.
          2. +
        2. Go to the Text message settings section of the {{ current_service_link('main.service_settings', 'settings') }} page.
        3. Select Manage on the Text message senders row.
        4. Select Change or Add text message sender.

        Change your letter branding

        - +

        Letter templates do not have default branding.

        - +

        To add a logo to your letters:

        - +
          -
        1. Go to the Letter settings section of the Settings page.
          2. +
        2. Go to the Letter settings section of the {{ current_service_link('main.service_settings', 'settings') }} page.
        3. Select Change on the Letter branding row.
        diff --git a/app/templates/views/guidance/create-and-send-messages.html b/app/templates/views/guidance/create-and-send-messages.html index 09b8334ba..fa905b33d 100644 --- a/app/templates/views/guidance/create-and-send-messages.html +++ b/app/templates/views/guidance/create-and-send-messages.html @@ -1,6 +1,5 @@ {% 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 %} +{% from "components/current-service-link.html" import current_service_link %} {% block per_page_title %} Send messages @@ -9,15 +8,15 @@ {% block content_column_content %}

        Send messages

        - +

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

        - +

        Bulk sending

        To send a batch of messages at once:

          -
        1. Go to the Templates page and choose an existing template.
          2. +
        2. Go to the {{ current_service_link('main.choose_template', 'templates') }} page and choose an existing template.
        3. Select Send.
        4. If you’re sending emails, select Upload a list of email addresses. If you’re sending text messages, select Upload a list of phone numbers. If you’re sending letters, select Upload a list of addresses.
          5. - + {% endblock %} diff --git a/app/templates/views/guidance/edit-and-format-messages.html b/app/templates/views/guidance/edit-and-format-messages.html index 6e80f3dee..a80655a81 100644 --- a/app/templates/views/guidance/edit-and-format-messages.html +++ b/app/templates/views/guidance/edit-and-format-messages.html @@ -1,6 +1,5 @@ {% 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 %} +{% from "components/current-service-link.html" import current_service_link %} {% block per_page_title %} Edit and format messages @@ -23,7 +22,7 @@

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

            -
          1. Go to the Templates page.
            2. +
          2. Go to the {{ current_service_link('main.choose_template', 'templates') }} page.
          3. Add a new template or choose an existing template and select Edit.
          @@ -62,7 +61,7 @@

          To add a placeholder to the template:

            -
          1. Go to the Templates page.
            2. +
          2. Go to the {{ current_service_link('main.choose_template', 'templates') }} page.
          3. Add a new template or choose an existing template and select Edit.
          4. Add a placeholder using double brackets. For example: Hello ((first name)), your reference is ((ref number)).
          5. Select Save.
            6. @@ -82,7 +81,7 @@

            To add optional content to your emails and text messages:

              -
            1. Go to the Templates page.
              2. +
            2. Go to the {{ current_service_link('main.choose_template', 'templates') }} page.
            3. Add a new template or choose an existing template and select Edit.
            4. 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.))
            5. Select Save.
              6. diff --git a/app/templates/views/guidance/send-files-by-email.html b/app/templates/views/guidance/send-files-by-email.html index 329eb24b9..331039a2e 100644 --- a/app/templates/views/guidance/send-files-by-email.html +++ b/app/templates/views/guidance/send-files-by-email.html @@ -1,6 +1,4 @@ {% 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 %} Send files by email @@ -9,10 +7,9 @@ {% block content_column_content %}

              Send files by email

              - +

              Contact us if you want to send files by email.

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

              - + {% endblock %} - diff --git a/app/templates/views/guidance/upload-a-letter.html b/app/templates/views/guidance/upload-a-letter.html index 2fbbec5d2..42f33d765 100644 --- a/app/templates/views/guidance/upload-a-letter.html +++ b/app/templates/views/guidance/upload-a-letter.html @@ -1,6 +1,5 @@ {% 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 %} +{% from "components/current-service-link.html" import current_service_link %} {% block per_page_title %} Upload a letter @@ -9,13 +8,13 @@ {% block content_column_content %}

              Upload a letter

              - +

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

              - +

              To upload and send a letter from a PDF file:

              - +
                -
              1. Go to the Uploads page.
                2. +
              2. Go to the {{ current_service_link('main.uploads', 'uploads') }} page.
              3. Select Upload a letter.
              4. Select Choose file.
              @@ -30,9 +29,9 @@
            6. 10 pages or less
            7. smaller than 2MB
              8. - +

              The content of your letter must appear inside the printable area.

              - +

              To help you set up your letter, you can download our: