Skip to content

Content edits #958

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
JackHMRC wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Content edits #958

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7bfa20f
Content edits
JackHMRC Mar 18, 2025
8a57fc2
Update src/patterns-hmrc-govuk-team/forms-detailed-guide/index.njk
JackHMRC Mar 20, 2025
b5a3835
Update src/patterns-hmrc-govuk-team/forms-detailed-guide/index.njk
JackHMRC Mar 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 33 additions & 36 deletions src/patterns-hmrc-govuk-team/forms-detailed-guide/index.njk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ Use this pattern if users need to read detailed guidance before they complete a
<li>eligibility criteria</li>
</ul>

<h3 class="govuk-heading-m" id="Detailed examples">Check for duplicate guidance first</h3>

@timsb timsb Mar 19, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this the wrong ID?


<p class="govuk-body">
Before you create the new detailed guide or add the form pattern to an existing guide, check if any of the information is already somewhere else, for example in mainstream content or a specialist guide. If it is, do not repeat it, insert a link instead.
</p>
Expand All @@ -26,30 +28,48 @@ Before you create the new detailed guide or add the form pattern to an existing
If it is, do not repeat it. Add a link and journey to that content instead.
</p>

<h3 class="govuk-heading-m" id="Detailed examples">Types of forms</h3>

@Jon-Rowe-HMRC Jon-Rowe-HMRC Mar 18, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't the right ID


<p class="govuk-body">
Types of form that you can use in a detailed guide include the following:
</p>

<ul class="govuk-list govuk-list--bullet">
<li>Online services — These are built by service teams on the tax platform behind the Government Gateway, accessed with a green button with a URL, starting with https://www.tax.service.gov.uk</li>
<li>Interactive guidance (IG) forms — these are added as external links. The URL will begin with https://www.tax.service.gov.uk/guidance</li>
<li>Interactive PDFs that can be completed on-screen — these are added as file attachments and require Adobe to open and complete</li>
<li>PDFs that cannot be completed on screen — these are added as file attachments and do not require Adobe to open</li>
<li>LC forms — these are added as external links. The URL will begin with https://public-online.hmrc.gov.uk/lc/content</li>
<li>G-forms — these are added as external links. The URL will begin with https://tax.service.gov.uk</li>
<li>forms in open document formats — forms in .ods or odt. format are added as file attachments</li>
<li>KANA forms — these are added as external links. The URL will begin with https://online.hmrc.gov.uk/shortforms</li>
<li><span class="govuk-!-font-weight-bold">Online services</span> — these are built by service teams on the tax platform behind the Government Gateway, accessed with a green button. The URL, starts with ‘https://www.taxservices.gov.uk/’ often followed by ‘/digital-forms/form/form-name’.</li>

@timsb timsb Mar 21, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The <span class="govuk-!-font-weight-bold"> needs to be done for all the <strong> tags

<li><strong>Interactive guidance (IG) forms</strong> — these are built by the interactive guidance team. You can use a green button unless an online service is already on the page. The URL usually starts with https://www.tax.service.gov.uk/guidance. </li>
<li><strong>Interactive PDFs that can be completed on-screen</strong> — these are added as file attachments and need Adobe to open and complete. The URL usually starts with https://assets.publishing.service.gov.uk/media/.</li>
<li><strong>PDFs that cannot be completed on screen</strong> — these are added as file attachments and do not require Adobe to open</li>
<li><strong>LC forms</strong> — these are added as external links. The URL will begin with https://public-online.hmrc.gov.uk/lc/content</li>
<li><strong>G-forms</strong> — a common alternative to an online service usually accessed with a green button. The URL will begin with https://tax.service.gov.uk/submissions.</li>
<li><strong>Open document forms</strong> — these are forms in .ods or odt. Format that are added as file attachments.</li>

@Jon-Rowe-HMRC Jon-Rowe-HMRC Mar 18, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'odt. F' > '.odt f'

<li><strong>KANA forms</strong> — these are added as external links. The URL will begin with https://online.hmrc.gov.uk/shortforms</li>
</ul>

<p class="govuk-body">
More than one type of form can be hosted on the same page. You can still only use the green button once on the page (check the <a href="/patterns-hmrc-govuk-team/green-button/" class="govuk-link">green button pattern</a> for more information). For example: <a href="https://www.gov.uk/guidance/register-as-a-bingo-promoter" class="govuk-link">Register as a bingo promoter</a>.
More than one type of form can be hosted on the same page. You can still only use the green button once on the page (check the <a href="/patterns-hmrc-govuk-team/green-button/" class="govuk-link">green button pattern</a> for more information).
</p>

<h3 class="govuk-heading-m" id="Detailed examples">Detailed guidance examples</h3>
<h3 class="govuk-heading-m" id="Detailed-examples">Forms in a detailed guide examples</h3>
<ul class="govuk-list govuk-list--bullet">

<li><a href="https://www.gov.uk/guidance/claim-a-tax-refund-if-youve-stopped-work-and-flexibly-accessed-all-of-your-pension-p50z" class="govuk-link">Claim a tax refund if you've stopped work and flexibly accessed all of your pension (P50Z)</a> — online service with a green button, an interactive guidance (print and post) form, and a PDF (print and post) form for digitally excluded users</li>

<li><a href="https://www.gov.uk/guidance/register-a-non-resident-company-who-disposed-of-uk-property-or-land-for-corporation-tax" class="govuk-link">Apply as an individual to receive rental income without UK tax deducted</a> — online service and LC print and post form</li>


<li><a href="https://www.gov.uk/guidance/tell-hmrc-about-a-car-provided-to-an-employee-for-private-use" class="govuk-link">Tell HMRC about a car provided to an employee for private use</a> — example of online service and LC print and post form</li>

<li><a href="https://www.gov.uk/guidance/research-and-development-tax-relief-advance-assurance" class="govuk-link">Apply for advance assurance on a Research and Development (R&D) tax relief claim</a> — online service, LC form, Interactive PDF that you complete online</li>
</ul>


<h3 class="govuk-heading-m" id="Examples-of-guides-with-one-form">Examples of guides with one form</h3>
<ul class="govuk-list govuk-list--bullet">
<li><a href="https://www.gov.uk/guidance/register-as-a-bingo-promoter" class="govuk-link">Register as a bingo promoter</a> - an example of an online service with a green button and LC form to register by print and post</li>
<li><a href="https://www.gov.uk/guidance/claim-a-tax-refund-if-youve-stopped-work-and-flexibly-accessed-all-of-your-pension-p50z" class="govuk-link">Claim a tax refund if you've stopped work and flexibly accessed all of your pension (P50Z)</a> — example of a service with a green button and both an interactive guidance (print and post) form and a PDF (print and post) form for digitally excluded users</li>
</ul>
<li><a href="https://www.gov.uk/guidance/register-a-non-resident-company-who-disposed-of-uk-property-or-land-for-corporation-tax" class="govuk-link">
Register a non-resident company who disposed of UK property or land for Corporation Tax</a> — G-form</li>
<li><a href="https://www.gov.uk/guidance/work-out-pay-from-an-umbrella-company" class="govuk-link">

@Jon-Rowe-HMRC Jon-Rowe-HMRC Mar 18, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line returns shouldn't be inside HREFs

@timsb timsb Mar 19, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Jon-Rowe-HMRC Whitespace in HTML is largely ignored so shouldn't be a problem here but it is arguably easier to read the code when on the same line.

https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model/Whitespace

Work out pay from an umbrella company</a> — interactive guidance form</li>
</ul>


<h2 class="govuk-heading-l" id="when-not-to-use">When not to use</h2>
Expand Down Expand Up @@ -178,29 +198,6 @@ s5. Post to HMRC (the address is at the end of the form)',
})
}}

<h3 class="govuk-heading-s" id="formats">Interactive guidance forms that host different ways to submit forms</h3>
<p class="govuk-body">
Some trials are taking place to look at user demand for existing PDFs. To support this a page owner may agree to move the different form choices (an existing PDF and online service) into an interactive guide away from detailed guide.
</p>

<p class="govuk-body">
Read ‘Instructions: forms in a detailed guide’ to find out when you can move form choices into and IG tool and how you must format content.
</p>

<p class="govuk-body">
IG tools with form options must follow this pattern and other GOV.UK patterns for form choices — unless evidence of a strong user need demonstrates a reason not to.
</p>

<p class="govuk-body">
The detailed guide must use a ‘single green button’ to send users into the IG tool. Do not use the Government Gateway user ID pattern.
</p>

<h3 class="govuk-heading-s" id="formats">Example</h3>

<p class="govuk-body">
A detailed guide takes users to an interactive guidance tool that signposts them to two form options. Tell HMRC about any errors in your VAT Return (VAT652) — form choices in this example do not follow GOV.UK patterns yet.
</p>

<h4 class="govuk-heading-s" id="gforms">PDFs that cannot be completed on screen</h4>

<p class="govuk-body">
Expand Down