Frontend templates

Guide

Guides are designed to present complicated and long subjects by breaking them up into separate pages.

How it works

Guides have multiple parts (or chapters). Each part has a title, a body and a slug.

Live examples

• HMRC online services: sign in or set up an account
• Tax overpayments and underpayments
• Universal Credit

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

How it’s built

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

Content schema

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

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

mainstream-publisher

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 guide frontend template

Component	Source	Publishing app input field(s)
Layout super navigation header	Autogenerated in frontend template
Breadcrumbs	Autogenerated in frontend template	Tagging > Breadcrumbs
Page title	Customized by publisher	Title (required)
Contents list	Customized by publisher	Parts
Heading	Customized by publisher	Parts > Part[i] > Title
Govspeak content	Customized by publisher	Parts > Part[i] > Body
Previous and next navigation	Autogenerated in frontend template
Related navigation when displayed within contextual footer	Customized by publisher	Mainstream browse
Related navigation when displayed within contextual sidebar	Customized by publisher	Related content items
Feedback	Autogenerated in frontend template
Layout footer	Autogenerated in frontend template

History and insights

Date	Description	Document	Format
May 28, 2024	A spreadsheet outlining the total number of sessions in which any page from a guide was viewed.	Guides: Click-thru (any page in guide) (opens in a new tab)	Google Sheets
May 28, 2024	Data shows how many sessions included any page from each chapter and then breaks down that figure by the number of sessions for each chapter within the guide.	Guides: usage across chapters (opens in a new tab)	Google Sheets

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.