Frontend templates

Detailed guide

Detailed guides tell users the steps they need to take to complete a clearly defined task. They are usually aimed at specialist or professional audiences.

How it works

Use this format for content that is regularly updated, for example if the process to complete a task changes.

A detailed guide should:

• answer a specific, task-oriented user need
• be factual guidance the government has a duty to provide, not advice

Audience

This content is aimed at practitioners, for example teachers or accountants.

Content containing background information about why a user needs to complete a task or the history behind it should be in a policy paper.

Consider if the content should be in mainstream guidance instead.

Live examples

• Online immigration status (eVisa)
• Cost of Living Payments 2023 to 2024
• Using your UK Visas and Immigration account

Complete list of examples available and page data on Content Data.

How it’s built

These are the underlying technologies that make-up the detailed guide front template.

Content schema

detailed_guide

What is a content schema?

A GOV.UK content schema is a JSON schema that defines the data structure of a piece of content. It determines what content and metadata attributes the page has.

Content type

detailed_guide

What is a content type?

Content type describes the types of pages that exist on GOV.UK. It’s stored in the content item (JSON) as document_type. It powers search filters in all finders and changes the content type label users see on GOV.UK pages.

Publishing app

whitehall

What is a publishing app?

Publishing apps are used by publishers across government departments to publish content to GOV.UK.

Rendering app

government-frontend

What is a rendering app?

Rendering apps render content to GOV.UK end-users.

Components

The components used within the detailed guide frontend template

Component	Source	Publishing app input field(s)
Layout super navigation header	Autogenerated in frontend template
Contextual breadcrumbs	Autogenerated in frontend template	Topics taxonomy tags > Change tags
Page title	Customized by publisher	Title (required)
Lead paragraph	Customized by publisher	Summary (required)
Translation navigation	Customized by publisher	Translations > Add translation
Metadata block is based on the organisation the publisher has set within Whitehall publisher	Customized by publisher	Lead organisations > Lead organisation [i] and Supporting organisations
Single page notification button	Autogenerated in frontend template
Devolved Nations component appears if the option Applies to all UK nations is not selected	Customized by publisher	Excluded nations (required)
Contents list with body	Customized by publisher	Body (required)
Print link	Autogenerated in frontend template
Back to top - only appears if the page is extremely long	Autogenerated in frontend template
Published dates is generated if content has been published elsewhere	Customized by publisher	First published date (required)
Related navigation when displayed within contextual footer	Customized by publisher	Topical events
Related navigation when displayed within contextual sidebar
Feedback	Autogenerated in frontend template
Layout footer	Autogenerated in frontend template

How to report an issue

If you happen to come across an issue:

1. Report it on Github (opens in a new tab).
2. Once the issue has been added, update this document by adding the title and Github Issue's link.
3. Give yourself a high-five.

Help improve this frontend template

To help make sure that this page is useful, relevant and up to date, submit a GitHub issue (opens in a new tab) with your proposed updates.