jgdr/archetypes/article.md

50 lines
No EOL
2.4 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: "{{ replace .Name "-" " " | title }} ⚫ 📑"
date: "{{.Date}}"
author: "file-creator-put-your-name-here"
contributors: ["jane-contributor.md"]
draft: true
keywords:
- draft
abstract: |
The text of your abstract. (Below is an instruction checklist for article-file creators/editors)
---
# Instructions for article-file creator/editor:
0. [x] Put a checkmark to all items of this list that have been completed. This, by changing:
> `1. [ ]` to `1. [x]`
1. [ ] **File naming**: Follow ![conventions for article file-naming](article:int-conventions). Example:
> `i5-short-title.md` (where i5 is issue 5)
2. [ ] (File editor) **Insert your name** in the `author` field inside "quotation marks" as in:
> `author: "creators-name"`
3. [ ] Set the `title` to the **title** of the article as in:
> `title: "An Answer to the Question: What is Game Design Research"`
4. [ ] Create **entries for article contributors** -- if they are not there -- and add their bio/info.
5. [ ] **Add the article's author(s)** in the `contributors` field as above (comma separated; inside quotation marks; including extension):
> `contributors: ["jane-contributor.md", "some-other.md"]`
6. [ ] Add **article keywords**. Follow exact formatting as above, otherwise the file/site will break.
```
keywords:
- keyword one
- keyword two
```
7. [ ]  Fill the **abstract** following exact formatting like above, otherwise the site will break.
8. [ ] **Parent article to issue**: go to `content/issue/some-issue.md` and add the name of this file (not title) to the field `has_articles`. Example:
> `has_articles: ["this-articles-file-name.md"]`
9. [ ] **Add article content** text below this section.
10. [ ] **Log potential problems** with this article by making another check-list below (commented sample lists provided below).
11. [ ] **Git commit and push** if/when applicable; providing a commit message describing your changes.
12. [ ] **Set the draft flag** accordingly. **False will make this public**: only do that when ready to publish. Leave `draft: true` when in-progress.
13. [ ] Feel free to put this block inside comments, to be able to view the actual content properly.
14. [ ] Delete this section when all is in order.
15. Done!
<!-- Editor's checklist temp
To do:
- [ ] Task 1
- [ ] Task 2
Issues:
1. Issue 1: Description
2. Issue 2: Description
-->