diff --git a/docs/content.md b/docs/content.md index 4382ab2884..7d0c6e8f84 100644 --- a/docs/content.md +++ b/docs/content.md @@ -21,6 +21,7 @@ This documentation aims to be a reference for content editors that want to make * [Accessibility](#accessibility) * [iframe](#iframe) * [Inset text](#inset-text) + * [Creating a partial](#creating-a-partial) * [Details expander for non-UK content](#details-expander-for-non-uk-content) * [YouTube Video](#youtube-video) * [Hero](#hero) @@ -334,6 +335,75 @@ If you need to insert an expander into an erb file: link_url: "/non-uk-teachers/non-uk-qualifications", ) %> ``` +### Creating a partial + +If the content you are creating will be used elsewhere on the site in the exact same format, it may be a good idea to create a partial. This is a snippet of code that you will be able to render in one line. This saves you have having to write the same things again and again. It also means maintenance of the site is easier as any changes you make can be done in one central place rather having to keep track of what information is on what pages. + +To create a partial go to the /app/views/content/shared folder then either select an appropriate file or create your own folder. Then create a file. In the file place the HTML code that you would like to replicate on multiple pages. + +```yaml +
+

Check your qualifications

+

To train to teach in England, you'll need:

+ +

Having relevant A levels can show your subject knowledge, if you do not have a degree in your chosen subject.

+
+ +``` + +Then, when you are working in another HTML file and want to render your code all you have to do is reference the code you created as follows: + +```yaml + <%= render 'content/shared/qualifications-training/check_qualifcations' %> +``` +If you need a specific change across each version of your code such as the subject, it is possible to create a variable. All you have to do is reference something in the frontmatter. In the following frontmatter the subject is chemistry. + +```yaml +title: Become a chemistry teacher +subject: chemistry +title_paragraph: |- +

+ As a chemistry teacher, you'll spark curiosity and challenge young minds to explore the fundamental principles that govern our world. You'll inspire students to question, experiment, and discover, fuelling their passion for science.

+

+ Tax-free bursaries of $bursaries_postgraduate_chemistry$ or scholarships of $scholarships_chemistry$ are available for eligible trainee chemistry teachers.

+description: |- + Find out how to become a chemistry teacher, including what you'll teach and what funding is available to help you train. +layout: "layouts/minimal" +colour: pastel yellow-yellow +image: "static/images/content/hero-images/chemistry.jpg" +keywords: + - chemistry + - teaching chemistry + - teacher training + +content: + - "content/shared/subject-pages/header" + - "content/life-as-a-teacher/explore-subjects/chemistry/article" +``` + +To create a variable that references the frontmatter simply copy the format below. This will look at the frontmatter, then whatever you reference in the square brackets. In this case, it will look for subject and will render chemistry. This can be changed for anything as long as it is referenced in the frontmatter. +```yaml +<%= @front_matter["subject"] %> +``` +This means that you can use the following code over many pages so that each page has its own unique subject rendered. +```yaml +
+

Check your qualifications

+

To train to teach <%= @front_matter["subject"] %> in England, you'll need:

+ +

Having relevant A levels can show your subject knowledge, if you do not have a degree in <%= @front_matter["subject"] %>.

+
+ +``` + + + ### Adviser (CTA) component