New Materials

Publishing Tasks: Phase 1 Submission

New Materials

---

Contents of this page:

• YAML template: original
• YAML template: translation
• Lesson body template
• Notes

---

YAML template: original

---
title: "Lesson Title"
slug: lesson-file-name
layout: lesson
collection: lessons
date: YYYY-MM-DD
authors:
- Forename Surname
- Forename Surname
reviewers:
- Forename Surname
- Forename Surname
editors:
- Forename Surname
review-ticket: https://github.com/programminghistorian/ph-submissions/issues/XXX
difficulty: 3
activity: analyzing
topics: [python, data-manipulation]
abstract: Short abstract of this lesson
avatar_alt: Visual description of lesson image
doi: XX.XXXXX/phen0000
---

{% include toc.html %}

YAML template: translation

---
title: "Lesson Title Here"
slug: lesson-file-name-here
original: original-lesson-file-name-here
layout: lesson
collection: lessons
date: YYYY-MM-DD
translation_date: YYYY-MM-DD
authors:
- Forename Surname
- Forename Surname
reviewers:
- Forename Surname
- Forename Surname
editors:
- Forename Surname
translator:
- Forename Surname
- Forename Surname
translation-editor:
- Forename Surname
translation-reviewer:
- Forename Surname
- Forename Surname
review-ticket: https://github.com/programminghistorian/ph-submissions/issues/XXX
difficulty: 2
activity: analyzing
topics: [python, data-manipulation]
abstract: Short abstract of this lesson
avatar_alt: Visual description of lesson image
doi: XX.XXXXX/phen0000
---

{% include toc.html %}

Lesson body template

## Section Title: Use Header Two

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.[^1] Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

<div class="alert alert-info">
Blue information boxes can be created using HTML. We use <a href='https://getbootstrap.com/docs/4.0/components/alerts/'>Bootstrap Alerts</a> formatting.
</div>

<div class="alert alert-warning">
Yellow warning boxes can be created using HTML. We use <a href='https://getbootstrap.com/docs/4.0/components/alerts/'>Bootstrap Alerts</a> formatting. 
</div>

Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

{% include figure.html filename="file-name-1.png" alt="Visual description of figure image" caption="Figure 1. Caption text to display" %}

{% include youtube.html video_id="VIDEO_ID" %}

### Subsection Title: Use Header Three

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.[^2] Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.[^3]

| Column | Column   | Column | Column |
|--------|----------|--------|--------|
| Row 1  | content  | TRUE   | 1      |
| Row 2  | content  | TRUE   | 2      |
| Row 3  | content  | TRUE   | 3      |


## Section Title: Use Header Two

Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur `inline code is created within single backticks`. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.[^4]

{% include figure.html filename="file-name-2.png" alt="Visual description of figure image" caption="Caption text to display" %}

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua:


Code blocks are created with three backticks above ```, and three backticks below ```.

## Endnotes

[^1]: Note1 Use [Chicago Manual of Style](https://www.chicagomanualofstyle.org/tools_citationguide/citation-guide-1.html) to format endnotes.    
[^2]: Note2 This [practical guide from the University of York](https://subjectguides.york.ac.uk/referencing-style-guides/chicago) is useful.  
[^3]: Note3  
[^4]: Note4 with bullet points
    - Bullet 1
    - Bullet 2
    - Bullet 3 (indented by 4 spaces)

Notes

1. The slug: needs to match the lesson-file-name exactly

2. The date: is the date of publication. The translation_date: is the date of publication of the translation.

3. The difficulty: is either 1, 2 or 3. difficulty: 1 =Beginner; difficulty: 2 =Intermediate; difficulty: 3 =Advanced.

4. The activity: field is completed with one of the following words: acquiring, transforming, analyzing, presenting, sustaining

5. The topic: field is completed using a choice of topics from those listed in /jekyll/_data/topics.yml. Topics need to be enclosed within square brackets. Topic names cannot include spaces, so use hyphens instead: data-manipulation. More than one topic can be chosen, simply separate with commas: [lod, data-manipulation]

6. If the lesson uses formulas, add another field to the YAML mathjax: true so that mathematical formulas will display correctly. Formulas must be bracketed using $$ on either side. To display them in-line, we simply write the $$FORMULA$$ in the sentence. If they are to appear as blocks in the page centre, we add a line break and spaces:

$$ FORMULA $$

LaTeX cannot always be written using the symbols on the keyboard – for example, the | vertical bar must be written using \vert. It's best to always check LaTeX documentation or translation.

7. This is how to add sequence logic to the YAML:

sequence: 1
next: lesson-file-name-here
series_total: 2 lessons

8. This is how to add partnership logic to the YAML:

lesson-partners: [Jisc, The National Archives]
partnership-url: /jisc-tna-partnership

Choose the URL appropriate to the language you are publishing in:

partnership-url: /es/jisc-tna-colaboracion
partnership-url: /fr/jisc-tna-partenariat
partnership-url: /pt/jisc-tna-parceria

9. This is how to solve a problem that occurs where there are elements (links or images) interrupt a numbered sequence. We want the sequence to continue, and the solution is to add a backslash after the number like this: 1\. 2\. etc.

10. To make wide tables scrollable width-ways:

<div class="table-wrapper" markdown="block">
[LINE BREAK]
| Table Columns | 
| ---- |
| Entries |
[LINE BREAK]
</div>

11. All figures must be accompanied by descriptive alt-text and concise captions. We use liquid syntax following this format:

{% include figure.html filename="file-name-1.png" alt="Visual description of figure image" caption="Figure 1. Caption text to display" %}

12. "Straight quotation marks" cannot be included anywhere inside alt-text or captions. They disrupt the code, making it unclear where the liquid syntax begins and ends. The work-around is to add a backslash in front of each \" within the alt-text or caption, like this:

{% include figure.html filename="file-name-1.png" alt="Visual description of figure image" caption="Figure 1. Caption text including a \"quotation\" to display" %}

Adding \ in front of the " is called 'escaping' the quotations marks. That means instructing the code to ignore them as liquid syntax or active code, and simply display them as written.

However, in my experience this doesn't always work. The alternative is to replace with angled quotation marks, or 'single quotation marks'.