diff --git a/_includes/layouts/frontend-template-documentation.njk b/_includes/layouts/frontend-template-documentation.njk index 9906cef..051fe3c 100644 --- a/_includes/layouts/frontend-template-documentation.njk +++ b/_includes/layouts/frontend-template-documentation.njk @@ -13,7 +13,7 @@ {% if (contentSchema.link and contentSchema.title) or (contentType.link and contentType.title) or publishingApp or renderingApp %}
-

How it's built

+

How it’s built

These are the underlying technologies that make-up the {{ title | lower }} front template.

{% if contentSchema.link and contentSchema.title %} diff --git a/docs/components/*components-documentation-template.md b/docs/components/*components-documentation-template.md index 1c48462..0d75c51 100644 --- a/docs/components/*components-documentation-template.md +++ b/docs/components/*components-documentation-template.md @@ -61,7 +61,7 @@ insights: #Delete this comment before entering a brief summary about the document being referred. title: #Delete this comment before entering the name of the insight document. link: #Delete this comment before entering the URL of the insight document. - documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Doc, (2) Google Sheets, and (3) Google Slides. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. # Accessibilty criteria for this component # List out the accessibility for this component. diff --git a/docs/components/attachment.md b/docs/components/attachment.md index b123c34..b50e3a6 100644 --- a/docs/components/attachment.md +++ b/docs/components/attachment.md @@ -157,7 +157,7 @@ insights: #Delete this comment before entering a brief summary about the document being referred. title: #Delete this comment before entering the name of the insight document. link: #Delete this comment before entering the URL of the insight document. - documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Doc, (2) Google Sheets, and (3) Google Slides. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. # Accessibilty criteria for this component # List out the accessibility for this component. diff --git a/docs/components/breadcrumbs.md b/docs/components/breadcrumbs.md index b8899a2..6ecbc31 100644 --- a/docs/components/breadcrumbs.md +++ b/docs/components/breadcrumbs.md @@ -105,7 +105,7 @@ insights: 'The Homepage and Navigation Team did a complete audit of the logic and all iterations of this component.' title: Breadcrumbs logic link: https://docs.google.com/document/d/10k_LzO_JGqARIccAkL7aEgS0Ft9PSe7D0UC87akaUNo/edit#heading=h.yb5qbwi6tisj - documentFormat: Google Doc + documentFormat: Google Docs # Accessibilty criteria for this component # List out the accessibility for this component. diff --git a/docs/components/content-list.md b/docs/components/content-list.md index 4686f9c..7cabb0d 100644 --- a/docs/components/content-list.md +++ b/docs/components/content-list.md @@ -148,7 +148,7 @@ insights: 'The content audit discovery summarised a list of inconsistencies and issues with this component and offers proposed solutions to achieve more consistency across GOV.UK.' title: Content Audit Discovery – Component recommendations link: https://docs.google.com/document/d/1Gb3P2lQVGjdfhBnz19FDX4coWTpbKGIpZABNnQ7iLl0/edit#heading=h.llzp42bd0b76 - documentFormat: Google Doc + documentFormat: Google Docs # Accessibilty criteria for this component # List out the accessibility for this component. diff --git a/docs/components/feedback.md b/docs/components/feedback.md index 4de8a0f..fb90ff8 100644 --- a/docs/components/feedback.md +++ b/docs/components/feedback.md @@ -76,7 +76,7 @@ insights: #Delete this comment before entering a brief summary about the document being referred. title: #Delete this comment before entering the name of the insight document. link: #Delete this comment before entering the URL of the insight document. - documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Doc, (2) Google Sheets, and (3) Google Slides. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. # Accessibilty criteria for this component # List out the accessibility for this component. diff --git a/docs/components/global-banner.md b/docs/components/global-banner.md index 84f7135..3e06907 100644 --- a/docs/components/global-banner.md +++ b/docs/components/global-banner.md @@ -68,7 +68,7 @@ insights: 'Information regarding the site-wide banner during the 2024 General Election' title: Site-wide banner and featured homepage promo for the 2024 General Election link: https://docs.google.com/document/d/16B-lygYgDHT-gwbjTHQaNsdx9_y2Ikdg2wiU5ekio4w/edit?usp=sharing - documentFormat: Google Doc + documentFormat: Google Docs 1: # Both title and link are REQUIRED in order for this information to render on the page. date: May 1, 2020 @@ -77,7 +77,7 @@ insights: 'Performance of the global banner during COVID and Brexit' title: Global banner performance link: https://docs.google.com/document/d/1ltH8ydXj_W_clYimAtf1MGwQksITxz-q5Yk9E9H5yBY/edit?usp=sharing - documentFormat: Google Doc + documentFormat: Google Docs # Accessibilty criteria for this component # List out the accessibility for this component. diff --git a/docs/components/print-link.md b/docs/components/print-link.md index 5f5ed56..cc90968 100644 --- a/docs/components/print-link.md +++ b/docs/components/print-link.md @@ -79,7 +79,7 @@ insights: #Delete this comment before entering a brief summary about the document being referred. title: #Delete this comment before entering the name of the insight document. link: #Delete this comment before entering the URL of the insight document. - documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Doc, (2) Google Sheets, and (3) Google Slides. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. # Accessibilty criteria for this component # List out the accessibility for this component. diff --git a/docs/frontend-templates/*frontend-template-documentation-template.md b/docs/frontend-templates/*frontend-template-documentation-template.md index dc707af..91f624e 100644 --- a/docs/frontend-templates/*frontend-template-documentation-template.md +++ b/docs/frontend-templates/*frontend-template-documentation-template.md @@ -130,7 +130,7 @@ insights: #Delete this comment before entering a brief summary about the document being referred. title: #Delete this comment before entering the name of the insight document. link: #Delete this comment before entering the URL of the insight document. - documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Doc, (2) Google Sheets, and (3) Google Slides. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. # How to report an issue with this frontend template # This will display instrucions on how to report an issue via GitHub. diff --git a/docs/frontend-templates/answer.md b/docs/frontend-templates/answer.md index 0f10987..254619e 100644 --- a/docs/frontend-templates/answer.md +++ b/docs/frontend-templates/answer.md @@ -1,96 +1,298 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Frontend templates + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Answer + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. description: Answers are designed to provide all the information the user needs to answer a simple and specific question. -figmaLink: -howItWorks: There is only 1 body field for a quick answer. This contains all the content for a page. + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). +howItWorks: + There is only 1 body field for a quick answer. This contains all the content for a page. + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: "Personal tax account: sign in or set up" + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Personal tax account: sign in or set up' link: https://www.gov.uk/personal-tax-account + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 1: - title: Benefits calculators + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Benefits calculators' link: https://www.gov.uk/benefits-calculators + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 2: - title: File your Self Assessment tax return online - link: https://www.gov.uk/log-in-file-self-assessment-tax-return + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'File your Self Assessment tax return online' + link: https://www.gov.uk/log-in-file-self-assessment-tax-return + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. contentDataLink: https://content-data.publishing.service.gov.uk/content?submitted=true&date_range=past-30-days&search_term=&document_type=answer&organisation_id=all + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: answer link: https://docs.publishing.service.gov.uk/content-schemas/answer.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: answer link: https://docs.publishing.service.gov.uk/document-types/answer.html -publishingApp: mainstream publisher -renderingApp: government frontend + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + mainstream publisher + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + government frontend + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Breadcrumbs' componentURL: https://components.publishing.service.gov.uk/component-guide/breadcrumbs - generated: auto - input: Tagging > Breadcrumbs + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Tagging > Breadcrumbs' 2: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: publisher - input: Title (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Title (required)' 3: - componentName: Govspeak content + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Govspeak content' componentURL: https://components.publishing.service.gov.uk/component-guide/govspeak - generated: publisher - input: Body + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Body' 4: - componentName: "[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual footer](https://components.publishing.service.gov.uk/component-guide/contextual_footer)" - componentURL: - generated: publisher - input: Mainstream browse + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual footer](https://components.publishing.service.gov.uk/component-guide/contextual_footer)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Mainstream browse' 5: - componentName: "[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)" - componentURL: - generated: publisher - input: Related content items + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Related content items' 6: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 7: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Answer page: categorising data' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: "Answer page: categorising data" - link: https://docs.google.com/spreadsheets/d/18osY2da0SKhSTdY9FAIhKBwCd3HMKw_jqpZS-1mu8gA/edit?usp=sharing - description: List of all the answer pages and its associated data - date: + # Both title and link are REQUIRED in order for this information to render on the page. + date: September 17, 2024 + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + 'List of all the answer pages and its associated data' + title: 'Answer page: categorising data' + link: https://docs.google.com/spreadsheets/d/18osY2da0SKhSTdY9FAIhKBwCd3HMKw_jqpZS-1mu8gA/edit?usp=sharing + documentFormat: Google Sheets 1: - title: "Answer pages: exits" - link: https://docs.google.com/spreadsheets/d/1f4fSsIxkCfWiKNV9qgE_sep61f5EbKxU58wTWCsGw60/edit?gid=2140166644#gid=2140166644 - description: Data on exiting from DWP answer pages - date: + # Both title and link are REQUIRED in order for this information to render on the page. + date: August 28, 2024 + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + 'Pages visited after an Answer page - figures are no. of sessions' + title: 'Answer pages: pages visited after' + link: https://docs.google.com/spreadsheets/d/1bxdQQvSUIfNdmuyF1Ws7RwZARIdgU9eQTN5jYrJeXkU/edit?gid=1433864911#gid=1433864911 + documentFormat: Google Sheets 2: - title: "Answer pages: average engagement time/word count" - link: https://docs.google.com/spreadsheets/d/1rJTOD69386X1lnpUpih3eXZoeX54kNB4u7dqIQA2oBg/edit?gid=132520947#gid=132520947 - description: Time on page against word count for DWP answer pages - date: + # Both title and link are REQUIRED in order for this information to render on the page. + date: June 10, 2024 + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + 'Time on page against word count for DWP answer pages' + title: 'Answer pages: average engagement time/word count' + link: https://docs.google.com/spreadsheets/d/1rJTOD69386X1lnpUpih3eXZoeX54kNB4u7dqIQA2oBg/edit?gid=132520947#gid=132520947 + documentFormat: Google Sheets 3: - title: "Answer pages: pages visited after" - link: https://docs.google.com/spreadsheets/d/1bxdQQvSUIfNdmuyF1Ws7RwZARIdgU9eQTN5jYrJeXkU/edit?gid=1433864911#gid=1433864911 - description: Pages visited after an Answer page - figures are no. of sessions - date: + # Both title and link are REQUIRED in order for this information to render on the page. + date: June 6, 2024 + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + 'Data on exiting from DWP answer pages' + title: 'Answer pages: exits' + link: https://docs.google.com/spreadsheets/d/1f4fSsIxkCfWiKNV9qgE_sep61f5EbKxU58wTWCsGw60/edit?gid=2140166644#gid=2140166644 + documentFormat: Google Sheets + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: -githubIssueLink: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/calendar.md b/docs/frontend-templates/calendar.md index ceb7540..761017d 100644 --- a/docs/frontend-templates/calendar.md +++ b/docs/frontend-templates/calendar.md @@ -1,13 +1,40 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Frontend templates + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Calendar + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. description: The calendar is designed to inform GOV.UK end-users important dates in the United Kingdom. For instance, upcoming bank holidays and when the clocks change. -figmaLink: + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - "According to the [wiki post](https://gov-uk.atlassian.net/wiki/spaces/CC/pages/2293202956/Updating+the+GOV.UK+bank+holidays+page), Blue team are responsible for working with developers in the homepage and navigation team to add bank holiday information on /bank-holidays. They should arrange for `/when-do-the-clocks-change` to be updated at the same time, including its meta description. + 'According to the [wiki post](https://gov-uk.atlassian.net/wiki/spaces/CC/pages/2293202956/Updating+the+GOV.UK+bank+holidays+page), Blue team are responsible for working with developers in the homepage and navigation team to add bank holiday information on /bank-holidays. They should arrange for `/when-do-the-clocks-change` to be updated at the same time, including its meta description. Blue team adds new dates to the page the October or November 2 years in advance. For example, we added all the 2020 bank holiday dates in November 2018. We should also remove the oldest year of past bank holidays from the page. @@ -16,91 +43,283 @@ howItWorks: Blue team will raise a Content Storytime ticket. - The developers will then draft the changes and blue team fact check them using legislation and this guidance." + The developers will then draft the changes and blue team fact check them using legislation and this guidance.' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: UK bank holidays - link: https://www.gov.uk/bank-holidays + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'UK bank holidays' + link: https://www.gov.uk/bank-holidays + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 1: - title: When do the clocks change? + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'When do the clocks change?' link: https://www.gov.uk/when-do-the-clocks-change + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 2: - title: Gwyliau banc y DU + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Gwyliau banc y DU' link: https://www.gov.uk/gwyliau-banc + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + true + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. contentDataLink: https://content-data.publishing.service.gov.uk/content?submitted=true&date_range=past-30-days&search_term=&document_type=calendar&organisation_id=all + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: calendar link: https://docs.publishing.service.gov.uk/content-schemas/calendar.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: calendar link: https://docs.publishing.service.gov.uk/document-types/calendar.html -publishingApp: -renderingApp: frontend + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + #Delete this comment before entering the name of the publishing app. + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + frontend + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Contextual breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Contextual breadcrumbs' componentURL: https://components.publishing.service.gov.uk/component-guide/contextual_breadcrumbs - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 2: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 3: - componentName: Tabs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Tabs' componentURL: https://components.publishing.service.gov.uk/component-guide/tabs - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 4: - componentName: Panel + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Panel' componentURL: https://components.publishing.service.gov.uk/component-guide/panel - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 5: - componentName: Calendar + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Calendar' componentURL: https://govuk-frontend.herokuapp.com/component-guide/calendar - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 6: - componentName: Subscribe + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Subscribe' componentURL: https://govuk-frontend.herokuapp.com/component-guide/subscribe - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 7: - componentName: Metadata block + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Metadata block' componentURL: https://components.publishing.service.gov.uk/component-guide/metadata - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 8: - componentName: "[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)" - componentURL: - generated: hardcode + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 9: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 10: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. description: - date: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: -githubIssueLink: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/completed-transaction.md b/docs/frontend-templates/completed-transaction.md index e4a4a79..e19d51b 100644 --- a/docs/frontend-templates/completed-transaction.md +++ b/docs/frontend-templates/completed-transaction.md @@ -1,13 +1,40 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Frontend templates + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Completed transaction -description: The completed transaction frontend template is what an end-user interacts with once they have completed all the necessary tasks/actions within an individual government service -figmaLink: + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. +description: The completed transaction frontend template is what an end-user interacts with once they have completed all the necessary tasks/actions within an individual government service. + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - "Any service starting on GOV.UK should have a feedback page, it doesn’t need to have a start page. + 'Any service starting on GOV.UK should have a feedback page, it doesn’t need to have a start page. After an end-user completes a transaction on an online service they are directed to the completed transaction frontend template where they relay their experience using a service. The results are in Feedex. Satisfaction scores used to be on the performance platform, where you could compare scores across different services. @@ -24,96 +51,283 @@ howItWorks: - Electric vehicles - The domain for every completed transaction must have a `/done` prefix." + The domain for every completed transaction must have a `/done` prefix.' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: Give feedback on Tax your vehicle + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Give feedback on Tax your vehicle' link: https://www.gov.uk/done/vehicle-tax + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 1: - title: You've completed your transaction + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'You’ve completed your transaction' link: https://www.gov.uk/done/transaction-finished + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 2: - title: Give feedback on Check if a vehicle is taxed + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Give feedback on Check if a vehicle is taxed' link: https://www.gov.uk/done/check-vehicle-tax + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. contentDataLink: https://content-data.publishing.service.gov.uk/content?submitted=true&date_range=past-30-days&search_term=&document_type=completed_transaction&organisation_id=all + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: completed_transaction link: https://docs.publishing.service.gov.uk/content-schemas/completed_transaction.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: completed_transaction link: https://docs.publishing.service.gov.uk/document-types/completed_transaction.html -publishingApp: mainstream publisher -renderingApp: feedback + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + mainstream publisher + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + feedback + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Breadcrumbs' componentURL: https://components.publishing.service.gov.uk/component-guide/breadcrumbs - generated: auto - input: Tagging > Breadcrumbs + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Tagging > Breadcrumbs' 2: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: publisher - input: Title (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Title (required)' 3: - componentName: Generated on page via custom styling, without using any pre-existing components - componentURL: - generated: publisher - input: Promotions - 4: - componentName: Heading + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Heading' componentURL: https://components.publishing.service.gov.uk/component-guide/heading - generated: publisher - input: Parts > Part[i] > Title - 5: - componentName: Form radio button + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Parts > Part[i] > Title' + 4: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Form radio button' componentURL: https://components.publishing.service.gov.uk/component-guide/radio - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: - 6: - componentName: Form character count + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 5: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Form character count' componentURL: https://components.publishing.service.gov.uk/component-guide/character_count - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: - 7: - componentName: Button + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 6: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Button' componentURL: https://components.publishing.service.gov.uk/component-guide/button - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 7: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual footer](https://components.publishing.service.gov.uk/component-guide/contextual_footer)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Mainstream browse' 8: - componentName: "[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual footer](https://components.publishing.service.gov.uk/component-guide/contextual_footer)" - componentURL: - generated: publisher - input: Mainstream browse + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Related content items' 9: - componentName: "[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)" - componentURL: - generated: publisher - input: Related content items - 10: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: - 11: - componentName: Layout footer + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 10: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: - description: - date: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: Why is it that a component is not being used to show a promotional feature? - link: -githubIssueLink: + # Both title and link are REQUIRED in order to display this information on the page. + title: Why are promotional content encapsulated within a component + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/detailed-guide.md b/docs/frontend-templates/detailed-guide.md index 7c9a03a..2e636c8 100644 --- a/docs/frontend-templates/detailed-guide.md +++ b/docs/frontend-templates/detailed-guide.md @@ -1,13 +1,41 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Frontend templates + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Detailed guide -description: 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. -figmaLink: + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. +description: '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.' + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - "Use this format for content that is regularly updated, for example if the process to complete a task changes. + 'Use this format for content that is regularly updated, for example if the process to complete a task changes. + A detailed guide should: @@ -25,116 +53,358 @@ howItWorks: 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." + Consider if the content should be in mainstream guidance instead.' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: Online immigration status (eVisa) + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Online immigration status (eVisa)' link: https://www.gov.uk/guidance/online-immigration-status-evisa + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 1: - title: Cost of Living Payments 2023 to 2024 + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Cost of Living Payments 2023 to 2024' link: https://www.gov.uk/guidance/cost-of-living-payment + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 2: - title: Using your UK Visas and Immigration account + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Using your UK Visas and Immigration account' link: https://www.gov.uk/guidance/using-your-uk-visas-and-immigration-account + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. contentDataLink: https://content-data.publishing.service.gov.uk/content?submitted=true&date_range=past-30-days&search_term=&document_type=detailed_guide&organisation_id=all + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: detailed_guide link: https://docs.publishing.service.gov.uk/content-schemas/detailed_guide.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: detailed_guide link: https://docs.publishing.service.gov.uk/document-types/detailed_guide.html -publishingApp: whitehall -renderingApp: government frontend + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + whitehall + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + government frontend + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Contextual breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Contextual breadcrumbs' componentURL: https://components.publishing.service.gov.uk/component-guide/contextual_breadcrumbs - generated: auto - input: Topics taxonomy tags > Change tags + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Topics taxonomy tags > Change tags' 2: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: publisher - input: Title (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Title (required)' 3: - componentName: Lead paragraph + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Lead paragraph' componentURL: https://components.publishing.service.gov.uk/component-guide/lead_paragraph - generated: publisher - input: Summary (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + Summary (required) 4: - componentName: Translation navigation + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Translation navigation' componentURL: https://components.publishing.service.gov.uk/component-guide/translation_nav - generated: publisher - input: Translations > Add translation + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Translations > Add translation' 5: - componentName: "[Metadata block](https://components.publishing.service.gov.uk/component-guide/metadata) is based on the organisation the publisher has set within Whitehall publisher" - componentURL: - generated: publisher - input: Lead organisations > Lead organisation [i] and Supporting organisations + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Metadata block](https://components.publishing.service.gov.uk/component-guide/metadata) is based on the organisation the publisher has set within Whitehall publisher' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Lead organisations > Lead organisation [i] and Supporting organisations' 6: - componentName: Single page notification button + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Single page notification button' componentURL: https://components.publishing.service.gov.uk/component-guide/single_page_notification_button - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 7: - componentName: "[Devolved Nations](https://components.publishing.service.gov.uk/component-guide/devolved_nations) component appears if the option `Applies to all UK nations` is not selected" - componentURL: - generated: publisher - input: Excluded nations (required) + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Devolved Nations](https://components.publishing.service.gov.uk/component-guide/devolved_nations) component appears if the option `Applies to all UK nations` is not selected' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Excluded nations (required)' 8: - componentName: Contents list with body + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Contents list with body' componentURL: https://govuk-government-frontend.herokuapp.com/component-guide/contents_list_with_body - generated: publisher - input: Body (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Body (required)' 9: - componentName: Print link + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Print link' componentURL: https://components.publishing.service.gov.uk/component-guide/print_link - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 10: - componentName: "[Back to top](https://govuk-government-frontend.herokuapp.com/component-guide/back_to_top) - only appears if the page is extremely long" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Back to top](https://govuk-government-frontend.herokuapp.com/component-guide/back_to_top) - only appears if the page is extremely long' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 11: - componentName: "[Published dates](https://govuk-government-frontend.herokuapp.com/component-guide/published_dates) is generated if content has been published elsewhere" - componentURL: - generated: publisher - input: First published date (required) + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Published dates](https://govuk-government-frontend.herokuapp.com/component-guide/published_dates) is generated if content has been published elsewhere' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'First published date (required)' 12: - componentName: "[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual footer](https://components.publishing.service.gov.uk/component-guide/contextual_footer)" - componentURL: - generated: publisher - input: Topical events + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual footer](https://components.publishing.service.gov.uk/component-guide/contextual_footer)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Topical events' 13: - componentName: "[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)" - componentURL: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + # Delete this comment before enter how this component is generated on the page. input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 14: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 15: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto - input: + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. description: - date: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: -githubIssueLink: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/document-collections.md b/docs/frontend-templates/document-collections.md index c061c94..9572e27 100644 --- a/docs/frontend-templates/document-collections.md +++ b/docs/frontend-templates/document-collections.md @@ -1,12 +1,40 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Frontend templates + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Document collections + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. description: Document collections group related documents on a single page that are aimed for a specific audience or around a specific theme or topic. + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - "A document collection could be used to publish: + 'A document collection could be used to publish: - a set of forms @@ -26,11 +54,11 @@ howItWorks: If more than one collection page is listed, the collections appear in the order of their relative positions within the document collections they belong to. - Example: [National curriculum in England: framework for key stages 1 to 4](https://www.gov.uk/government/publications/national-curriculum-in-england-framework-for-key-stages-1-to-4) - The content item belongs to 3 document collections. It's the first item in ‘National curriculum’, so that document collection appears first in the list. It's the 17th item in the ‘Schools: statutory guidance’ document collection - so is the second link in the sidebar. It is the 54th item in the ‘Local-authority-maintained schools: governance’ collection - so that is the third link. + Example: [National curriculum in England: framework for key stages 1 to 4](https://www.gov.uk/government/publications/national-curriculum-in-england-framework-for-key-stages-1-to-4) - The content item belongs to 3 document collections. It’s the first item in "National curriculum", so that document collection appears first in the list. It’s the 17th item in the "Schools: statutory guidance" document collection - so is the second link in the sidebar. It is the 54th item in the "Local-authority-maintained schools: governance" collection - so that is the third link. ### Email sign up links on document collections - Document collections have a ‘Get emails about this page’ button which allows users to sign up for email updates when: + Document collections have a "Get emails about this page" button which allows users to sign up for email updates when: - there’s a major change to any of the tagged content items listed on the document collection @@ -39,133 +67,406 @@ howItWorks: - the document collection is unpublished and redirected - There’s an exception on some HMRC document collections where users will get emails about the topic instead of the document collection. [Find out why they were set up like this](https://docs.google.com/document/d/1MR5OaFG_DOCmWGL9o9MSGIPLMFe2mmSrV6Va-99cSzw/edit#heading=h.jbja48mpt1t7). - " + There’s an exception on some HMRC document collections where users will get emails about the topic instead of the document collection. [Find out why they were set up like this](https://docs.google.com/document/d/1MR5OaFG_DOCmWGL9o9MSGIPLMFe2mmSrV6Va-99cSzw/edit#heading=h.jbja48mpt1t7).' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: "Self Assessment: detailed information" + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Self Assessment: detailed information' link: https://www.gov.uk/government/collections/self-assessment-detailed-information + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 1: - title: Multiplication tables check + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Multiplication tables check' link: https://www.gov.uk/government/collections/multiplication-tables-check + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 2: - title: "Intellectual property: Trade marks" + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Intellectual property: Trade marks' link: https://www.gov.uk/government/collections/intellectual-property-trade-marks + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. contentDataLink: https://content-data.publishing.service.gov.uk/content?submitted=true&date_range=past-30-days&search_term=&document_type=document_collection&organisation_id=all + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: document_collection - link: https://docs.publishing.service.gov.uk/content-schemas/document_collection.html + link: https://docs.publishing.service.gov.uk/content-schemas/document_collection.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: document_collection link: https://docs.publishing.service.gov.uk/document-types/document_collection.html -publishingApp: whitehall -renderingApp: government frontend + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + whitehall + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + government frontend + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Breadcrumb' componentURL: ../../../components/breadcrumbs - generated: auto - input: Topics taxonomy tags to customise breadcrumbs + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Topics taxonomy tags to customise breadcrumbs' 2: - componentName: Section break + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Section break' componentURL: https://design-system.service.gov.uk/styles/section-break/ - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 3: - componentName: Single page notification button + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Single page notification button' componentURL: https://components.publishing.service.gov.uk/component-guide/single_page_notification_button - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 4: - componentName: Published dates + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Published dates' componentURL: https://govuk-government-frontend.herokuapp.com/component-guide/published_dates - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 5: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 6: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto - input: + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 7: - componentName: "[Contents list](https://components.publishing.service.gov.uk/component-guide/contents_list) - only appears if 3 or more collections" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Contents list](https://components.publishing.service.gov.uk/component-guide/contents_list) - only appears if 3 or more collections' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 8: - componentName: "[Back to top](https://govuk-government-frontend.herokuapp.com/component-guide/back_to_top) - only appears if the page is extremely long" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Back to top](https://govuk-government-frontend.herokuapp.com/component-guide/back_to_top) - only appears if the page is extremely long' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 9: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: publisher - input: Title (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Title (required)' 10: - componentName: Lead paragraph + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Lead paragraph' componentURL: https://components.publishing.service.gov.uk/component-guide/lead_paragraph - generated: publisher - input: Summary (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Summary (required)' 11: - componentName: Metadata block + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Metadata block' componentURL: https://components.publishing.service.gov.uk/component-guide/metadata - generated: publisher - input: "First published date & Associations: Lead organisations" + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'First published date & Associations: Lead organisations' 12: - componentName: Govspeak content + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Govspeak content' componentURL: https://components.publishing.service.gov.uk/component-guide/govspeak - generated: publisher - input: Body + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Body' 13: - componentName: Published dates + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Published dates' componentURL: https://govuk-government-frontend.herokuapp.com/component-guide/published_dates - generated: publisher - input: First published date & Change note (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'First published date & Change note (required)' 14: - componentName: "[Heading](https://components.publishing.service.gov.uk/component-guide/heading) - title for individual collection" - componentURL: - generated: publisher + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Heading](https://components.publishing.service.gov.uk/component-guide/heading) - title for individual collection' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 15: - componentName: "[Govspeak content](https://components.publishing.service.gov.uk/component-guide/govspeak) - description for the individual collection" - componentURL: - generated: publisher + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Govspeak content](https://components.publishing.service.gov.uk/component-guide/govspeak) - description for the individual collection' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 16: - componentName: "[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual footer](https://components.publishing.service.gov.uk/component-guide/contextual_footer)" - componentURL: - generated: publisher - input: Taxonomy + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual footer](https://components.publishing.service.gov.uk/component-guide/contextual_footer)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Taxonomy' 17: - componentName: "[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)" - componentURL: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + # Delete this comment before enter how this component is generated on the page. input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 18: - componentName: Signup link + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Signup link' componentURL: https://components.publishing.service.gov.uk/component-guide/signup_link generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + # Delete this comment before enter how this component is generated on the page. input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: Prototype testing specialist topics - link: https://docs.google.com/presentation/d/1pqbXzYPbVs11fuOpa4P9sRv7TLT8wbRTniuO_ANC7sM/edit#slide=id.g10d42026b8_2_0 + # Both title and link are REQUIRED in order for this information to render on the page. + date: September 2022 description: - " - Collections pages were used as navigation pages for specialist topics (the equivalent of a mainstream browse topic or sub-topic page). We tested with 5 accountants, frequent users of GOV.UK, and using desktop. + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + 'Collections pages were used as navigation pages for specialist topics (the equivalent of a mainstream browse topic or sub-topic page). We tested with 5 accountants, frequent users of GOV.UK, and using desktop. - Users had no difficulties with the page design, and successfully used the page to navigate. Including a short description under each link within the collection helped users to choose between the options and aided navigation. - " - date: September 2022 + Users had no difficulties with the page design, and successfully used the page to navigate. Including a short description under each link within the collection helped users to choose between the options and aided navigation.' + title: 'Prototype testing specialist topics' + link: https://docs.google.com/presentation/d/1pqbXzYPbVs11fuOpa4P9sRv7TLT8wbRTniuO_ANC7sM/edit#slide=id.g10d42026b8_2_0 + documentFormat: Google Slides + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. +issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/finder/case-studies-finder.md b/docs/frontend-templates/finder/case-studies-finder.md index 1d08ac6..9980411 100644 --- a/docs/frontend-templates/finder/case-studies-finder.md +++ b/docs/frontend-templates/finder/case-studies-finder.md @@ -1,72 +1,283 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Finder + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Case studies finder -description: A directory of all the case studies that can be found on GOV.UK + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. +description: A directory of all the case studies that can be found on GOV.UK. + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - Case Studies finder lists all case studies that is published on GOV.UK. End-users can use the search component to filter the returned results on the page. + 'Case Studies finder lists all case studies that is published on GOV.UK. End-users can use the search component to filter the returned results on the page.' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: + # Both title and link are REQUIRED in order for this information to render on the page. title: 'Case studies: Real-life examples of government activity' link: https://www.gov.uk/government/case-studies + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. +contentDataLink: #Delete this comment before entering Content Data URL assocaited with this frontend template. + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/content-schemas/finder.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/document-types/finder.html -renderingApp: finder frontend + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + #Delete this comment before entering the name of the publishing app. + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + finder frontend + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header - componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' + componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Contextual breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Contextual breadcrumbs' componentURL: https://components.publishing.service.gov.uk/component-guide/contextual_breadcrumbs - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 2: - componentName: '[Heading](https://components.publishing.service.gov.uk/component-guide/heading) used to display number of returned search results' - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Heading](https://components.publishing.service.gov.uk/component-guide/heading) used to display number of returned search results' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 3: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 4: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 5: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 6: - componentName: Search + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Search' componentURL: https://components.publishing.service.gov.uk/component-guide/search - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 7: - componentName: '[Subscription links](https://components.publishing.service.gov.uk/component-guide/subscription_links) - rendered top and bottom of the page, but displayed only at the bottom of the page' - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Subscription links](https://components.publishing.service.gov.uk/component-guide/subscription_links) - rendered top and bottom of the page, but displayed only at the bottom of the page' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 8: - componentName: Document list + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Document list' componentURL: https://components.publishing.service.gov.uk/component-guide/document_list - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 9: - componentName: Previous and next navigation + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Previous and next navigation' componentURL: https://components.publishing.service.gov.uk/component-guide/previous_and_next_navigation - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. +insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. +issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/finder/departments-agencies-public-bodies-finder.md b/docs/frontend-templates/finder/departments-agencies-public-bodies-finder.md index 1d79326..5508548 100644 --- a/docs/frontend-templates/finder/departments-agencies-public-bodies-finder.md +++ b/docs/frontend-templates/finder/departments-agencies-public-bodies-finder.md @@ -1,72 +1,283 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Finder + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Departments, agencies and public bodies finder -description: A directory of all the departments, agencies and public bodies within the UK government + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. +description: A directory of all the departments, agencies and public bodies within the UK government. + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - This finder lists all the departments, agencies and public bodies within the UK government. End-users can use the search component to filter the returned results on the page. + 'This finder lists all the departments, agencies and public bodies within the UK government. End-users can use the search component to filter the returned results on the page.' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: + # Both title and link are REQUIRED in order for this information to render on the page. title: Departments, agencies and public bodies link: https://www.gov.uk/government/organisations + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. +contentDataLink: #Delete this comment before entering Content Data URL assocaited with this frontend template. + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: organisations_homepage link: https://docs.publishing.service.gov.uk/content-schemas/organisations_homepage.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/document-types/finder.html -renderingApp: collections + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + #Delete this comment before entering the name of the publishing app. + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + collections + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto - input: + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Breadcrumbs' componentURL: https://components.publishing.service.gov.uk/component-guide/breadcrumbs - generated: auto - input: + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 2: - componentName: Heading + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Heading' componentURL: https://components.publishing.service.gov.uk/component-guide/heading - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 3: - componentName: '[Form input](https://components.publishing.service.gov.uk/component-guide/input) is being used as search field' - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Form input](https://components.publishing.service.gov.uk/component-guide/input) is being used as search field' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 4: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 5: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 6: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 7: - componentName: '[Details](https://components.publishing.service.gov.uk/component-guide/details) is displayed if an organization is sponsored by another organization' - componentURL: - generated: publisher - input: Sponsoring organisation + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Details](https://components.publishing.service.gov.uk/component-guide/details) is displayed if an organization is sponsored by another organization' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + Sponsoring organisation 8: - componentName: Big number + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Big number' componentURL: https://components.publishing.service.gov.uk/component-guide/big_number - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 9: - componentName: Organisation logo + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Organisation logo' componentURL: https://components.publishing.service.gov.uk/component-guide/organisation_logo - generated: publisher - input: Logo formatted name (required), Logo crest (required), and Brand color + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Logo formatted name (required), Logo crest (required), and Brand color' + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. +insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. +issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/finder/groups-finder.md b/docs/frontend-templates/finder/groups-finder.md index ee562f5..a75ccbe 100644 --- a/docs/frontend-templates/finder/groups-finder.md +++ b/docs/frontend-templates/finder/groups-finder.md @@ -1,67 +1,268 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Finder + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Groups finder -description: A directory of all the groups within the UK government + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. +description: A directory of all the groups within the UK government. + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - This finder lists all the groups within the UK government. End-users can use the search component to filter the returned results on the page. + 'This finder lists all the groups within the UK government. End-users can use the search component to filter the returned results on the page.' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: + # Both title and link are REQUIRED in order for this information to render on the page. title: Groups link: https://www.gov.uk/government/groups + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. +contentDataLink: #Delete this comment before entering Content Data URL assocaited with this frontend template. + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/content-schemas/finder.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/document-types/finder.html -renderingApp: finder frontend + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + #Delete this comment before entering the name of the publishing app. + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + finder frontend + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Contextual breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Contextual breadcrumbs' componentURL: https://components.publishing.service.gov.uk/component-guide/contextual_breadcrumbs - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 2: - componentName: "[Heading](https://components.publishing.service.gov.uk/component-guide/heading) displays the total groups" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Heading](https://components.publishing.service.gov.uk/component-guide/heading) displays the total groups' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 3: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 4: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 5: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 6: - componentName: Search + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Search' componentURL: https://components.publishing.service.gov.uk/component-guide/search - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 7: - componentName: Subscription links + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Subscription links' componentURL: https://components.publishing.service.gov.uk/component-guide/subscription_links - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 8: - componentName: Document list + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Document list' componentURL: https://components.publishing.service.gov.uk/component-guide/document_list - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. +insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. +issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/finder/hmrc-contacts-finder.md b/docs/frontend-templates/finder/hmrc-contacts-finder.md index d7adc24..1df59b9 100644 --- a/docs/frontend-templates/finder/hmrc-contacts-finder.md +++ b/docs/frontend-templates/finder/hmrc-contacts-finder.md @@ -1,77 +1,298 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Finder + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: HMRC contacts finder -description: A directory of all the ways to contact HMRC + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. +description: A directory of all the ways to contact HMRC. + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - This finder lists all the contacts within HMRC. End-users can use the search component to filter the returned results on the page based on a topic and via search. + 'This finder lists all the contacts within HMRC. End-users can use the search component to filter the returned results on the page based on a topic and via search.' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: Contact HM Revenue & Customs + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Contact HM Revenue & Customs' link: https://www.gov.uk/government/organisations/hm-revenue-customs/contact + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. +contentDataLink: #Delete this comment before entering Content Data URL assocaited with this frontend template. + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/content-schemas/finder.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/document-types/finder.html -renderingApp: finder frontend + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + #Delete this comment before entering the name of the publishing app. + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + finder frontend + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Contextual breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Contextual breadcrumbs' componentURL: https://components.publishing.service.gov.uk/component-guide/contextual_breadcrumbs - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 2: - componentName: "[Heading](https://components.publishing.service.gov.uk/component-guide/heading) displays the total contacts" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Heading](https://components.publishing.service.gov.uk/component-guide/heading) displays the total contacts' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 3: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 4: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 5: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 6: - componentName: Metadata block + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Metadata block' componentURL: https://components.publishing.service.gov.uk/component-guide/metadata - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 7: - componentName: Search + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Search' componentURL: https://components.publishing.service.gov.uk/component-guide/search - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 8: - componentName: Subscription links + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Subscription links' componentURL: https://components.publishing.service.gov.uk/component-guide/subscription_links - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 9: - componentName: Document list + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Document list' componentURL: https://components.publishing.service.gov.uk/component-guide/document_list - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 10: - componentName: Option select + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Option select' componentURL: https://components.publishing.service.gov.uk/component-guide/option_select - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. +insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. +issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/finder/index.md b/docs/frontend-templates/finder/index.md index 7b4ed09..424ecc2 100644 --- a/docs/frontend-templates/finder/index.md +++ b/docs/frontend-templates/finder/index.md @@ -1,21 +1,48 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Frontend templates + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Finder -description: A Finder is a scoped search on a single dataset with filters to modify the results. -figmaLink: + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. +description: 'A Finder is a scoped search on a single dataset with filters to modify the results.' + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - "### What is a finder + '### What is a finder - Depending on context, \"finder\" can mean: + Depending on context, “finder” can mean: - - The \"finder pattern\" + - The “finder pattern” - - The \"finder technology\", ie. a product used to generate finders using content-store and finder-frontend) + - The “finder technology”, ie. a product used to generate finders using content-store and finder-frontend) - - A specific finder including the content it exposes is sometimes called a \"finder\" by editors + - A specific finder including the content it exposes is sometimes called a “finder” by editors ### What does a finder do? @@ -25,64 +52,227 @@ howItWorks: Finders help users find a specific document, or set of documents, within a topic. - Finders also help users who need to know when a document is published or updated relating to a specific topic or subtopic." + Finders also help users who need to know when a document is published or updated relating to a specific topic or subtopic.' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: "Case studies: Real-life examples of government activity" + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Case studies: Real-life examples of government activity' link: https://www.gov.uk/government/case-studies + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 1: - title: Departments, agencies and public bodies + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Departments, agencies and public bodies' link: https://www.gov.uk/government/organisations + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 2: - title: Groups + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Groups' link: https://www.gov.uk/government/groups + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 3: - title: Contact HM Revenue & Customs + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Contact HM Revenue & Customs' link: https://www.gov.uk/government/organisations/hm-revenue-customs/contact + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 4: - title: All ministers and senior officials on GOV.UK + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'All ministers and senior officials on GOV.UK' link: https://www.gov.uk/government/people + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 5: - title: Search + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Search' link: https://www.gov.uk/search/all + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 6: - title: "AAIB: Air Accidents Investigation Branch reports" + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'AAIB: Air Accidents Investigation Branch reports' link: https://www.gov.uk/aaib-reports + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 7: - title: Statistical data sets + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Statistical data sets' link: https://www.gov.uk/government/statistical-data-sets + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 8: - title: Guidance and regulation + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Guidance and regulation' link: https://www.gov.uk/search/guidance-and-regulation + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 9: - title: Topical Events + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Topical Events' link: https://www.gov.uk/government/topical-events + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 10: - title: Worldwide organisations + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Worldwide organisations' link: https://www.gov.uk/world/organisations + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. contentDataLink: https://content-data.publishing.service.gov.uk/content?submitted=true&date_range=past-30-days&search_term=&document_type=finder&organisation_id=all + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. +contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. + title: #Delete this comment before entering the name of the content schema. + link: #Delete this comment before entering the developer docs URL of this content schema. + +contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. + title: #Delete this comment before entering the name of the content type (also known as document type). + link: #Delete this comment before entering the developer docs URL of this content type/document type. + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + #Delete this comment before entering the name of the publishing app. + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + #Delete this comment before entering the name of the rendering app. + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. +components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #Delete this comment before entering the name of the component used within this pattern. + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + # Delete this comment before enter how this component is generated on the page. + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: "GOV.UK site search: desk research, analytics findings and product solutions" - link: https://docs.google.com/presentation/d/1IoupQiEuCLMc-AOEUntGeKwQPIG-cWmnleuHOgujOuI/edit?usp=sharing - description: Findings after the search team has improved the relevancy of site search results, and what to do next + # Both title and link are REQUIRED in order for this information to render on the page. date: 7 August 2024 + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + 'Findings after the search team has improved the relevancy of site search results, and what to do next' + title: 'GOV.UK site search: desk research, analytics findings and product solutions' + link: https://docs.google.com/presentation/d/1IoupQiEuCLMc-AOEUntGeKwQPIG-cWmnleuHOgujOuI/edit?usp=sharing + documentFormat: Google Slides 1: - title: Proposal to improve Specialist Finder development and efficiency - link: https://docs.google.com/document/d/1hZD3eJjX3qWL6ntWV_aUq0U43m5LIEblwAeIRoUY7x0/edit?usp=sharing - description: This document outlines the reasons and benefits to improve specialist finder + # Both title and link are REQUIRED in order for this information to render on the page. date: 1 July 2024 + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + 'This document outlines the reasons and benefits to improve specialist finder' + title: 'Proposal to improve Specialist Finder development and efficiency' + link: https://docs.google.com/document/d/1hZD3eJjX3qWL6ntWV_aUq0U43m5LIEblwAeIRoUY7x0/edit?usp=sharing + documentFormat: Google Docs 2: - title: Should we move finders to Google Vertex AI Search? - link: https://docs.google.com/document/d/1x84j4IvpQcXy8WpG2Mx9YrO5GFZeOYOToiSzK9ax6Uk/edit?usp=sharing - description: Migrating finders to Vertex in order to improve keyword search relevance + # Both title and link are REQUIRED in order for this information to render on the page. date: 10 May 2024 + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + 'Migrating finders to Vertex in order to improve keyword search relevance' + title: 'Should we move finders to Google Vertex AI Search?' + link: https://docs.google.com/document/d/1x84j4IvpQcXy8WpG2Mx9YrO5GFZeOYOToiSzK9ax6Uk/edit?usp=sharing + documentFormat: Google Docs + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: + # Both title and link are REQUIRED in order to display this information on the page. title: Different component is being used as the page title on Site search finder - link: + link: #Delete this comment before entering the URL of the corresponding GitHub issue. 1: + # Both title and link are REQUIRED in order to display this information on the page. title: Inconsistent top-margin and bottom-margin for page title - link: -githubIssueLink: + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/finder/people-finder.md b/docs/frontend-templates/finder/people-finder.md index 62ffaf5..b1a40b9 100644 --- a/docs/frontend-templates/finder/people-finder.md +++ b/docs/frontend-templates/finder/people-finder.md @@ -1,68 +1,268 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Finder + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: People finder -description: A directory of all ministers and senior officials on GOV.UK + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. +description: A directory of all ministers and senior officials on GOV.UK. + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - This finder lists all the contacts within the UK government. End-users can use the search component to filter the returned results on the page based on a topic and via search. + 'This finder lists all the contacts within the UK government. End-users can use the search component to filter the returned results on the page based on a topic and via search.' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: All ministers and senior officials on GOV.UK + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'All ministers and senior officials on GOV.UK' link: https://www.gov.uk/government/people + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. +contentDataLink: #Delete this comment before entering Content Data URL assocaited with this frontend template. + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/content-schemas/finder.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/document-types/finder.html -renderingApp: finder frontend + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + #Delete this comment before entering the name of the publishing app. + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + finder frontend + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Contextual breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Contextual breadcrumbs' componentURL: https://components.publishing.service.gov.uk/component-guide/contextual_breadcrumbs - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 2: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 3: - componentName: Search + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Search' componentURL: https://components.publishing.service.gov.uk/component-guide/search - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 4: - componentName: Heading + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Heading' componentURL: https://components.publishing.service.gov.uk/component-guide/heading - generated: auto - input: + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 5: - componentName: Subscription link + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Subscription link' componentURL: https://components.publishing.service.gov.uk/component-guide/subscription_links - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 6: - componentName: Document list + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Document list' componentURL: https://components.publishing.service.gov.uk/component-guide/document_list - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 7: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 8: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: - + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. +insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. +issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/finder/search.md b/docs/frontend-templates/finder/search.md index 6697276..dc03982 100644 --- a/docs/frontend-templates/finder/search.md +++ b/docs/frontend-templates/finder/search.md @@ -1,109 +1,358 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Finder + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Search -description: Site search is designed to find and list all indexed content on GOV.UK -figmaLink: -howItWorks: The returned results that appear on site search come from search-api. Since it’s a universal search, site search can link out to any GOV.UK page, no matter what the frontend template are for those pages. + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. +description: Site search is designed to find and list all indexed content on GOV.UK. + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). +howItWorks: + 'The returned results that appear on site search come from search-api. Since it’s a universal search, site search can link out to any GOV.UK page, no matter what the frontend template are for those pages.' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: Search + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Search' link: https://www.gov.uk/search/all -contentDataLink: + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. +contentDataLink: #Delete this comment before entering Content Data URL assocaited with this frontend template. + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/content-schemas/finder.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/document-types/finder.html -renderingApp: finder frontend + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + #Delete this comment before entering the name of the publishing app. + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + finder frontend + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Contextual breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Contextual breadcrumbs' componentURL: https://components.publishing.service.gov.uk/component-guide/contextual_breadcrumbs - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 2: - componentName: Search + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Search' componentURL: https://components.publishing.service.gov.uk/component-guide/search - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 3: - componentName: Heading + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Heading' componentURL: https://components.publishing.service.gov.uk/component-guide/heading - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 4: - componentName: "[Option select](https://components.publishing.service.gov.uk/component-guide/option_select) appears within the search filter" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Option select](https://components.publishing.service.gov.uk/component-guide/option_select) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 5: - componentName: "[Select](https://components.publishing.service.gov.uk/component-guide/select) appears within the search filter" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Select](https://components.publishing.service.gov.uk/component-guide/select) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 6: - componentName: "[Form checkboxes](https://components.publishing.service.gov.uk/component-guide/checkboxes) appears within the search filter" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Form checkboxes](https://components.publishing.service.gov.uk/component-guide/checkboxes) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 7: - componentName: "[Form hint text](https://components.publishing.service.gov.uk/component-guide/hint) appears within the search filter" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Form hint text](https://components.publishing.service.gov.uk/component-guide/hint) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 8: - componentName: "[Date filter](https://govuk-finder-frontend.herokuapp.com/component-guide/date_filter) appears within the search filter" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Date filter](https://govuk-finder-frontend.herokuapp.com/component-guide/date_filter) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 9: - componentName: All the filters are within the [Expander](https://govuk-finder-frontend.herokuapp.com/component-guide/expander) - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'All the filters are within the [Expander](https://govuk-finder-frontend.herokuapp.com/component-guide/expander)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 10: - componentName: "[Previous and next navigation](https://components.publishing.service.gov.uk/component-guide/previous_and_next_navigation) appears if there is more than 20 returned search results" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Previous and next navigation](https://components.publishing.service.gov.uk/component-guide/previous_and_next_navigation) appears if there is more than 20 returned search results' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 11: - componentName: Subscription link + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Subscription link' componentURL: https://components.publishing.service.gov.uk/component-guide/subscription_links - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 12: - componentName: Document list + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Document list' componentURL: https://components.publishing.service.gov.uk/component-guide/document_list - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 13: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 14: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. description: - date: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: -githubIssueLink: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/finder/specialist-document-finder.md b/docs/frontend-templates/finder/specialist-document-finder.md index 81ec948..729dc3e 100644 --- a/docs/frontend-templates/finder/specialist-document-finder.md +++ b/docs/frontend-templates/finder/specialist-document-finder.md @@ -1,162 +1,517 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Finder + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Specialist document finder + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. description: Specialist Document finders are used to search for Specialist documents -figmaLink: -howItWorks: The returned results in this finder are exclusively specialist documents. Thus, every document on the page will have the `specialist_document` content schema . + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). +howItWorks: + 'The returned results in this finder are exclusively specialist documents. Thus, every document on the page will have the `specialist_document` content schema.' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: "AAIB: Air Accidents Investigation Branch reports" + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'AAIB: Air Accidents Investigation Branch reports' link: https://www.gov.uk/aaib-reports + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 1: - title: Competition and Markets Authority cases and projects + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Competition and Markets Authority cases and projects' link: https://www.gov.uk/cma-cases + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 2: - title: Countryside Stewardship grant finder + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Countryside Stewardship grant finder' link: https://www.gov.uk/countryside-stewardship-grants + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 3: - title: International development funding + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'International development funding' link: https://www.gov.uk/international-development-funding + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 4: - title: Research for Development Outputs + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Research for Development Outputs' link: https://www.gov.uk/dfid-research-outputs + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 5: - title: European Structural and Investment Funds (ESIF) + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'European Structural and Investment Funds (ESIF)' link: https://www.gov.uk/european-structural-investment-funds + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 6: - title: Marine Accident Investigation Branch reports + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Marine Accident Investigation Branch reports' link: https://www.gov.uk/maib-reports + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 7: - title: "Alerts, recalls and safety information: drugs and medical devices" + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Alerts, recalls and safety information: drugs and medical devices' link: https://www.gov.uk/drug-device-alerts + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 8: - title: Drug Safety Update + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Drug Safety Update' link: https://www.gov.uk/drug-safety-update + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 9: - title: Rail Accident Investigation Branch reports + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Rail Accident Investigation Branch reports' link: https://www.gov.uk/raib-reports?report_type%5B%5D=investigation-report + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 10: - title: Service Standard Reports + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Service Standard Reports' link: https://www.gov.uk/service-standard-reports + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 11: - title: Finance and support for your business + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Finance and support for your business' link: https://www.gov.uk/business-finance-support-finder -contentDataLink: + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. +contentDataLink: #Delete this comment before entering Content Data URL assocaited with this frontend template. + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/content-schemas/finder.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/document-types/finder.html -renderingApp: finder frontend + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + #Delete this comment before entering the name of the publishing app. + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + finder frontend + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Contextual breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Contextual breadcrumbs' componentURL: https://components.publishing.service.gov.uk/component-guide/contextual_breadcrumbs - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 2: - componentName: The [Search](https://components.publishing.service.gov.uk/component-guide/search) component is above the filters, which occupies `1/3` of the page - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'The [Search](https://components.publishing.service.gov.uk/component-guide/search) component is above the filters, which occupies `1/3` of the page' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 3: - componentName: Heading + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Heading' componentURL: https://components.publishing.service.gov.uk/component-guide/heading - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 4: - componentName: "[Option select](https://components.publishing.service.gov.uk/component-guide/option_select) appears within the search filter" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Option select](https://components.publishing.service.gov.uk/component-guide/option_select) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 5: - componentName: "[Select](https://components.publishing.service.gov.uk/component-guide/select) appears within the search filter" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Select](https://components.publishing.service.gov.uk/component-guide/select) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 6: - componentName: "[Form checkboxes](https://components.publishing.service.gov.uk/component-guide/checkboxes) appears within the search filter" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Form checkboxes](https://components.publishing.service.gov.uk/component-guide/checkboxes) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 7: - componentName: "[Form hint text](https://components.publishing.service.gov.uk/component-guide/hint) appears within the search filter" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Form hint text](https://components.publishing.service.gov.uk/component-guide/hint) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 8: - componentName: "[Date filter](https://govuk-finder-frontend.herokuapp.com/component-guide/date_filter) appears within the search filter" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Date filter](https://govuk-finder-frontend.herokuapp.com/component-guide/date_filter) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 9: - componentName: All the filters are within the [Expander](https://govuk-finder-frontend.herokuapp.com/component-guide/expander) - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'All the filters are within the [Expander](https://govuk-finder-frontend.herokuapp.com/component-guide/expander)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 10: - componentName: "[Previous and next navigation](https://components.publishing.service.gov.uk/component-guide/previous_and_next_navigation) appears if there is more than 20 returned search results" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Previous and next navigation](https://components.publishing.service.gov.uk/component-guide/previous_and_next_navigation) appears if there is more than 20 returned search results' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 11: - componentName: Subscription link + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Subscription link' componentURL: https://components.publishing.service.gov.uk/component-guide/subscription_links - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 12: - componentName: Document list + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Document list' componentURL: https://components.publishing.service.gov.uk/component-guide/document_list - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 13: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 14: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 15: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 16: - componentName: The [Govspeak content](https://components.publishing.service.gov.uk/component-guide/govspeak) is situated above the filter and returned results - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'The [Govspeak content](https://components.publishing.service.gov.uk/component-guide/govspeak) is situated above the filter and returned results' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 17: - componentName: Phase banner + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Phase banner' componentURL: https://components.publishing.service.gov.uk/component-guide/phase_banner - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 18: - componentName: Metadata block + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Metadata block' componentURL: https://components.publishing.service.gov.uk/component-guide/metadata - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. description: - date: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: -githubIssueLink: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/finder/statistical-data-sets-finder.md b/docs/frontend-templates/finder/statistical-data-sets-finder.md index d63ebc2..41f1f51 100644 --- a/docs/frontend-templates/finder/statistical-data-sets-finder.md +++ b/docs/frontend-templates/finder/statistical-data-sets-finder.md @@ -1,107 +1,343 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Finder + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Statistical data sets finder -description: Specialist Document finders are used to search for statistical data documents -figmaLink: -howItWorks: "Statistical Data Sets finder is used to search for documents with the content type set to `statistical_data_set`. +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. +description: Specialist Document finders are used to search for statistical data documents. + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. -Documents with that content type are published via Whitehall publisher." +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). +howItWorks: + 'Statistical Data Sets finder is used to search for documents with the content type set to `statistical_data_set`.' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: Statistical data sets + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Statistical data sets' link: https://www.gov.uk/government/statistical-data-sets -contentDataLink: + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + fales + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. +contentDataLink: #Delete this comment before entering Content Data URL assocaited with this frontend template. + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/content-schemas/finder.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/document-types/finder.html -renderingApp: finder frontend + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + #Delete this comment before entering the name of the publishing app. + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + finder frontend + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: - 0: - componentName: Layout super navigation header + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: - 1: - componentName: Contextual breadcrumbs + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 1: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Contextual breadcrumbs' componentURL: https://components.publishing.service.gov.uk/component-guide/contextual_breadcrumbs - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: - 2: - componentName: The [Search](https://components.publishing.service.gov.uk/component-guide/search) component is above the filters, which occupies `1/3` of the page - componentURL: - generated: auto + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 2: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'The [Search](https://components.publishing.service.gov.uk/component-guide/search) component is above the filters, which occupies `1/3` of the page' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: - 3: - componentName: Heading + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 3: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Heading' componentURL: https://components.publishing.service.gov.uk/component-guide/heading - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: - 4: - componentName: "[Option select](https://components.publishing.service.gov.uk/component-guide/option_select) appears within the search filter" - componentURL: - generated: auto + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 4: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Option select](https://components.publishing.service.gov.uk/component-guide/option_select) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: - 5: - componentName: "[Form hint text](https://components.publishing.service.gov.uk/component-guide/hint) appears within the search filter" - componentURL: - generated: auto + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 5: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Form hint text](https://components.publishing.service.gov.uk/component-guide/hint) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: - 6: - componentName: "[Date filter](https://govuk-finder-frontend.herokuapp.com/component-guide/date_filter) appears within the search filter" - componentURL: - generated: auto + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 6: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Date filter](https://govuk-finder-frontend.herokuapp.com/component-guide/date_filter) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: - 7: - componentName: All the filters are within the [Expander](https://govuk-finder-frontend.herokuapp.com/component-guide/expander) - componentURL: - generated: auto + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 7: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'All the filters are within the [Expander](https://govuk-finder-frontend.herokuapp.com/component-guide/expander)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: - 8: - componentName: "[Previous and next navigation](https://components.publishing.service.gov.uk/component-guide/previous_and_next_navigation) appears if there is more than 20 returned search results" - componentURL: - generated: auto + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 8: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Previous and next navigation](https://components.publishing.service.gov.uk/component-guide/previous_and_next_navigation) appears if there is more than 20 returned search results' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: - 9: - componentName: Subscription link + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 9: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Subscription link' componentURL: https://components.publishing.service.gov.uk/component-guide/subscription_links - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: - 10: - componentName: Document list + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 10: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Document list' componentURL: https://components.publishing.service.gov.uk/component-guide/document_list - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: - 11: - componentName: Feedback + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 11: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: - 12: - componentName: Layout footer + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 12: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: - 13: - componentName: Page title + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + 13: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. description: - date: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: -githubIssueLink: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/finder/supergroup-finder.md b/docs/frontend-templates/finder/supergroup-finder.md index 33bece8..2f8c292 100644 --- a/docs/frontend-templates/finder/supergroup-finder.md +++ b/docs/frontend-templates/finder/supergroup-finder.md @@ -1,132 +1,421 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Finder + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Supergroup finder -description: A finder for documents that are part of the content purpose supertypes -figmaLink: -howItWorks: "Supergroup finders find most GOV.UK content that belongs in one of the [content purpose supertypes](https://github.com/alphagov/govuk_document_types/blob/master/data/content_purpose_supergroups.md). +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. +description: A finder for documents that are part of the content purpose supertypes. + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). +howItWorks: + 'Supergroup finders find most GOV.UK content that belongs in one of the [content purpose supertypes](https://github.com/alphagov/govuk_document_types/blob/master/data/content_purpose_supergroups.md). + + + Results come from search-api.' -Results come from search-api." +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: Guidance and regulation + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Guidance and regulation' link: https://www.gov.uk/search/guidance-and-regulation + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 1: - title: News and communications + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'News and communications' link: https://www.gov.uk/search/news-and-communications + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 2: - title: Policy papers and consultations + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Policy papers and consultations' link: https://www.gov.uk/search/policy-papers-and-consultations + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 3: - title: Research and statistic + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Research and statistic' link: https://www.gov.uk/search/research-and-statistics + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 4: - title: Services + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Services' link: https://www.gov.uk/search/services + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 5: - title: Transparency and freedom of information releases + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Transparency and freedom of information releases' link: https://www.gov.uk/search/transparency-and-freedom-of-information-releases -contentDataLink: + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. +contentDataLink: #Delete this comment before entering Content Data URL assocaited with this frontend template. + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/content-schemas/finder.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/document-types/finder.html -renderingApp: finder frontend + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + #Delete this comment before entering the name of the publishing app. + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + finder frontend + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Contextual breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Contextual breadcrumbs' componentURL: https://components.publishing.service.gov.uk/component-guide/contextual_breadcrumbs - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 2: - componentName: The [Search](https://components.publishing.service.gov.uk/component-guide/search) component is above the filters, which occupies `1/3` of the page - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'The [Search](https://components.publishing.service.gov.uk/component-guide/search) component is above the filters, which occupies `1/3` of the page' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 3: - componentName: Heading + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Heading' componentURL: https://components.publishing.service.gov.uk/component-guide/heading - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 4: - componentName: "[Option select](https://components.publishing.service.gov.uk/component-guide/option_select) appears within the search filter" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Option select](https://components.publishing.service.gov.uk/component-guide/option_select) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 5: - componentName: "[Select](https://components.publishing.service.gov.uk/component-guide/select) appears within the search filter" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Select](https://components.publishing.service.gov.uk/component-guide/select) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 6: - componentName: "[Form checkboxes](https://components.publishing.service.gov.uk/component-guide/checkboxes) appears within the search filter" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Form checkboxes](https://components.publishing.service.gov.uk/component-guide/checkboxes) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 7: - componentName: "[Form hint text](https://components.publishing.service.gov.uk/component-guide/hint) appears within the search filter" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Form hint text](https://components.publishing.service.gov.uk/component-guide/hint) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 8: - componentName: "[Date filter](https://govuk-finder-frontend.herokuapp.com/component-guide/date_filter) appears within the search filter" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Date filter](https://govuk-finder-frontend.herokuapp.com/component-guide/date_filter) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 9: - componentName: All the filters are within the [Expander](https://govuk-finder-frontend.herokuapp.com/component-guide/expander) - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'All the filters are within the [Expander](https://govuk-finder-frontend.herokuapp.com/component-guide/expander)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 10: - componentName: "[Previous and next navigation](https://components.publishing.service.gov.uk/component-guide/previous_and_next_navigation) appears if there is more than 20 returned search results" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Previous and next navigation](https://components.publishing.service.gov.uk/component-guide/previous_and_next_navigation) appears if there is more than 20 returned search results' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 11: - componentName: Subscription link + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Subscription link' componentURL: https://components.publishing.service.gov.uk/component-guide/subscription_links - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 12: - componentName: Document list + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Document list' componentURL: https://components.publishing.service.gov.uk/component-guide/document_list - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 13: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 14: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 15: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. description: - date: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: -githubIssueLink: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/finder/topical-events-finder.md b/docs/frontend-templates/finder/topical-events-finder.md index 2936ca9..5a3a778 100644 --- a/docs/frontend-templates/finder/topical-events-finder.md +++ b/docs/frontend-templates/finder/topical-events-finder.md @@ -1,105 +1,343 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Finder + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Topical events finder -description: A finder solely for searching topical events on GOV.UK -figmaLink: + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. +description: A finder solely for searching topical events on GOV.UK. + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - Topical Events finder is used to search for [topical event](../../topical-events) throughout all of GOV.UK + 'Topical Events finder is used to search for [topical event](../../topical-events) throughout all of GOV.UK.' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: + # Both title and link are REQUIRED in order for this information to render on the page. title: Topical Events link: https://www.gov.uk/government/topical-events -contentDataLink: + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. +contentDataLink: #Delete this comment before entering Content Data URL assocaited with this frontend template. + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/content-schemas/finder.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/document-types/finder.html -renderingApp: finder frontend + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + #Delete this comment before entering the name of the publishing app. + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + finder frontend + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Contextual breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Contextual breadcrumbs' componentURL: https://components.publishing.service.gov.uk/component-guide/contextual_breadcrumbs - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 2: - componentName: The [Search](https://components.publishing.service.gov.uk/component-guide/search) component is above the filters, which occupies `1/3` of the page - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'The [Search](https://components.publishing.service.gov.uk/component-guide/search) component is above the filters, which occupies `1/3` of the page' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 3: - componentName: Heading + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Heading' componentURL: https://components.publishing.service.gov.uk/component-guide/heading - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 4: - componentName: "[Option select](https://components.publishing.service.gov.uk/component-guide/option_select) appears within the search filter" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Option select](https://components.publishing.service.gov.uk/component-guide/option_select) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 5: - componentName: "[Form checkboxes](https://components.publishing.service.gov.uk/component-guide/checkboxes) appears within the search filter" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Form checkboxes](https://components.publishing.service.gov.uk/component-guide/checkboxes) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 6: - componentName: "[Form hint text](https://components.publishing.service.gov.uk/component-guide/hint) appears within the search filter" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Form hint text](https://components.publishing.service.gov.uk/component-guide/hint) appears within the search filter' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 7: - componentName: All the filters are within the [Expander](https://govuk-finder-frontend.herokuapp.com/component-guide/expander) - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'All the filters are within the [Expander](https://govuk-finder-frontend.herokuapp.com/component-guide/expander)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 8: - componentName: "[Previous and next navigation](https://components.publishing.service.gov.uk/component-guide/previous_and_next_navigation) appears if there is more than 20 returned search results" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Previous and next navigation](https://components.publishing.service.gov.uk/component-guide/previous_and_next_navigation) appears if there is more than 20 returned search results' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 9: - componentName: Subscription link + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Subscription link' componentURL: https://components.publishing.service.gov.uk/component-guide/subscription_links - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 10: - componentName: Document list + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Document list' componentURL: https://components.publishing.service.gov.uk/component-guide/document_list - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 11: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 12: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 13: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: - description: - date: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: -githubIssueLink: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/finder/world-organisation-finder.md b/docs/frontend-templates/finder/world-organisation-finder.md index 371af14..407a3cc 100644 --- a/docs/frontend-templates/finder/world-organisation-finder.md +++ b/docs/frontend-templates/finder/world-organisation-finder.md @@ -1,80 +1,267 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Finder + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: World organisation finder + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. description: A finder solely for searching worldwide organisations on GOV.UK -figmaLink: + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - Worldwide organisation finder is used to search for worldwide organisations throughout all of GOV.UK + 'Worldwide organisation finder is used to search for worldwide organisations throughout all of GOV.UK' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: Worldwide organisations + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Worldwide organisations' link: https://www.gov.uk/world/organisations -contentDataLink: + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. +contentDataLink: #Delete this comment before entering Content Data URL assocaited with this frontend template. + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/content-schemas/finder.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: finder link: https://docs.publishing.service.gov.uk/document-types/finder.html -renderingApp: finder frontend + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + #Delete this comment before entering the name of the publishing app. + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + finder frontend + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Contextual breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Contextual breadcrumbs' componentURL: https://components.publishing.service.gov.uk/component-guide/contextual_breadcrumbs - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 2: - componentName: The [Search](https://components.publishing.service.gov.uk/component-guide/search) component is above the filters, which occupies `1/3` of the page - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'The [Search](https://components.publishing.service.gov.uk/component-guide/search) component is above the filters, which occupies `1/3` of the page' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 3: - componentName: Heading + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Heading' componentURL: https://components.publishing.service.gov.uk/component-guide/heading - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 4: - componentName: Subscription link + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Subscription link' componentURL: https://components.publishing.service.gov.uk/component-guide/subscription_links - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 5: - componentName: Document list + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Document list' componentURL: https://components.publishing.service.gov.uk/component-guide/document_list - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 6: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 7: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 8: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: - description: - date: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: -githubIssueLink: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/guide.md b/docs/frontend-templates/guide.md index 99d7972..59af2b0 100644 --- a/docs/frontend-templates/guide.md +++ b/docs/frontend-templates/guide.md @@ -1,101 +1,325 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Frontend templates + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Guide + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. description: Guides are designed to present complicated and long subjects by breaking them up into separate pages. -figmaLink: -howItWorks: Guides have multiple parts (or chapters). Each part has a title, a body and a slug. + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). +howItWorks: + 'Guides have multiple parts (or chapters). Each part has a title, a body and a slug.' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: "HMRC online services: sign in or set up an account" + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'HMRC online services: sign in or set up an account' link: https://www.gov.uk/log-in-register-hmrc-online-services + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 1: - title: Tax overpayments and underpayments + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Tax overpayments and underpayments' link: https://www.gov.uk/tax-overpayments-and-underpayments/if-youre-due-a-refund + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 2: - title: Universal Credit + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Universal Credit' link: https://www.gov.uk/universal-credit + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. contentDataLink: https://content-data.publishing.service.gov.uk/content?submitted=true&date_range=past-30-days&search_term=&document_type=guide&organisation_id=all + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: guide link: https://docs.publishing.service.gov.uk/content-schemas/guide.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: guide link: https://docs.publishing.service.gov.uk/document-types/guide.html -publishingApp: mainstream publisher -renderingApp: government frontend + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + mainstream publisher + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + government frontend + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Breadcrumbs' componentURL: https://components.publishing.service.gov.uk/component-guide/breadcrumbs - generated: auto - input: Tagging > Breadcrumbs + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Tagging > Breadcrumbs' 2: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: publisher - input: Title (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Title (required)' 3: - componentName: Contents list + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Contents list' componentURL: https://components.publishing.service.gov.uk/component-guide/contents_list - generated: publisher - input: Parts + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Parts' 4: - componentName: Heading + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Heading' componentURL: https://components.publishing.service.gov.uk/component-guide/heading - generated: publisher - input: Parts > Part[i] > Title + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Parts > Part[i] > Title' 5: - componentName: Govspeak content + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Govspeak content' componentURL: https://components.publishing.service.gov.uk/component-guide/govspeak - generated: publisher - input: Parts > Part[i] > Body + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Parts > Part[i] > Body' 6: - componentName: Previous and next navigation + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Previous and next navigation' componentURL: https://components.publishing.service.gov.uk/component-guide/previous_and_next_navigation - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 7: - componentName: "[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual footer](https://components.publishing.service.gov.uk/component-guide/contextual_footer)" - componentURL: - generated: publisher - input: Mainstream browse + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual footer](https://components.publishing.service.gov.uk/component-guide/contextual_footer)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Mainstream browse' 8: - componentName: "[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)" - componentURL: - generated: publisher - input: Related content items + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Related content items' 9: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 10: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: "Guides: Click-thru (any page in guide)" - link: https://docs.google.com/spreadsheets/d/1nMZ4yU0wOhQtPwa78n4i8GKmMuCEYvQTVtKPPVCCbk0/edit?usp=sharing - description: A spreadsheet outlining the total number of sessions in which any page from a guide was viewed + # Both title and link are REQUIRED in order for this information to render on the page. date: May 28, 2024 + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + 'A spreadsheet outlining the total number of sessions in which any page from a guide was viewed.' + title: 'Guides: Click-thru (any page in guide)' + link: https://docs.google.com/spreadsheets/d/1nMZ4yU0wOhQtPwa78n4i8GKmMuCEYvQTVtKPPVCCbk0/edit?usp=sharing + documentFormat: Google Sheets 1: - title: "Guides: usage across chapters" - link: https://docs.google.com/spreadsheets/d/1lW8AJ1HbnFv06gkDB6OUGFPZjeXQbaECWW3t4AT2YPk/edit?gid=0#gid=0 - description: 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 + # Both title and link are REQUIRED in order for this information to render on the page. date: May 28, 2024 + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + '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.' + title: 'Guides: usage across chapters' + link: https://docs.google.com/spreadsheets/d/1lW8AJ1HbnFv06gkDB6OUGFPZjeXQbaECWW3t4AT2YPk/edit?gid=0#gid=0 + documentFormat: Google Sheets + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: Can make a guide with one part… Is that intended? - link: -githubIssueLink: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/homepage.md b/docs/frontend-templates/homepage.md index dc9a3fc..29e30dd 100644 --- a/docs/frontend-templates/homepage.md +++ b/docs/frontend-templates/homepage.md @@ -1,12 +1,40 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Frontend templates + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Homepage + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. description: The homepage sets out the proposition of GOV.UK. It introduces the different kinds of content and information users can find, as well as the different tasks they can do. + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - "The homepage is not exhaustive; it does not provide a link to every single part of the site. It prioritises the most relevant and important tasks and content for the highest number, or the most impacted users. It also exposes how the site is organised. + 'The homepage is not exhaustive; it does not provide a link to every single part of the site. It prioritises the most relevant and important tasks and content for the highest number, or the most impacted users. It also exposes how the site is organised. This provides multiple ways for the user to find what they need: @@ -17,73 +45,223 @@ howItWorks: - By providing keywords (for example, topic names) - - By allowing users to compare important content side-by-side" + - By allowing users to compare important content side-by-side' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: Welcome to GOV.UK + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Welcome to GOV.UK' link: https://www.gov.uk + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. contentDataLink: https://content-data.publishing.service.gov.uk/content?submitted=true&date_range=past-30-days&search_term=&document_type=homepage&organisation_id=all + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: homepage link: https://docs.publishing.service.gov.uk/content-schemas/homepage.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: homepage link: https://docs.publishing.service.gov.uk/document-types/homepage.html -publishingApp: special route publisher -renderingApp: frontend + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + special route publisher + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + frontend + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Search + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Search' componentURL: https://components.publishing.service.gov.uk/component-guide/search - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 2: - componentName: Heading + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Heading' componentURL: https://components.publishing.service.gov.uk/component-guide/heading - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 3: - componentName: Action link + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Action link' componentURL: https://components.publishing.service.gov.uk/component-guide/action_link - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 4: - componentName: Image card + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Image card' componentURL: https://components.publishing.service.gov.uk/component-guide/image_card - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 5: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 6: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: GOV.UK homepage - link: https://gov-uk.atlassian.net/wiki/spaces/GOVUK/pages/29720672/GOV.UK+homepage - description: - "Information regarding the design update, taken place in November 2023" + # Both title and link are REQUIRED in order for this information to render on the page. date: July 10, 2024 + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + 'Information regarding the design update, taken place in November 2023' + title: 'GOV.UK homepage' + link: https://gov-uk.atlassian.net/wiki/spaces/GOVUK/pages/29720672/GOV.UK+homepage + documentFormat: Wiki entry 1: + # Both title and link are REQUIRED in order for this information to render on the page. + date: July 17, 2023 + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + 'Gameplan/lead-up to redesigning the homepage' title: What does user behaviour on the GOV.UK homepage look like link: https://docs.google.com/presentation/d/1S5pKPaeoAAzvh1axETnjd7eYY7rA-6H4/edit?usp=sharing&ouid=106613529911689872123&rtpof=true&sd=true - description: - "Gameplan/lead-up to redesigning the homepage" - date: July 17, 2023 + documentFormat: Google Slides 2: + # Both title and link are REQUIRED in order for this information to render on the page. + date: April 28, 2023 + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + 'Holistic redesign of the homepage' title: Homepage Redesign Challenge link: https://docs.google.com/presentation/d/13YlznozVei-m69S0hL8VAm3mMzHMSoa88EVctgDjFm0/edit?usp=sharing - description: - "Holistic redesign of the homepage" - date: April 28, 2023 + documentFormat: Google Slides + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. +issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/mainstream-browse/index.md b/docs/frontend-templates/mainstream-browse/index.md index 5bd8b18..436b623 100644 --- a/docs/frontend-templates/mainstream-browse/index.md +++ b/docs/frontend-templates/mainstream-browse/index.md @@ -1,66 +1,218 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Frontend templates + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Mainstream browse + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. description: Mainstream browse is a topic system that groups together content by popular topics on GOV.UK. -figmaLink: + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - "Mainstream browse is a topic system that groups together content by popular topics on GOV.UK. It has two levels: + 'There are two levels of mainstream browse pages: + + - [Level one](./level-one) - Topic (parent) + + - [Level two](./level-two) - Subtopic (child) - - [Level one](./level-one) - topic (parent) - - [Level two](./level-two) - subtopic (child) - + Mainstream browse topics are listed in the main menu and on the GOV.UK homepage under ‘Services and information’ heading.' - Mainstream browse topics are listed in the main menu and on the GOV.UK homepage under ‘Services and information’ heading." +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: Level 1 browse page - Driving and transport + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Driving and transport - Level one browse page' link: https://www.gov.uk/browse/driving + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 1: - title: Curated level 2 browse page - Vehicle, tax MOT and insurance + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Vehicle, tax MOT and insurance - Curated level two browse page' link: https://www.gov.uk/browse/driving/vehicle-tax-mot-insurance + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 2: - title: Alphabetical level 2 browse page - School admissions and transport to school + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'School admissions and transport to school - Alphabetical level two browse page' link: https://www.gov.uk/browse/education/school-admissions-transport + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. contentDataLink: https://content-data.publishing.service.gov.uk/content?submitted=true&date_range=past-30-days&search_term=&document_type=mainstream_browse_page&organisation_id=all + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. +contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. + title: #Delete this comment before entering the name of the content schema. + link: #Delete this comment before entering the developer docs URL of this content schema. + +contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. + title: #Delete this comment before entering the name of the content type (also known as document type). + link: #Delete this comment before entering the developer docs URL of this content type/document type. + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + #Delete this comment before entering the name of the publishing app. + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + #Delete this comment before entering the name of the rendering app. + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. +components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #Delete this comment before entering the name of the component used within this pattern. + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + # Delete this comment before enter how this component is generated on the page. + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: How to curate mainstream browse pages - link: https://docs.google.com/presentation/d/1Kp69ojze0kbyIaE2rAyyMIB9hfOBiXNCwbQ37TxQyYQ/edit - description: - "Guidance on how to curate mainstream browse pages" + # Both title and link are REQUIRED in order for this information to render on the page. date: July 2023 - 1: - title: GOV.UK Navigation mainstream browse follow-up A/B test - link: https://docs.google.com/presentation/d/1poSeFuf2KMR2gzMI3A2ePT2xWi7n6QXMf6cBo8aHiZ4/edit?usp=sharing description: - "Findings after A/B test with introduction of accordion component to Mainstream browse page" + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + 'Guidance on how to curate mainstream browse pages' + title: 'How to curate mainstream browse pages' + link: https://docs.google.com/presentation/d/1Kp69ojze0kbyIaE2rAyyMIB9hfOBiXNCwbQ37TxQyYQ/edit + documentFormat: Google Slides + 1: + # Both title and link are REQUIRED in order for this information to render on the page. date: August 15, 2022 - 2: - title: GOV.UK Navigation mainstream browse A/B test - link: https://docs.google.com/presentation/d/1s1d4BYJZaZmt5J0CFORRmMTKPush88_yiT7_OR8WxHw/edit?usp=sharing description: - "This document sets out how the new topic pages will look and work, why we are replacing the current Mainstream Browse topic page, and what we plan to do in the future" + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + 'Findings after A/B test with introduction of accordion component to Mainstream browse page' + title: 'GOV.UK Navigation mainstream browse follow-up A/B test' + link: https://docs.google.com/presentation/d/1poSeFuf2KMR2gzMI3A2ePT2xWi7n6QXMf6cBo8aHiZ4/edit?usp=sharing + documentFormat: Google Slides + 2: + # Both title and link are REQUIRED in order for this information to render on the page. date: June 16, 2022 - 3: - title: Topic page design implementation - link: https://docs.google.com/document/d/1MbhUjXLMUvEvqRU_w5S7RD9_wVhB3LkcdfDIxnSOz4g/edit?usp=sharing description: - "Early-thinking overhaul design of Mainstream browse page replacing miller columns and merging Specialist topics into updated topic pages" + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + 'This document sets out how the new topic pages will look and work, why we are replacing the current Mainstream Browse topic page, and what we plan to do in the future' + title: 'GOV.UK Navigation mainstream browse A/B test' + link: https://docs.google.com/presentation/d/1s1d4BYJZaZmt5J0CFORRmMTKPush88_yiT7_OR8WxHw/edit?usp=sharing + documentFormat: Google Slides + 3: + # Both title and link are REQUIRED in order for this information to render on the page. date: January 26, 2022 - 4: - title: What is Mainstream Browse - link: https://docs.google.com/document/d/13IkO2ZnknFDiNTn-z9E4LwCbTTN1Dnw2xcfO3iU_v9E/edit#heading=h.yw8vk47ou0r5 description: - "Replacing Mainstream Browse taxonomy and replace with new site-wide taxonomy" + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + 'Early-thinking overhaul design of Mainstream browse page replacing miller columns and merging Specialist topics into updated topic pages' + title: 'Topic page design implementation' + link: https://docs.google.com/document/d/1MbhUjXLMUvEvqRU_w5S7RD9_wVhB3LkcdfDIxnSOz4g/edit?usp=sharing + documentFormat: Google Docs + 4: + # Both title and link are REQUIRED in order for this information to render on the page. date: August 20, 2018 - 5: - title: Mainstream Browse design sprint - link: https://docs.google.com/document/d/1aCUbrdqaCCF6mblDfddw1Wck_DmTsHADMYR-Ny-9Xw4/edit#heading=h.yo2pwekzv7t0 description: - "How the design sprint will run for Mainstream Browse pages" + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + 'Replacing Mainstream Browse taxonomy and replace with new site-wide taxonomy' + title: What is Mainstream Browse + link: https://docs.google.com/document/d/13IkO2ZnknFDiNTn-z9E4LwCbTTN1Dnw2xcfO3iU_v9E/edit#heading=h.yw8vk47ou0r5 + documentFormat: Google Docs + 5: + # Both title and link are REQUIRED in order for this information to render on the page. date: August 9, 2018 + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + 'How the design sprint will run for Mainstream Browse pages' + title: 'Mainstream Browse design sprint' + link: https://docs.google.com/document/d/1aCUbrdqaCCF6mblDfddw1Wck_DmTsHADMYR-Ny-9Xw4/edit#heading=h.yo2pwekzv7t0 + documentFormat: Google Docs + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. +issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/mainstream-browse/level-one.md b/docs/frontend-templates/mainstream-browse/level-one.md index 3f6cce4..25cb1cc 100644 --- a/docs/frontend-templates/mainstream-browse/level-one.md +++ b/docs/frontend-templates/mainstream-browse/level-one.md @@ -1,78 +1,286 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Mainstream browse + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Level one + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. description: Mainstream browse is a topic system that groups together content by popular topics on GOV.UK. -# figmaLink: https://www.figma.com/embed?embed_host=share&url=https%3A%2F%2Fwww.figma.com%2Fdesign%2FwZgUBjANbaddOIwTKnNots%2FFrontend-Templates-for-Q2%3Fnode-id%3D67-2%26t%3Dp55X43qBraAepzco-1 + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: + #Delete this comment before entering how this frontend template works. +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: Driving and transport + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Driving and transport' link: https://www.gov.uk/browse/driving + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 1: - title: Benefits + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Benefits' link: https://www.gov.uk/browse/benefits + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 2: - title: Money and tax + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Money and tax' link: https://www.gov.uk/browse/tax -# contentDataLink: https://content-data.publishing.service.gov.uk/content?submitted=true&date_range=past-30-days&search_term=&document_type=mainstream_browse_page&organisation_id=all + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. +contentDataLink: #Delete this comment before entering Content Data URL assocaited with this frontend template. + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: mainstream_browse_page link: https://docs.publishing.service.gov.uk/content-schemas/mainstream_browse_page.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: mainstream_browse_page link: https://docs.publishing.service.gov.uk/document-types/mainstream_browse_page.html -publishingApp: collections publisher -renderingApp: collections + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + collections publisher + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + collections + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Breadcrumbs' componentURL: ../../../components/breadcrumbs - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 2: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 3: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 4: - componentName: Heading + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Heading' componentURL: https://components.publishing.service.gov.uk/component-guide/heading - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 5: - componentName: H1 styled as a [Page title](https://components.publishing.service.gov.uk/component-guide/title) component - componentURL: - generated: publisher - input: Title (required) + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'H1 styled as a [Page title](https://components.publishing.service.gov.uk/component-guide/title) component' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Title (required)' 6: - componentName: Lead paragraph + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Lead paragraph' componentURL: https://components.publishing.service.gov.uk/component-guide/lead_paragraph - generated: publisher - input: Description (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Description (required)' 7: - componentName: Cards + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Cards' componentURL: https://components.publishing.service.gov.uk/component-guide/cards - generated: publisher - input: Subtopics + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Subtopics' 8: - componentName: Action link + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Action link' componentURL: https://components.publishing.service.gov.uk/component-guide/action_link - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. +insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. +issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/mainstream-browse/level-two.md b/docs/frontend-templates/mainstream-browse/level-two.md index 5f765d3..76496c0 100644 --- a/docs/frontend-templates/mainstream-browse/level-two.md +++ b/docs/frontend-templates/mainstream-browse/level-two.md @@ -1,68 +1,262 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Mainstream browse + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Level two + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. description: Mainstream browse is a topic system that groups together content by popular topics on GOV.UK. -figmaLink: + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - Level 2 pages link to mostly mainstream content or they can also include Whitehall content, where there is a user need. Level 2 pages can be curated or alphabetical. + 'Level two pages link to mostly mainstream content or they can also include Whitehall content, where there is a user need. Level two pages can be curated or alphabetical.' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: Curated level 2 browse page - Vehicle, tax MOT and insurance + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Curated level two browse page - Vehicle, tax MOT and insurance' link: https://www.gov.uk/browse/driving/vehicle-tax-mot-insurance + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 1: - title: Alphabetical level 2 browse page - School admissions and transport to school + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Alphabetical level two browse page - School admissions and transport to school' link: https://www.gov.uk/browse/education/school-admissions-transport + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. +contentDataLink: #Delete this comment before entering Content Data URL assocaited with this frontend template. + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: mainstream_browse_page link: https://docs.publishing.service.gov.uk/content-schemas/mainstream_browse_page.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: mainstream_browse_page link: https://docs.publishing.service.gov.uk/document-types/mainstream_browse_page.html -publishingApp: collections publisher -renderingApp: collections + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + collections publisher + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + collections + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Breadcrumbs' componentURL: ../../../components/breadcrumbs - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 2: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 3: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 4: - componentName: Heading + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Heading' componentURL: https://components.publishing.service.gov.uk/component-guide/heading - generated: publisher - input: Title (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Title (required)' 5: - componentName: Lead paragraph + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Lead paragraph' componentURL: https://components.publishing.service.gov.uk/component-guide/lead_paragraph - generated: publisher - input: Description (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Description (required)' 6: - componentName: List component + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'List component' componentURL: https://components.publishing.service.gov.uk/component-guide/list - generated: publisher - input: Add link to current list + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Add link to current list' 7: - componentName: Heading + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Heading' componentURL: https://components.publishing.service.gov.uk/component-guide/heading - generated: publisher - input: Subtopic title (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Subtopic title (required)' + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. +insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. +issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/smart-answer/github-smart-answer.md b/docs/frontend-templates/smart-answer/github-smart-answer.md index 7227820..a24ccf1 100644 --- a/docs/frontend-templates/smart-answer/github-smart-answer.md +++ b/docs/frontend-templates/smart-answer/github-smart-answer.md @@ -1,13 +1,40 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Smart answer + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: GitHub smart answer + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. description: A GitHub smart answer are more complex as it can contain varibles or calculations. -figmaLink: + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - "A GitHub smart answer presents the end-user a series of questions, which can contain complicated variables or calculation. Based on their responses, the GitHub smart answer will channel the end-user to a certain outcome. + 'A GitHub smart answer presents the end-user a series of questions, which can contain complicated variables or calculation. Based on their responses, the GitHub smart answer will channel the end-user to a certain outcome. Github smart answers are made up of: @@ -16,116 +43,358 @@ howItWorks: - data in YAML (`.yml`) files - - content in Ruby (`.erb`) templates" + - content in Ruby (`.erb`) templates' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: Check if you need a UK visa + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Check if you need a UK visa' link: https://www.gov.uk/check-uk-visa + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 1: - title: Check your State Pension age + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Check your State Pension age' link: https://www.gov.uk/state-pension-age + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 2: - title: Calculate holiday entitlement + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Calculate holiday entitlement' link: https://www.gov.uk/calculate-your-holiday-entitlement + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. contentDataLink: https://content-data.publishing.service.gov.uk/content?submitted=true&date_range=past-30-days&search_term=&document_type=smart_answer&organisation_id=all + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: smart_answer link: https://docs.publishing.service.gov.uk/content-schemas/smart_answer.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: smart_answer link: https://docs.publishing.service.gov.uk/document-types/smart_answer.html + publishingApp: -renderingApp: smart answers + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + #Delete this comment before entering the name of the publishing app. + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + smart answers + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Contextual breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Contextual breadcrumbs' componentURL: https://components.publishing.service.gov.uk/component-guide/contextual_breadcrumbs - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 2: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 3: - componentName: Govspeak content + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Govspeak content' componentURL: https://components.publishing.service.gov.uk/component-guide/govspeak - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 4: - componentName: Button + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Button' componentURL: https://components.publishing.service.gov.uk/component-guide/button - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 5: - componentName: Heading + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Heading' componentURL: https://components.publishing.service.gov.uk/component-guide/heading - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 6: - componentName: "[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual footer](https://components.publishing.service.gov.uk/component-guide/contextual_footer)" - componentURL: - generated: hardcode + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual footer](https://components.publishing.service.gov.uk/component-guide/contextual_footer)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 7: - componentName: "[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)" - componentURL: - generated: hardcode + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 8: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 9: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 10: - componentName: "[Select](https://components.publishing.service.gov.uk/component-guide/select) can be used in order for end-user to provide their respone" - componentURL: - generated: hardcode + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Select](https://components.publishing.service.gov.uk/component-guide/select) can be used in order for end-user to provide their respone' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 11: - componentName: "[Form radio button](https://components.publishing.service.gov.uk/component-guide/radio) can be used in order for end-user to provide their respone" - componentURL: - generated: hardcode + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Form radio button](https://components.publishing.service.gov.uk/component-guide/radio) can be used in order for end-user to provide their respone' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 12: - componentName: "[Summary list](https://components.publishing.service.gov.uk/component-guide/summary_list) can be used in order for end-user to provide their respone" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Summary list](https://components.publishing.service.gov.uk/component-guide/summary_list) can be used in order for end-user to provide their respone' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 13: - componentName: "[Error summary](https://components.publishing.service.gov.uk/component-guide/error_summary) appears whenever a required field is not entered or the incorrect information is entered by the end-user" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Error summary](https://components.publishing.service.gov.uk/component-guide/error_summary) appears whenever a required field is not entered or the incorrect information is entered by the end-user' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 14: - componentName: "[Step by step navigation](https://components.publishing.service.gov.uk/component-guide/step_by_step_nav) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)" - componentURL: - generated: publisher - input: "[collections-publisher](https://docs.publishing.service.gov.uk/repos/collections-publisher.html) > Where to show this step by step > Sidebar settings > Sidebar content of page" + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Step by step navigation](https://components.publishing.service.gov.uk/component-guide/step_by_step_nav) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[collections-publisher](https://docs.publishing.service.gov.uk/repos/collections-publisher.html) > Where to show this step by step > Sidebar settings > Sidebar content of page' 15: - componentName: "[Form date input](https://components.publishing.service.gov.uk/component-guide/date_input) can be used in order for end-user to provide their respone" - componentURL: - generated: hardcode + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Form date input](https://components.publishing.service.gov.uk/component-guide/date_input) can be used in order for end-user to provide their respone' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. description: - date: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: -githubIssueLink: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/smart-answer/index.md b/docs/frontend-templates/smart-answer/index.md index fdad148..a8f30f3 100644 --- a/docs/frontend-templates/smart-answer/index.md +++ b/docs/frontend-templates/smart-answer/index.md @@ -1,37 +1,164 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Frontend templates + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Smart answer + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. description: A smart answer is a series of questions that channels a user to a certain outcome based on their responses. -figmaLink: -howItWorks: - "We use smart answers on GOV.UK when there are lots of variables affecting something a user needs to know. As trying to explain all these variables in flat content would result in a long, confusing guide, we’d use a smart answer (effectively a decision tree made up of questions and outcomes) instead. This allows the user to get straight to the content they need, while keeping everything that isn't relevant to them hidden away. +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). +howItWorks: + 'We use smart answers on GOV.UK when there are lots of variables affecting something a user needs to know. As trying to explain all these variables in flat content would result in a long, confusing guide, we’d use a smart answer (effectively a decision tree made up of questions and outcomes) instead. This allows the user to get straight to the content they need, while keeping everything that isn’t relevant to them hidden away. + + + There are 2 different types of smart answers: - There are 2 different types of smart answers: + - [GitHub smart answer](./github-smart-answer) - - [GitHub smart answer](./github-smart-answer) + - [Simple smart answer](./simple-smart-answer)' - - [Simple smart answer](./simple-smart-answer)" +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: Check if you need a UK visa (GitHub smart answer) + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Check if you need a UK visa (GitHub smart answer)' link: https://www.gov.uk/check-uk-visa + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 1: - title: Tell DVLA you've sold, transferred or bought a vehicle (Simple smart answer) + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Tell DVLA you’ve sold, transferred or bought a vehicle (Simple smart answer)' link: https://www.gov.uk/sold-bought-vehicle -contentDataLink: + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. +contentDataLink: #Delete this comment before entering Content Data URL assocaited with this frontend template. + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. +contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. + title: #Delete this comment before entering the name of the content schema. + link: #Delete this comment before entering the developer docs URL of this content schema. + +contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. + title: #Delete this comment before entering the name of the content type (also known as document type). + link: #Delete this comment before entering the developer docs URL of this content type/document type. + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + #Delete this comment before entering the name of the publishing app. + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + #Delete this comment before entering the name of the rendering app. + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. +components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #Delete this comment before entering the name of the component used within this pattern. + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + # Delete this comment before enter how this component is generated on the page. + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. description: - date: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: -githubIssueLink: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/smart-answer/simple-smart-answer.md b/docs/frontend-templates/smart-answer/simple-smart-answer.md index 3144582..8a0962e 100644 --- a/docs/frontend-templates/smart-answer/simple-smart-answer.md +++ b/docs/frontend-templates/smart-answer/simple-smart-answer.md @@ -1,13 +1,40 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Smart answer + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Simple smart answer + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. description: A simple smart answer are simple in nature and is can be built and managed by publishers. -figmaLink: + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - " A simple smart answer presents the end-user a series of questions that channels them to a certain outcome based on their responses. + 'A simple smart answer presents the end-user a series of questions that channels them to a certain outcome based on their responses. Simple smart answers are built and edited in Mainstream Publisher. @@ -16,111 +43,343 @@ howItWorks: We use this format if the tool doesn’t need any complicated variables or calculations. - You don’t need a developer to make changes to a simple smart answer. They’re built and edited in Mainstream Publisher, so they follow the same workflow as any other piece of mainstream content." + You don’t need a developer to make changes to a simple smart answer. They’re built and edited in Mainstream Publisher, so they follow the same workflow as any other piece of mainstream content.' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: Tell DVLA you've sold, transferred or bought a vehicle + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Tell DVLA you’ve sold, transferred or bought a vehicle' link: https://www.gov.uk/sold-bought-vehicle + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 1: - title: Contact UK Visas and Immigration for help + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Contact UK Visas and Immigration for help' link: https://www.gov.uk/contact-ukvi-inside-outside-uk + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 2: - title: Contact DVLA + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Contact DVLA' link: https://www.gov.uk/contact-the-dvla + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. contentDataLink: https://content-data.publishing.service.gov.uk/content?submitted=true&date_range=past-30-days&search_term=&document_type=simple_smart_answer&organisation_id=all + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: simple_smart_answer link: https://docs.publishing.service.gov.uk/content-schemas/simple_smart_answer.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: simple_smart_answer link: https://docs.publishing.service.gov.uk/document-types/simple_smart_answer.html -publishingApp: mainstream publisher -renderingApp: frontend + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + mainstream publisher + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + frontend + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Contextual breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Contextual breadcrumbs' componentURL: https://components.publishing.service.gov.uk/component-guide/contextual_breadcrumbs - generated: auto - input: Tagging > Breadcrumb + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Tagging > Breadcrumb' 2: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: publisher - input: Title + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Title' 3: - componentName: Govspeak content + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Govspeak content' componentURL: https://components.publishing.service.gov.uk/component-guide/govspeak - generated: publisher - input: Body + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Body' 4: - componentName: Button + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Button' componentURL: https://components.publishing.service.gov.uk/component-guide/button - generated: publisher - input: Start button text + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Start button text' 5: - componentName: Title for each question is using [Form radio button with page heading and caption](https://components.publishing.service.gov.uk/component-guide/radio/with_page_heading_and_caption) component - componentURL: - generated: publisher - input: Question[i] > Title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Title for each question is using [Form radio button with page heading and caption](https://components.publishing.service.gov.uk/component-guide/radio/with_page_heading_and_caption) component' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Question[i] > Title' 6: - componentName: "[Govspeak content](https://components.publishing.service.gov.uk/component-guide/govspeak) is used to provide extra information for each question in the smart answer" - componentURL: - generated: publisher - input: Question[i] > Optional extra information + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Govspeak content](https://components.publishing.service.gov.uk/component-guide/govspeak) is used to provide extra information for each question in the smart answer' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Question[i] > Optional extra information' 7: - componentName: "[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual footer](https://components.publishing.service.gov.uk/component-guide/contextual_footer)" - componentURL: - generated: publisher - input: Tagging > Mainstream browse pages + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual footer](https://components.publishing.service.gov.uk/component-guide/contextual_footer)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Tagging > Mainstream browse pages' 8: - componentName: "[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)" - componentURL: - generated: publisher - input: Tagging > Related content items + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Tagging > Related content items' 9: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 10: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 11: - componentName: "[Form radio button](https://components.publishing.service.gov.uk/component-guide/radio) can be used in order for end-user to provide their respone" - componentURL: - generated: publisher - input: Question[i] > Answer[i] + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Form radio button](https://components.publishing.service.gov.uk/component-guide/radio) can be used in order for end-user to provide their respone' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Question[i] > Answer[i]' 12: - componentName: "[Summary list](https://components.publishing.service.gov.uk/component-guide/summary_list) can be used in order for end-user to provide their respone" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Summary list](https://components.publishing.service.gov.uk/component-guide/summary_list) can be used in order for end-user to provide their respone' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 13: - componentName: "[Error summary](https://components.publishing.service.gov.uk/component-guide/error_summary) appears whenever a required field is not entered or the incorrect information is entered by the end-user" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Error summary](https://components.publishing.service.gov.uk/component-guide/error_summary) appears whenever a required field is not entered or the incorrect information is entered by the end-user' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 14: - componentName: "[Step by step navigation](https://components.publishing.service.gov.uk/component-guide/step_by_step_nav) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)" - componentURL: - generated: publisher - input: "[collections-publisher](https://docs.publishing.service.gov.uk/repos/collections-publisher.html) > Where to show this step by step > Sidebar settings > Sidebar content of page" + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Step by step navigation](https://components.publishing.service.gov.uk/component-guide/step_by_step_nav) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[collections-publisher](https://docs.publishing.service.gov.uk/repos/collections-publisher.html) > Where to show this step by step > Sidebar settings > Sidebar content of page' + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. description: - date: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: -githubIssueLink: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/special-route.md b/docs/frontend-templates/special-route.md index ece8616..af7ce1f 100644 --- a/docs/frontend-templates/special-route.md +++ b/docs/frontend-templates/special-route.md @@ -1,74 +1,244 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Frontend templates + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Special route -description: "Special route frontend templates can perform an array of specific end-user tasks. That may include: finding information about a local council, as well as help users use and navigate GOV.UK itself" -figmaLink: + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. +description: 'Special route frontend templates can perform an array of specific end-user tasks. That may include: finding information about a local council, as well as help users use and navigate GOV.UK itself' + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - "Special route frontend templates are unique pages that are hardcoded by developers that publishes special routes to the Publishing API on behalf of other apps. + 'Special route frontend templates are unique pages that are hardcoded by developers that publishes special routes to the Publishing API on behalf of other apps. + + Any changes, including content, will require developer involvment.' - Any changes, including content, will require developer involvment." +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: Find your local council + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Find your local council' link: https://www.gov.uk/find-local-council + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 1: - title: Find contact details for services + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Find contact details for services' link: https://www.gov.uk/contact + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 2: - title: Help using GOV.UK + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Help using GOV.UK' link: https://www.gov.uk/help + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. contentDataLink: https://content-data.publishing.service.gov.uk/content?submitted=true&date_range=past-30-days&search_term=&document_type=special_route&organisation_id=all + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: special_route link: https://docs.publishing.service.gov.uk/content-schemas/special_route.html -contentType: + +contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: special_route link: https://docs.publishing.service.gov.uk/document-types/special_route.html -publishingApp: special route publisher + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + #Delete this comment before entering the name of the publishing app. + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + #Delete this comment before entering the name of the rendering app. + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Contextual breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Contextual breadcrumbs' componentURL: https://components.publishing.service.gov.uk/component-guide/contextual_breadcrumbs - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 2: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: hardcode + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 3: - componentName: "[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)" - componentURL: - generated: hardcode + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + hardcode input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 4: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 5: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. description: - date: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: -githubIssueLink: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/step-by-step-nav.md b/docs/frontend-templates/step-by-step-nav.md index cd8d9e0..a39a7cb 100644 --- a/docs/frontend-templates/step-by-step-nav.md +++ b/docs/frontend-templates/step-by-step-nav.md @@ -1,13 +1,40 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Frontend templates + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Step by step nav + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. description: Step by step is primarily navigation and not a content format. It’s not designed to replace or compete with guidance. -figmaLink: + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - "Use step by step navigation to represent end-to-end journeys that: + 'Use step by step navigation to represent end-to-end journeys that: - have specific start and end points @@ -37,71 +64,223 @@ howItWorks: We wouldn’t create a step by step to help users decide what kind of visa to apply for because it’s not a linear journey, it’s just a collection of options. But we could create one about what to do to come to the UK to study, and one of the tasks might be about finding the right visa to apply for. - We wouldn’t create a step by step for teachers on how to manage their workload because because it’s made up of a collection of related tasks. It’s not a linear journey with a start and an end." + We wouldn’t create a step by step for teachers on how to manage their workload because because it’s made up of a collection of related tasks. It’s not a linear journey with a start and an end.' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: "Get Tax-Free Childcare: step by step" + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Get Tax-Free Childcare: step by step' link: https://www.gov.uk/get-tax-free-childcare + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 1: - title: "Tell DVLA you've changed address: step by step" + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Tell DVLA you’ve changed address: step by step' link: https://www.gov.uk/tell-dvla-changed-address + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 2: - title: "Set up a limited company: step by step" + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Set up a limited company: step by step' link: https://www.gov.uk/set-up-limited-company + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. contentDataLink: https://content-data.publishing.service.gov.uk/content?submitted=true&date_range=past-30-days&search_term=&document_type=step_by_step_nav&organisation_id=all + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: step_by_step_nav link: https://docs.publishing.service.gov.uk/content-schemas/step_by_step_nav.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: step_by_step_nav link: https://docs.publishing.service.gov.uk/document-types/step_by_step_nav.html -publishingApp: collections publisher -renderingApp: collections + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + collections publisher + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + collections + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Breadcrumbs' componentURL: https://components.publishing.service.gov.uk/component-guide/breadcrumbs - generated: auto - input: Tags > taken to [content tagger](https://docs.publishing.service.gov.uk/repos/content-tagger.html) > Primary mainstream browse page + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Tags > taken to [content tagger](https://docs.publishing.service.gov.uk/repos/content-tagger.html) > Primary mainstream browse page' 2: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: publisher - input: Title (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Title (required)' 3: - componentName: Govspeak content + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Govspeak content' componentURL: https://components.publishing.service.gov.uk/component-guide/govspeak - generated: publisher - input: Introduction (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Introduction (required)' 4: - componentName: Step by step navigation + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Step by step navigation' componentURL: https://components.publishing.service.gov.uk/component-guide/step_by_step_nav - generated: auto - input: Steps > Step title (required) + Step label + Content, tasks and links + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Steps > Step title (required) + Step label + Content, tasks and links' 5: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 6: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. description: - date: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: - link: -githubIssueLink: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/topical-events/about.md b/docs/frontend-templates/topical-events/about.md index 9489afc..97cbceb 100644 --- a/docs/frontend-templates/topical-events/about.md +++ b/docs/frontend-templates/topical-events/about.md @@ -1,84 +1,305 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Topical events + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: About page -description: The topical event about page provides detailed information on what the government is doing about said topical event. + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. +description: 'The topical event about page provides detailed information on what the government is doing about said topical event.' + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - "The topical event about page is a child to the [Topical event frontend template](../../topical-events). For example: + 'The topical event about page is a child to the [Topical event frontend template](../../topical-events). For example: - - [The UK government's response to the Russian invasion of Ukraine](https://www.gov.uk/government/topical-events/russian-invasion-of-ukraine-uk-government-response/about) (child) + - [The UK government’s response to the Russian invasion of Ukraine](https://www.gov.uk/government/topical-events/russian-invasion-of-ukraine-uk-government-response/about) (child) - - [Russian invasion of Ukraine: UK government response](https://www.gov.uk/government/topical-events/russian-invasion-of-ukraine-uk-government-response) (parent)" + - [Russian invasion of Ukraine: UK government response](https://www.gov.uk/government/topical-events/russian-invasion-of-ukraine-uk-government-response) (parent)' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: European Political Community meeting 2024 + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'European Political Community meeting 2024' link: https://www.gov.uk/government/topical-events/european-political-community-meeting-2024/about + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 1: - title: The UK government's response to the Russian invasion of Ukraine + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'The UK government’s response to the Russian invasion of Ukraine' link: https://www.gov.uk/government/topical-events/russian-invasion-of-ukraine-uk-government-response/about + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 2: - title: UK action to combat Daesh + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'UK action to combat Daesh' link: https://www.gov.uk/government/topical-events/daesh/about -contentDataLink: https://content-data.publishing.service.gov.uk/content?submitted=true&date_range=past-30-days&search_term=&document_type=topical_event_about_page&organisation_id=all + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. +contentDataLink: https://content-data.publishing.service.gov.uk/content?submitted=true&date_range=past-30-days&search_term=&document_type=topical_event_about_page&organisation_id=all template. + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: topical_event_about_page link: https://docs.publishing.service.gov.uk/content-schemas/topical_event_about_page.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: topical_event_about_page link: https://docs.publishing.service.gov.uk/document-types/topical_event_about_page.html -publishingApp: whitehall -renderingApp: government frontend + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + whitehall + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + government frontend + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Breadcrumbs' componentURL: ../../../components/breadcrumbs - generated: auto - input: + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 2: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 3: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 4: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: publisher - input: Name (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Name (required)' 5: - componentName: Lead paragraph + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Lead paragraph' componentURL: https://components.publishing.service.gov.uk/component-guide/lead_paragraph - generated: publisher - input: Summary (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Summary (required)' 6: - componentName: Content list with body + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Content list with body' componentURL: https://govuk-government-frontend.herokuapp.com/component-guide/contents_list_with_body - generated: publisher - input: Body (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Body (required)' 7: - componentName: "[Back to top link](https://govuk-government-frontend.herokuapp.com/component-guide/back_to_top) - appears if a [contents list](https://components.publishing.service.gov.uk/component-guide/contents_list) on the page" - componentURL: - generated: auto + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Back to top link](https://govuk-government-frontend.herokuapp.com/component-guide/back_to_top) - appears if a [contents list](https://components.publishing.service.gov.uk/component-guide/contents_list) on the page' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 8: - componentName: Contextual sidebar + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Contextual sidebar' componentURL: https://components.publishing.service.gov.uk/component-guide/contextual_sidebar - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 9: - componentName: Contextual footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Contextual footer' componentURL: https://components.publishing.service.gov.uk/component-guide/contextual_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. +insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. +issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/topical-events/index.md b/docs/frontend-templates/topical-events/index.md index 86d01d7..1744205 100644 --- a/docs/frontend-templates/topical-events/index.md +++ b/docs/frontend-templates/topical-events/index.md @@ -1,12 +1,40 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Frontend templates + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Topical events + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. description: Topical event are used to communicate government activity about high-profile events or in response to a major crisis. + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - "Topical events pages used to communicate government activity about high-profile events or in response to a major crisis. Can be used for an event or crisis that is: + 'Topical events pages used to communicate government activity about high-profile events or in response to a major crisis. Can be used for an event or crisis that is: - of high profile @@ -21,107 +49,343 @@ howItWorks: - likely to generate a high volume of content (not just one or two news stories) - Also worth noting that there may be a corresponding topical event's about page, which is made using the [topical event about frontend template](../about/topical-events)." + Also worth noting that there may be a corresponding topical event’s about page, which is made using the [topical event about frontend template](../about/topical-events).' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: D-Day 80 + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'D-Day 80' link: https://www.gov.uk/government/topical-events/d-day-80 + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 1: - title: Election 2024 + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Election 2024' link: https://www.gov.uk/government/topical-events/election-2024 + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 2: - title: "Russian invasion of Ukraine: UK government response" + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Russian invasion of Ukraine: UK government response' link: https://www.gov.uk/government/topical-events/russian-invasion-of-ukraine-uk-government-response + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. contentDataLink: https://content-data.publishing.service.gov.uk/content?submitted=true&date_range=past-30-days&search_term=&document_type=topical_event&organisation_id=all + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: topical_event link: https://docs.publishing.service.gov.uk/content-schemas/topical_event.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: topical_event link: https://docs.publishing.service.gov.uk/document-types/topical_event.html -publishingApp: whitehall -renderingApp: collections + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + whitehall + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + collections + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Breadcrumbs' componentURL: ../../../components/breadcrumbs - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 2: - componentName: Section break + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Section break' componentURL: https://design-system.service.gov.uk/styles/section-break/ - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 3: - componentName: Heading + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Heading' componentURL: https://components.publishing.service.gov.uk/component-guide/heading - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 4: - componentName: Subscription links + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Subscription links' componentURL: https://components.publishing.service.gov.uk/component-guide/subscription_links - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 5: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 6: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 7: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: publisher - input: Name (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Name (required)' 8: - componentName: Lead paragraph + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Lead paragraph' componentURL: https://components.publishing.service.gov.uk/component-guide/lead_paragraph - generated: publisher - input: Summary (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Summary (required)' 9: - componentName: Govspeak content + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Govspeak content' componentURL: https://components.publishing.service.gov.uk/component-guide/govspeak - generated: publisher - input: Description (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Description (required)' 10: - componentName: Metadata block + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Metadata block' componentURL: https://components.publishing.service.gov.uk/component-guide/metadata - generated: publisher - input: Organisation + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Organisation' 11: - componentName: Share links + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Share links' componentURL: https://components.publishing.service.gov.uk/component-guide/share_links - generated: publisher - input: Social media accounts + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Social media accounts' 12: - componentName: Image card + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Image card' componentURL: https://components.publishing.service.gov.uk/component-guide/image_card - generated: publisher - input: Currently featured + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Currently featured' 13: - componentName: Document list + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Document list' componentURL: https://components.publishing.service.gov.uk/component-guide/document_list - generated: publisher - input: Documents + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Documents' 14: - componentName: "[Organisation logo](https://components.publishing.service.gov.uk/component-guide/organisation_logo) - only appears if lead organisation" - componentURL: - generated: publisher - input: Organisation + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Organisation logo](https://components.publishing.service.gov.uk/component-guide/organisation_logo) - only appears if lead organisation' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Organisation' + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: Research interview about Topical Events & Campaign sites - link: https://app.mural.co/t/govukdelivery7534/m/govukdelivery7534/1674139116917/714724969d90020cd15e1ce41153c4c43fca5101?sender=u5494c2264a5f0c5c71eb1671 - description: - "Mural board with a collection of findings regarding Topical Events and Campaign sites" + # Both title and link are REQUIRED in order for this information to render on the page. date: January 2023 + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + 'Mural board with a collection of findings regarding Topical Events and Campaign sites' + title: 'Research interview about Topical Events & Campaign sites' + link: https://app.mural.co/t/govukdelivery7534/m/govukdelivery7534/1674139116917/714724969d90020cd15e1ce41153c4c43fca5101?sender=u5494c2264a5f0c5c71eb1671 + documentFormat: Mural board + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. +issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/frontend-templates/transaction.md b/docs/frontend-templates/transaction.md index 95c89cd..de8c3f1 100644 --- a/docs/frontend-templates/transaction.md +++ b/docs/frontend-templates/transaction.md @@ -1,110 +1,391 @@ --- +# This file is a template to document a new frontend template within the GOV.UK Publishing Design Guide website. layout: frontend-template-documentation sectionKey: Frontend templates + +# Step 1: Duplicate and rename this file to the proposed frontend template you want to include in the Publishing Design Guide website. +# When duplicating and renaming this file use lowercase and replace any spaces with a dash (ie. -) + +# Step 2: Set "eleventyExcludeFromCollections" to "false". This will ensure that the code snippet is commented out and a page will be display withinin the Publishing Design Guide. +eleventyExcludeFromCollections: false + +# Step 3: Establish the relationship of this frontend template. +# The relationship between frontend templates will be demonstrated visually via levels on the left-hand navigation menu. For instance, "GitHub smart answers" is only revealed when the end-user selects "Smart answer" since "GitHub smart answers" a child template to the "Smart answer" frontend template. eleventyNavigation: + # If this frontend template is not associated with or a child to another frontend template, set the field below ("parent") to "Frontend templates" parent: Frontend templates + +# Step 4: Input data points according to fields below to the best of your ability. Any fields without any data points will not be displayed on the website. + +# Name of the frontend tempalte +# This is the name of the frontend template (ex. Homepage). It is required to display the title on the page, in the meta data, and in the left-hand navigation menu of the frontend templates page. title: Transaction + +# Description of the frontend template +# This briefly describes what the frontend template is. It is required to display the description on the page, and in the meta description. description: Transactions are used to point the user towards an online service, usually on another website. + +# Embedding the figma file of the frontend template +# This will display a Figma embed on the page. +# To add a Figma embed, copy only the URL within the embed snippet. +figmaLink: #Delete this comment before entering the Figma embed URL of the Figma representaiton of this frontend template. + +# How the frontend template works +# Briefly descibe how this frontend template works. For instance, listing out what end-user can do on a page that uses this frontend template, as well as it's relation to other pages and its associated frontend templates on GOV.UK. +# You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). howItWorks: - "The introductory text within the transaction frontend template explains to end users what they are about to experience and what they’ll achieve." + 'The introductory text within the transaction frontend template explains to end users what they are about to experience and what they’ll achieve.' + +# Live examples of webpages that use this frontend template +# List out all the pages on GOV.UK that use this frontend template, by providing: (1) the title of the page, (2) the URL of the page, and (3) indicate whether the page is in Welsh in order for assistive technology to read out the page title correctly. examples: + # To add additional examples duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - title: Sign in to your Universal Credit account + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Sign in to your Universal Credit account' link: https://www.gov.uk/sign-in-universal-credit + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 1: - title: Check the MOT history of a vehicle + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Check the MOT history of a vehicle' link: https://www.gov.uk/check-mot-history + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false 2: - title: Register to vote + # Both title and link are REQUIRED in order for this information to render on the page. + title: 'Register to vote' link: https://www.gov.uk/register-to-vote + welsh: + # Options on whether the webpage using this frontend template is in Welsh: + # true = The webpage is in Welsh + # false = The webpage is not in Welsh, but rather in English + false + +# The Content Data (Production) URL this frontend template +# Filter the document type in content data and copy the URL in your browser's address bar. contentDataLink: https://content-data.publishing.service.gov.uk/content?submitted=true&date_range=past-30-days&search_term=&document_type=transaction&organisation_id=all + +# How is this frontend template built +# This will display all the underlying technologies that make-up this template. contentSchema: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content schema for this frontend template. title: transaction link: https://docs.publishing.service.gov.uk/content-schemas/transaction.html + contentType: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the content type (also known as document type) for this frontend template. title: transaction link: https://docs.publishing.service.gov.uk/document-types/transaction.html -publishingApp: mainstream publisher -renderingApp: frontend + +publishingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify the publishing app associated with adding content to this frontend template. + # Publishing app options: + # collections publisher + # contacts admin + # content publisher + # content tagger + # local links manager + # mainstream publisher + # manuals publisher + # maslow + # service manual publisher + # short url manager + # special route publisher + # specialist publisher + # travel advice publisher + # whitehall + mainstream publisher + +renderingApp: + # The GOV.UK [browser extension](https://github.com/alphagov/govuk-browser-extension) can help indentify which rendering app is used to generate this frontend template. + # Rendring app options: + # collections + # email alert frontend + # feedback + # finder frontend + # frontend + # government frontend + # smart answers + # static + frontend + +# Components that make-up this frontend template +# List out all the components that make-up this frontend template, by (1) providing the name of the component, (2) a link to the documentation for said component, (3) how is this component generated on the page and (4) the associated publishing input fields within the publishing app. components: + # To add additional components duplicate the the fields below (adhering to the formating) but increase the count by one integer. 0: - componentName: Layout super navigation header + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout super navigation header' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_super_navigation_header - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 1: - componentName: Breadcrumbs + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Breadcrumbs' componentURL: ../../../components/breadcrumbs - generated: auto - input: Breadcrumb + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + Breadcrumb 2: - componentName: Page title + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Page title' componentURL: https://components.publishing.service.gov.uk/component-guide/title - generated: publisher - input: Title (required) + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Title (required)' 3: - componentName: Govspeak content + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Govspeak content' componentURL: https://components.publishing.service.gov.uk/component-guide/govspeak - generated: publisher - input: Introductory paragraph + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Introductory paragraph' 4: - componentName: Govspeak content + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Govspeak content' componentURL: https://components.publishing.service.gov.uk/component-guide/govspeak - generated: publisher - input: Other ways to apply + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Other ways to apply' 5: - componentName: Govspeak content + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Govspeak content' componentURL: https://components.publishing.service.gov.uk/component-guide/govspeak - generated: publisher - input: What you need to know + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'What you need to know' 6: - componentName: Button + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Button' componentURL: https://components.publishing.service.gov.uk/component-guide/button - generated: publisher - input: Radio options (1) Start now & (2) Sign in. Start button text if "start now" selected + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Radio options (1) Start now & (2) Sign in. Start button text if "start now" selected' 7: - componentName: Start now button with info text + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Start now button with info text' componentURL: https://components.publishing.service.gov.uk/component-guide/button/start_now_button_with_info_text - generated: publisher - input: Will continue on + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Will continue on' 8: - componentName: "[Tabs](https://components.publishing.service.gov.uk/component-guide/tabs) - activated when at least two of the corresponding input fields have content inside them" - componentURL: - generated: publisher - input: (1) More information, (2) Other ways to apply and (3) What you need to know + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Tabs](https://components.publishing.service.gov.uk/component-guide/tabs) - activated when at least two of the corresponding input fields have content inside them' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '(1) More information, (2) Other ways to apply and (3) What you need to know' 9: - componentName: Heading + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Heading' componentURL: https://components.publishing.service.gov.uk/component-guide/heading - generated: publisher + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 10: - componentName: Govspeak content + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Govspeak content' componentURL: https://components.publishing.service.gov.uk/component-guide/govspeak - generated: publisher - input: More information + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'More information' 11: - componentName: "[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual footer](https://components.publishing.service.gov.uk/component-guide/contextual_footer)" - componentURL: - generated: publisher - input: Mainstream browse page + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual footer](https://components.publishing.service.gov.uk/component-guide/contextual_footer)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Mainstream browse page' 12: - componentName: "[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)" - componentURL: - generated: publisher - input: Related content items + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Related navigation](https://components.publishing.service.gov.uk/component-guide/related_navigation) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Related content items' 13: - componentName: "[Step by step navigation](https://components.publishing.service.gov.uk/component-guide/step_by_step_nav) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)" - componentURL: - generated: publisher - input: "[collections-publisher](https://docs.publishing.service.gov.uk/repos/collections-publisher.html) > Where to show this step by step > Sidebar settings > Sidebar content of page" + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[Step by step navigation](https://components.publishing.service.gov.uk/component-guide/step_by_step_nav) when displayed within [contextual sidebar](https://components.publishing.service.gov.uk/component-guide/contextual_sidebar)' + componentURL: #If a URL is not entered in the field above (componentName) then delete this comment before entering the URL of the documentation for said component. + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + publisher + input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + '[collections-publisher](https://docs.publishing.service.gov.uk/repos/collections-publisher.html) > Where to show this step by step > Sidebar settings > Sidebar content of page' 14: - componentName: Feedback + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Feedback' componentURL: https://components.publishing.service.gov.uk/component-guide/feedback - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. 15: - componentName: Layout footer + # The componentName is REQUIRED in order for this information to be displayed on the page. + componentName: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + 'Layout footer' componentURL: https://components.publishing.service.gov.uk/component-guide/layout_footer - generated: auto + generated: + # Options how said component is generated page: + # auto = "Autogenerated in frontend template" + # publisher = "Customized by publisher" + # hardcode = "Hardcoded by developer" + auto input: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. + #If this component can be generated by a publisher via a publihing app the delete this comment before entering that infomration. + +# Evidence and insights for this frontend template +# List out all past documentation/supporting material with regards to or realted to this frontend template. It can include (1) past design documentation, (2) research findings, and (3) presentations. +insights: + # To add additional insights duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order for this information to render on the page. + date: #Delete this comment before entering the date when the document was published. + description: + # You MUST wrap this in single quotation marks (ie. ' '), since markdown can be used to enter this information. To create a heading, use three hashes (ie. ###). + #Delete this comment before entering a brief summary about the document being referred. + title: #Delete this comment before entering the name of the insight document. + link: #Delete this comment before entering the URL of the insight document. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. + +# How to report an issue with this frontend template +# This will display instrucions on how to report an issue via GitHub. +# Consult with a developer to confirm the GitHub where the frontend template's codebase exists. +githubIssueLink: #Delete this comment before entering the URL of the page to create a new GitHub issue. + +# Existing issues with this frontend template +# List of all the issues that are associated with this frontend template, (1) containing the title used to describe the issue on GitHub, and (2) the link to the GitHub issue itself. +issues: + # To add additional issues duplicate the the fields below (adhering to the formating) but increase the count by one integer. + 0: + # Both title and link are REQUIRED in order to display this information on the page. + title: #Delete this comment before entering the title of the GitHub issue. + link: #Delete this comment before entering the URL of the corresponding GitHub issue. --- \ No newline at end of file diff --git a/docs/patterns/*patterns-documentation-template.md b/docs/patterns/*patterns-documentation-template.md index bdd1d1d..818c2c0 100644 --- a/docs/patterns/*patterns-documentation-template.md +++ b/docs/patterns/*patterns-documentation-template.md @@ -70,7 +70,7 @@ insights: #Delete this comment before entering a brief summary about the document being referred. title: #Delete this comment before entering the name of the insight document. link: #Delete this comment before entering the URL of the insight document. - documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Doc, (2) Google Sheets, and (3) Google Slides. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. # Accessibilty criteria for this pattern # List out the accessibility for this pattern. diff --git a/docs/patterns/search-filter.md b/docs/patterns/search-filter.md index 3166f0c..bfab006 100644 --- a/docs/patterns/search-filter.md +++ b/docs/patterns/search-filter.md @@ -101,7 +101,7 @@ insights: #Delete this comment before entering a brief summary about the document being referred. title: #Delete this comment before entering the name of the insight document. link: #Delete this comment before entering the URL of the insight document. - documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Doc, (2) Google Sheets, and (3) Google Slides. + documentFormat: #Delete this comment before entering the format of the insight document. Example: (1) Google Docs, (2) Google Sheets, and (3) Google Slides. # Accessibilty criteria for this pattern # List out the accessibility for this pattern.