From 590b1abd832f3899c923cfd0697c80f751fad3c7 Mon Sep 17 00:00:00 2001 From: Owen Jones Date: Mon, 4 Nov 2024 18:09:44 +0000 Subject: [PATCH] Make link text for components and patterns consistent Co-Authored-By: Calvin Lau <77630796+calvin-lau-sig7@users.noreply.github.com> --- src/accessibility/wcag-2.2/index.md | 68 +++++++++---------- src/community/roadmap/index.md | 6 +- src/components/accordion/index.md | 2 +- src/components/back-link/index.md | 4 +- src/components/button/index.md | 8 +-- src/components/character-count/index.md | 4 +- src/components/checkboxes/index.md | 6 +- src/components/cookie-banner/index.md | 8 +-- src/components/date-input/index.md | 2 +- src/components/details/index.md | 2 +- src/components/error-message/index.md | 38 +++++------ src/components/error-summary/index.md | 6 +- src/components/exit-this-page/index.md | 6 +- src/components/fieldset/index.md | 4 +- src/components/file-upload/index.md | 2 +- src/components/footer/index.md | 6 +- src/components/header/index.md | 12 ++-- src/components/index.md | 2 +- src/components/inset-text/index.md | 2 +- src/components/notification-banner/index.md | 12 ++-- src/components/pagination/index.md | 2 +- src/components/panel/index.md | 2 +- src/components/password-input/index.md | 12 ++-- src/components/phase-banner/index.md | 4 +- src/components/radios/index.md | 8 +-- src/components/select/index.md | 2 +- src/components/service-navigation/index.md | 10 +-- src/components/skip-link/index.md | 2 +- src/components/summary-list/index.md | 4 +- src/components/tabs/index.md | 2 +- src/components/tag/index.md | 4 +- src/components/task-list/index.md | 8 +-- src/components/text-input/index.md | 22 +++--- src/components/textarea/index.md | 10 +-- .../index.md | 2 +- src/get-started/focus-states/index.md | 4 +- src/patterns/addresses/index.md | 2 +- src/patterns/bank-details/index.md | 2 +- src/patterns/check-answers/index.md | 2 +- src/patterns/complete-multiple-tasks/index.md | 14 ++-- src/patterns/confirm-a-phone-number/index.md | 2 +- .../confirm-an-email-address/index.md | 2 +- .../index.md | 4 +- src/patterns/cookies-page/index.md | 10 +-- src/patterns/create-a-username/index.md | 2 +- src/patterns/dates/index.md | 2 +- src/patterns/email-addresses/index.md | 4 +- src/patterns/equality-information/index.md | 2 +- src/patterns/exit-a-page-quickly/index.md | 4 +- src/patterns/names/index.md | 4 +- .../national-insurance-numbers/index.md | 4 +- src/patterns/navigate-a-service/index.md | 22 +++--- src/patterns/passwords/index.md | 4 +- src/patterns/phone-numbers/index.md | 2 +- .../problem-with-the-service-pages/index.md | 2 +- src/patterns/question-pages/index.md | 4 +- .../service-unavailable-pages/index.md | 2 +- src/patterns/step-by-step-navigation/index.md | 2 +- src/patterns/task-list-pages/index.md | 2 +- .../index.md | 2 +- src/patterns/validation/index.md | 12 ++-- src/styles/headings/index.md | 2 +- src/styles/layout/index.md | 4 +- src/styles/page-template/index.md | 18 ++--- 64 files changed, 219 insertions(+), 217 deletions(-) diff --git a/src/accessibility/wcag-2.2/index.md b/src/accessibility/wcag-2.2/index.md index fa5f78edf3..357c6c0d63 100644 --- a/src/accessibility/wcag-2.2/index.md +++ b/src/accessibility/wcag-2.2/index.md @@ -55,7 +55,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA rows: [ [ { - html: 'Back link' + html: 'Back link component' }, { html: 'Redundant entry
Target size (minimum)' @@ -63,7 +63,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Breadcrumbs' + html: 'Breadcrumbs component' }, { html: 'Target size (minimum)' @@ -71,7 +71,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Button' + html: 'Button component' }, { html: 'Target size (minimum)' @@ -79,7 +79,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Cookie banner' + html: 'Cookie banner component' }, { html: 'Focus not obscured (minimum)
Target size (minimum)' @@ -87,7 +87,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Error message' + html: 'Error message component' }, { html: 'Redundant entry' @@ -95,7 +95,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'File upload' + html: 'File upload component' }, { html: 'Dragging movements
Redundant entry' @@ -103,7 +103,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'GOV.UK footer' + html: 'GOV.UK footer component' }, { html: 'Consistent help' @@ -111,7 +111,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'GOV.UK header' + html: 'GOV.UK header component' }, { html: 'Focus not obscured (Minimum)
Consistent help' @@ -119,7 +119,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Phase banner' + html: 'Phase banner component' }, { html: 'Focus not obscured (minimum)' @@ -127,7 +127,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Select' + html: 'Select component' }, { html: 'Dragging movements' @@ -135,7 +135,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Service navigation' + html: 'Service navigation component' }, { html: 'Focus not obscured (Minimum)
Consistent help' @@ -143,7 +143,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Summary list' + html: 'Summary list component' }, { html: 'Redundant entry
Target size (minimum)' @@ -151,7 +151,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Tag' + html: 'Tag component' }, { html: 'Dragging movements' @@ -176,7 +176,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA rows: [ [ { - html: 'Addresses' + html: 'Addresses pattern' }, { html: 'Redundant entry' @@ -184,7 +184,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Bank details' + html: 'Bank details pattern' }, { html: 'Redundant entry' @@ -192,7 +192,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Email addresses' + html: 'Email addresses pattern' }, { html: 'Redundant entry' @@ -200,7 +200,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Equality information' + html: 'Equality information pattern' }, { html: 'Redundant entry' @@ -208,7 +208,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Names' + html: 'Names pattern' }, { html: 'Redundant entry' @@ -216,7 +216,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'National Insurance Numbers' + html: 'National Insurance Numbers pattern' }, { html: 'Redundant entry' @@ -224,7 +224,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Passwords' + html: 'Passwords pattern' }, { html: 'Accessible authentication
Consistent help
Target size (minimum)' @@ -232,7 +232,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Payment card details' + html: 'Payment card details pattern' }, { html: 'Target size (minimum)' @@ -257,7 +257,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA rows: [ [ { - html: 'Check a service is suitable' + html: 'Check a service is suitable pattern' }, { html: 'Redundant entry' @@ -265,7 +265,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Check answers' + html: 'Check answers pattern' }, { html: 'Redundant entry' @@ -273,7 +273,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Complete multiple tasks' + html: 'Complete multiple tasks pattern' }, { html: 'Dragging movements
Redundant entry' @@ -281,7 +281,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Confirm a phone number' + html: 'Confirm a phone number pattern' }, { html: 'Consistent help' @@ -289,7 +289,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Confirm an email address' + html: 'Confirm an email address pattern' }, { html: 'Accessible authentication' @@ -297,7 +297,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Contact a department or service team' + html: 'Contact a department or service team pattern' }, { html: 'Consistent help' @@ -305,7 +305,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Create accounts' + html: 'Create accounts pattern' }, { html: 'Accessible authentication
Redundant entry' @@ -313,7 +313,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Navigate a service' + html: 'Navigate a service pattern' }, { html: 'Focus not obscured (Minimum)
Consistent help' @@ -321,7 +321,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Recover from validation errors' + html: 'Recover from validation errors pattern' }, { html: 'Redundant entry' @@ -346,7 +346,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA rows: [ [ { - html: 'Page not found pages' + html: 'Page not found pages pattern' }, { html: 'Consistent help' @@ -354,7 +354,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Question pages' + html: 'Question pages pattern' }, { html: 'Dragging movements
Redundant entry' @@ -362,7 +362,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'Service unavailable pages' + html: 'Service unavailable pages pattern' }, { html: 'Consistent help' @@ -370,7 +370,7 @@ See an [explanation of every success criteria in WCAG 2.2](https://www.w3.org/WA ], [ { - html: 'There is a problem with the service pages' + html: 'There is a problem with the service pages pattern' }, { html: 'Consistent help
Redundant entry' diff --git a/src/community/roadmap/index.md b/src/community/roadmap/index.md index b3a9b96ae6..8c5a82c6dd 100644 --- a/src/community/roadmap/index.md +++ b/src/community/roadmap/index.md @@ -19,17 +19,17 @@ Last updated 10 October 2024. We’ve released [GOV.UK Frontend v5.7.1](https://github.com/alphagov/govuk-frontend/releases/tag/v5.7.1) with updated department colours. -Previously, we’ve released [GOV.UK Frontend v5.7.0](https://github.com/alphagov/govuk-frontend/releases/tag/v5.7.0), which includes an update to the Royal Arms in the [GOV.UK footer](/components/footer/). We’ve also added new features to help services [create their own JavaScript components using GOV.UK Frontend](https://frontend.design-system.service.gov.uk/building-your-own-javascript-components/). +Previously, we’ve released [GOV.UK Frontend v5.7.0](https://github.com/alphagov/govuk-frontend/releases/tag/v5.7.0), which includes an update to the Royal Arms in the [GOV.UK footer component](/components/footer/). We’ve also added new features to help services [create their own JavaScript components using GOV.UK Frontend](https://frontend.design-system.service.gov.uk/building-your-own-javascript-components/). We’ve also recently: -- introduced a new [Service navigation component](/components/service-navigation/) and published a new pattern to [Help users to navigate a service](/patterns/navigate-a-service) +- introduced a new [Service navigation component](/components/service-navigation/) and published a new [pattern to Help users to navigate a service](/patterns/navigate-a-service) - updated the list of organisations and brand colours - added a new feature to stop long words from ‘breaking’ out of components - improved how the Breadcrumbs component appears on screen readers - fixed some alignment issues with Radio buttons and Checkboxes - introduced new features to help you include only the components your service uses -- introduced a new [‘Password input’ component](/components/password-input/) +- introduced a new [Password input component](/components/password-input/) - updated the crown in the header, favicon and social share images - updated the components, patterns and styles to be compliant with WCAG 2.2 - made it easier for teams to understand [what's changed in WCAG 2.2 and what they need to do](/accessibility/wcag-2.2) diff --git a/src/components/accordion/index.md b/src/components/accordion/index.md index 9155a10e47..3eaf9fb262 100644 --- a/src/components/accordion/index.md +++ b/src/components/accordion/index.md @@ -50,7 +50,7 @@ Do not use the accordion component if the amount of content inside will make the ## Decide between using accordions, tabs and details -Accordions, [tabs](/components/tabs/) and [details](/components/details/) all work by hiding sections of content which a user can choose to reveal. Avoid using any of these components within one another. +The Accordion component, [Tabs component](/components/tabs/) and [Details component](/components/details/) all work by hiding sections of content which a user can choose to reveal. Avoid using any of these components within one another. If you decide to use one of these components, consider if: diff --git a/src/components/back-link/index.md b/src/components/back-link/index.md index c48c9aebb6..823f80bbbc 100644 --- a/src/components/back-link/index.md +++ b/src/components/back-link/index.md @@ -35,13 +35,13 @@ Although browsers have a back button, some sites break when you use it - so many ## When to use this component -Always include the back link component on GOV.UK [question pages](/patterns/question-pages/). +Always include the Back link component on GOV.UK [Question pages in your service](/patterns/question-pages/). You can include a back link on other pages within a multi-page transaction, if it makes sense to do so. ## When not to use this component -Never use the back link component together with [breadcrumbs](/components/breadcrumbs/). If necessary, you should do research with your users to learn which they find more helpful in your service. +Never use the back link component together with the [Breadcrumbs component](/components/breadcrumbs/). If necessary, you should do research with your users to learn which they find more helpful in your service. ## How it works diff --git a/src/components/button/index.md b/src/components/button/index.md index a4b69601fa..ca1c5a9624 100644 --- a/src/components/button/index.md +++ b/src/components/button/index.md @@ -33,15 +33,15 @@ Use the button component to help users carry out an action like starting an appl Write button text in sentence case, describing the action it performs. For example: -- ‘Start now’ at the [start of the service](/patterns/start-using-a-service/) +- ‘Start now’ at the [start of your service](/patterns/start-using-a-service/) - ‘Sign in’ to an account a user has already created - ‘Continue’ when the service does not save a user’s information - ‘Save and continue’ when the service does save a user’s information - ‘Save and come back later’ when a user can save their information and come back later - ‘Add another’ to add another item to a list or group - ‘Pay’ to make a payment -- ‘Confirm and send’ on a [check answers](/patterns/check-answers/) page that does not have any legal content a user must agree to -- ‘Accept and send’ on a [check answers](/patterns/check-answers/) page that has legal content a user must agree to +- ‘Confirm and send’ on a [Check answers page](/patterns/check-answers/) that does not have any legal content a user must agree to +- ‘Accept and send’ on a [Check answers page](/patterns/check-answers/) that has legal content a user must agree to - ‘Sign out’ when a user is signed in to an account You may need to include more or different words to better describe the action. For example, ‘Add another address’ and ‘Accept and claim a tax refund’. @@ -65,7 +65,7 @@ Avoid using multiple default buttons on a single page. Having more than one main ### Start buttons -Use a start button for the main call to action on your service’s [start page](/patterns/start-using-a-service/). +Use a start button for the main call to action on [your service’s Start page](/patterns/start-using-a-service/). Start buttons do not usually submit form data, so use a link tag instead of a button tag. {{ example({ group: "components", item: "button", example: "start", html: true, nunjucks: true, open: false }) }} diff --git a/src/components/character-count/index.md b/src/components/character-count/index.md index 917e0d5119..d33f34cd66 100644 --- a/src/components/character-count/index.md +++ b/src/components/character-count/index.md @@ -28,7 +28,7 @@ If your users keep hitting the character limit imposed by the backend of your se ## How it works -It tells users how many characters they have remaining as they type into a [textarea](/components/textarea/) with a character limit. +It tells users how many characters they have remaining as they type into a [Textarea component](/components/textarea/) with a character limit. Users will get updates at a pace that works best for the way they interact with the textarea. This means: @@ -50,7 +50,7 @@ There are 2 ways to use the character count component. You can use HTML or, if y ### If you’re asking more than one question on the page -If you're asking more than one question on the page, do not set the contents of the `