Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Lesson template #991

Closed
acrymble opened this issue Aug 21, 2018 · 2 comments
Closed

New Lesson template #991

acrymble opened this issue Aug 21, 2018 · 2 comments
Assignees

Comments

@acrymble
Copy link

acrymble commented Aug 21, 2018

#972 update metadata block example, has made me realise we could simplify our author and editor guidelines quite a lot by just offering a template for people to use in new lessons. It could look like this:


title: ["YOUR TITLE HERE"]
collection: lessons
layout: lesson
slug: [LEAVE BLANK]
date: [LEAVE BLANK]
translation_date: [LEAVE BLANK]
authors:
- [FORENAME SURNAME 1]
- [FORENAME SURNAME 2, etc]
reviewers:
- [LEAVE BLANK]
editors:
- [LEAVE BLANK]
translator:
- [FORENAME SURNAME 1]
translation-editor:
- [LEAVE BLANK]
translation-reviewer:
- [LEAVE BLANK]
original: [LEAVE BLANK]
review-ticket: [LEAVE BLANK]
difficulty: [LEAVE BLANK]
activity: [LEAVE BLANK]
topics: [LEAVE BLANK]
abstract: [LEAVE BLANK]
---

# Contents

{% include toc.html %}

# First level heading

[CONTENT HERE. Please write formally, sustainably, and for a global audience.]

## Second level heading - with some examples of formatting

### Font Formatting:
*italic text*
**bold text**
`reserved words or file names` (eg "for loop", or "myData.csv")

### Links:
[a link to *Programming Historian*](http://programminghistorian.org)

### Images:
{% include figure.html filename="IMAGE-FILENAME" caption="Caption to image" %} - see https://programminghistorian.org/en/author-guidelines for more guidance on images.

### A Sample Unordered List

* Fruits
  * Apples
  * Oranges
  * Grapes
* Dairy
  * Milk
  * Cheese

### A Sample Ordered List

1. Finish tutorial
2. Go to grocery store
3. Prepare lunch

###A Sample Table:

| Heading 1 | Heading 2 | Heading 3 |
| --------- | --------- | --------- |
| Row 1, column 1 | Row 1, column 2 | Row 1, column 3|
| Row 2, column 1 | Row 2, column 2 | Row 2, column 3|
| Row 3, column 1 | Row 3, column 2 | Row 3, column 3|

### A Code Block:

Code block


### An End Note:

This is some text.[^1] 
This is some more text.[^2] 



# Endnotes
[^1] Properly formatted citation using Chicago Manual of Style
[^2] Properly formatted citation using Chicago Manual of Style
@acrymble
Copy link
Author

maybe worth having a live preview link on the main site so they can also see what each of these looks like when rendered.

@arojascastro
Copy link
Contributor

arojascastro commented Aug 21, 2018

Good idea! I second the template and yes we need to keep updated the examples found in our guidelines. For tanslations though, we need a original field. See here:

---
title: Análisis de corpus con AntConc
authors:
- Heather Froehlich
date: 2015-11-24
translation_date: 2018-05-04
editors:
- Fred Gibbs
reviewers:
- Nabeel Siddiqui
- Rob Sieczkiewicz
translator:
- Carlos Manuel Varón Castañeda
translation-editor:
- Antonio Rojas Castro
translation-reviewer:
- Jennifer Isasi
- Antonio Rojas Castro
review-ticket: https://github.com/programminghistorian/ph-submissions/issues/170
layout: lesson
original: corpus-analysis-with-antconc
redirect_from: /es/lessons/corpus-analysis-with-antconc
difficulty: 1
activity: analyzing
topics: [distant-reading]
abstract: "El análisis de corpus permite hacer comparaciones a gran escala entre objetos presentes en los textos; es decir, lo que se conoce como lectura distante."
---

I do not think we need a redirect field anymore, right? @mdlincoln

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants