Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

New Materials

charlottejmc edited this pageJul 3, 2025 ·32 revisions

Publishing Tasks: Phase 1 Submission

New Materials

Contents of this page:

YAML template: original

---title: "Lesson Title"slug: lesson-file-namelayout: lessoncollection: lessonsdate: YYYY-MM-DDauthors:- Forename Surname- Forename Surnamereviewers:- Forename Surname- Forename Surnameeditors:- Forename Surnamereview-ticket: https://github.com/programminghistorian/ph-submissions/issues/XXXdifficulty: 3activity: analyzingtopics: [python, data-manipulation]abstract: Short abstract of this lessonavatar_alt: Visual description of lesson imagedoi: XX.XXXXX/phen0000---{% include toc.html %}

YAML template: translation

---title: "Lesson Title Here"slug: lesson-file-name-hereoriginal: original-lesson-file-name-herelayout: lessoncollection: lessonsdate: YYYY-MM-DDtranslation_date: YYYY-MM-DDauthors:- Forename Surname- Forename Surnamereviewers:- Forename Surname- Forename Surnameeditors:- Forename Surnametranslator:- Forename Surname- Forename Surnametranslation-editor:- Forename Surnametranslation-reviewer:- Forename Surname- Forename Surnamereview-ticket: https://github.com/programminghistorian/ph-submissions/issues/XXXdifficulty: 2activity: analyzingtopics: [python, data-manipulation]abstract: Short abstract of this lessonavatar_alt: Visual description of lesson imagedoi: XX.XXXXX/phen0000---{% include toc.html %}

Lesson body template

## Section Title: Use Header TwoLorem 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>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>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" %}Links to other sections within the lesson are formatted as outlined below:     - Spaces are replaced with hyphens: [Unfiltered Frequencies](#unfiltered-frequencies)     - Where there are apostrophes, we close the gaps between elided words: [Qu’est-ce que dplyr ?](#quest-ce-que-dplyr)     - [Punctuation marks ? or ! are replaced by hyphens, and & would be replaced by two hyphens] **TBC**Inline icons (small size about the height of a capital letter): ![IconName](http://programminghistorian.github.io/ph-submissions/images/lesson-slug/lesson-slug.png) (or .gif)---> This can be reduced to a relative link `/images/lesson-slug/lesson-slug.png` once staged to Jekyll{% include youtube.html video_id="VIDEO_ID" %}### Subsection Title: Use Header ThreeLorem 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 TwoDuis 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. Theslug: needs to match the lesson-file-name exactly

2. Thedate: is the date of publication. Thetranslation_date: is the date of publication of the translation.

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

4. Theactivity: field is completed withone of the following words:acquiring,transforming,analyzing,presenting,sustaining

5. Thetopic: 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 YAMLmathjax: 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: 1next: lesson-file-name-hereseries_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-colaboracionpartnership-url: /fr/jisc-tna-partenariatpartnership-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 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 thisdoesn't always work. The alternative is to replace with angled quotation marks, or 'single quotation marks'.

13. If the lesson has been tested, add the following two fields to the YAML header:

lesson-testers: Forename Surnametested-date: YYYY/MM/DD

New Wiki (in-progress)

Publishing Tasks

Phase 1 Submission

Phase 6 Sustainability Accessibility

Phase change templates

Communications

Social Media

Bulletin

Events

Call Packages

Administration and Documentation

Members

Internal records

Resource indexes

Lesson Production and Development

Language and Writing

Accessibility

Governance

ProgHist Ltd

Old Wiki

Training

The Ombudsperson Role

Technical Guidance

Editorial Guidance

Social Guidance

Finances

Human Resources

Project Management

Project Structure

Board of Trustees

Clone this wiki locally
[8]ページ先頭
©2009-2025 Movatter.jp