jgdr/content/article/int-archetype-article.md

79 lines
3.4 KiB
Markdown
Raw Normal View History

---
title: "New Article Archetype 📑"
date: "2023-07-13T14:15:10+03:00"
author: "anybody"
contributors: ["constantinos-miltiadis.md"]
2023-08-15 18:47:24 +03:00
draft: false
keywords:
- archetype
- internal
- guide
abstract: |
2023-08-15 18:47:24 +03:00
(INTERNAL) This is a copy of the archetype for new articles, and includes instructions for editing and publishing a new `article` item, found at `root/archetypes/article.md`
---
2023-08-15 18:47:24 +03:00
If creating a new entry via the terminal:
- The Hugo terminal command for creating a new `article` is:
```
hugo new article/article-short-title.md
```
This will create new file at `content/article/article-short-title.md`. The new file will be created according to the archetype for articles at `root/archetypes/article.md`. The new file will be created as a draft (`draft: true`) and will contain the instruction steps below. Please complete all required steps before committing or publishing new content.
2023-08-15 18:47:24 +03:00
If creating a new entry via the online preview page:
- the new entry will be empty. Please use the sample [YAML header below](#yaml) as starting point, and also copy to the new file the [instructions](#instructions) provided below.
# Sample YAML header {#yaml}
2023-08-14 16:45:44 +03:00
```
---
title: "Title sample ⚫ 📑"
date: "2023-07-13T14:15:10+03:00"
author: "file-creator-put-your-name-here"
contributors: ["jane-contributor.md"]
draft: true
keywords:
- draft
abstract: |
The text of your abstract.
---
```
2023-08-15 18:47:24 +03:00
# Instructions for article-file creator/editor {#instructions}
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
-->