we/jgdr
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

finalized edits of archetypes and archetype issue

Browse source
This commit is contained in:
constantinos 2023-08-02 16:45:14 +03:00
parent fb7a5baeb7
commit 9c5972bb17
12 changed files with 110 additions and 118 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
archetypes/article.md
View file

@ -9,13 +9,11 @@ keywords:
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:
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"`
@ -30,14 +28,14 @@ abstract: |
- keyword one
- keyword two
```
7. [ ]  Fill the **abstract**. Following precise formatting, otherwise the site will break.
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. <!-- anthing inside these symbols will be hidden -->
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!

15
archetypes/contributor.md
View file

@ -9,15 +9,14 @@ draft: true
**{{ replace .Name "-" " " | title }}** is ....
contact: something at something dot edu
# Instructions for contributor-file creator/editor
# Instructions for contributor-file creator/editor:
- Filename should follow the convention: name-surname.md
- Insert your own name at the 'author' field.
- Set affiliation if applicable.
- Fill in content:
- **Filename** should follow the convention:` name-surname.md`
- File creator insert **your own name** in the `author` field.
- Set **affiliation** if applicable (`affiliation: "Some University"`)
- Fill in **content**:
- bio
- contact email
- Delete this section.
- Set draft flag (note that `draft: false` will make this entry public).
- Git commit and push your changes if/when applicable, providing a commit message describing your changes.
- Set **draft flag** (note that `draft: false` will make this entry public).
- Git **commit and push your changes if/when applicable**, providing a commit message describing your changes.

14
archetypes/editor.md
View file

@ -11,14 +11,14 @@ draft: true
contact: something at something dot edu
# Instructions for editor-file creator/editor:
# Instructions for editor-file creator/editor
- Filename should follow the convention: name-surname.md
- Insert your own name at the 'author' field.
- Set affiliation if applicable.
- Fill in content:
- **Filename** should follow the convention: `name-surname.md`
- File creator insert **your own name** in the `author` field.
- Set **affiliation** if applicable (`affiliation: "Some University"`)
- Fill in **content**:
- bio
- contact email
- Delete this section.
- Set draft flag (note that `draft: false` will make this entry public).
- Git commit and push your changes if/when applicable, providing a commit message describing your changes.
- Set **draft flag** (note that `draft: false` will make this entry public).
- Git **commit and push your changes if/when applicable**, providing a commit message describing your changes.

8
archetypes/issue.md
View file

@ -12,12 +12,11 @@ abstract: |
---
# Instructions for issue-file creator/editor:
0. [x]  Put a checkmark to all items of this list that have been completed by changing:
> `1. [ ]` to `1. [x]`
1. [ ] **File naming**: Follow ![conventions for issue file-naming](article:int-conventions). Example:
> `issue-5.md`
2. (File editor) **Insert your name** in the `author` field inside "quotation marks" as in:
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 issue**, as in:
> `title: "Issue 5: What is Game Design Research?"`
@ -30,7 +29,7 @@ abstract: |
- keyword one
- keyword two
```
7. [ ] Fill the **issue abstract** -- if applicable. Following precise formatting, otherwise the site will break.
7. [ ] Fill the **issue abstract** -- if applicable. Follow exact formatting as above, otherwise the site will break.
8. [ ] **Add the articles included in the issue** as above (comma separated; inside quotation marks; including extension):
> `has_articles: ["article-test.md", "article-2.md", "article-3.md"]`
9. [ ] **Parent issue to journal**
@ -40,11 +39,10 @@ abstract: |
11. [ ] **Log potential problems or pending tasks** with this issue by making another check-list below (commented sample lists provided below).
12. [ ] **Git commit and push if/when applicable**, providing a commit message describing your changes.
13. [ ] **Set the draft flag** accordingly. *False will make this public*: only do that when ready to publish, and when there is already a 'print' file for the issue. Leave `draft: true` when in-progress.
14. [ ] Feel free to put this block inside comments, to be able to view the actual content properly. <!-- anything inside these symbols will be hidden -->
14. [ ] Feel free to put this block inside comments, to be able to view the actual content properly.
15. [ ] Delete this section when all is in order.
16. Done!
<!-- Editor's checklist temp
To do:
- [ ] Task 1

4
archetypes/journal.md
View file

@ -1,7 +1,7 @@
---
title: "{{ replace .Name "-" " " | title }} ⚫ ☮"
date: "{{.Date}}"
author: "editor-put-your-name-here"
author: "file-creator-put-your-name-here"
draft: true
has_issues: []
keywords:
@ -11,4 +11,4 @@ abstract: |
---
**Attention: You shouldn't be making a new `journal` item!!! Except if you are experimenting.**
**Attention: You shouldn't be making a new `journal` item!!! Except if you really know what you are doing.**

25
archetypes/print.md
View file

@ -1,23 +1,26 @@
---
title: "{{ replace .Name "-" " " | title }} ⚫ ✉"
title: "{{ replace .Name "-" " " | title }} ⚫ 🖶"
date: "{{.Date}}"
author: "editor-put-your-name-here"
author: "file-creator-put-your-name-here"
draft: true
print: "article/sample-article.md"
---
<!--
Instructions to file creator:
Filename:
0. File naming: If this concerns an issue, say issue-5.md, name this file p-issue-5.md. If this concerns an article say article-title.md, name this file p-article-title.md
TOML Fields
1. Put your name at the field author inside "quotation marks" as in-> author: "creators-name"
2. Set the title to:
File naming
1. If this concerns an issue, say `issue-5.md`, name this file `p-issue-5.md`. If this concerns an article say `article-title.md`, name this file `p-article-title.md`
YAML Fields
1. Put **your name** in the field `author` inside "quotation marks" as in->`author: "creators name"`
2. Set the **title** to:
1. Issue X Print (for issues, where X is the issue number or name)
2. Article title Print (for articles)
3. Set the correct print destination (e.g. "issue/issue-x.md" or "article/article-name.md"). ERRORS WILL BREAK THE SITE.
4. Set the draft flag accordingly (false will make this public)
3. Set the correct **print destination** (e.g. "issue/issue-x.md" or "article/article-name.md"). ERRORS WILL BREAK THE SITE.
4. Set the **draft flag** accordingly (false will make this public)
5. Delete this comment section.
6. Git commit and push your changes if/when applicable, providing a commit message describing your changes.
7. Done!
-->
*Note: Items that are not public/published (`draft: true`), cannot have a public/published print.*
*Note: Print items should not have any content under the YAML header.
-->

17
content/article/int-archetype-article.md
View file

@ -1,31 +1,32 @@
---
title: "New Article Archetype 📑"
date: "2023-07-13T14:15:10+03:00"
author: "file-creator-put-your-name-here"
author: "anybody"
contributors: ["constantinos-miltiadis.md"]
draft: true
keywords:
- archetype
- internal
- guide
abstract: |
This is a copy of the archetype for new articles, and includes instructions for editing and publishing a new `article` item -- copied from `root/archetypes/article.md`
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`
Leave `draft:true`
---
Please follow ![conventions](article:int-conventions) for file names, and instructions for ![new content creation](article:int-content).
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`, and will contain the instruction steps below.
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 publishing new content.
# 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:
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"`
@ -40,14 +41,14 @@ This will create new file at `content/article/article-short-title.md`. The new
- keyword one
- keyword two
```
7. [ ]  Fill the **abstract**. Following precise formatting, otherwise the site will break.
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. <!-- anthing inside these symbols will be hidden -->
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!

46
content/article/int-archetype-contributor.md
View file

@ -2,63 +2,39 @@
title: "New Contributor Archetype 🧜"
date: "2023-07-13T14:15:20+03:00"
author: "anybody"
contributors: ["constantinos-miltiadis.md"]
draft: true
keywords:
- archetype
- internal
- guide
abstract: |
This is a copy of the archetype for contributors (authors), and includes instructions for editing and publishing a new `contributor` item -- copied from `root/archetypes/contributor.md`
This is a copy of the archetype for contributors (authors), and includes instructions for editing and publishing a new `contributor` item, found at `root/archetypes/contributor.md`
Leave `draft:true`
---
Please follow ![conventions](article:int-conventions) for file names, and instructions for ![new content creation](article:int-content).
The Hugo terminal command for creating a new `contributor` is:
```
hugo new contributor/name-surname.md
```
This will create new file at `content/contributor/name-surname.md`. The new file will be created according to the archetype for articles at `root/archetypes/contributor.md`, and will contain the content and instruction steps below.
This will create new file at `content/contributor/name-surname.md`. The new file will be created according to the archetype for articles at `root/archetypes/contributor.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 publishing new content.
---
**Name Surname** is ....
contact: something at something dot edu
# Instructions for contributor-file creator/editor
- Filename should follow the convention: name-surname.md
- Insert your own name at the 'author' field.
- Set affiliation if applicable.
- Fill in content:
- **Filename** should follow the convention:` name-surname.md`
- File creator insert **your own name** in the `author` field.
- Set **affiliation** if applicable (`affiliation: "Some University"`)
- Fill in **content**:
- bio
- contact email
- Delete this section.
- Set draft flag (note that `draft: false` will make this entry public).
- Git commit and push your changes if/when applicable, providing a commit message describing your changes.
keywords:
- keyword one
- keyword two
```
7. [ ]  Fill the **abstract**. Following precise formatting, 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. <!-- anthing inside these symbols will be hidden -->
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
-->
- Set **draft flag** (note that `draft: false` will make this entry public).
- Git **commit and push your changes if/when applicable**, providing a commit message describing your changes.

19
content/article/int-archetype-editor.md
View file

@ -2,13 +2,15 @@
title: "New Editor Archetype ♕"
date: "2023-07-13T14:15:15+03:00"
author: "anybody"
contributors: ["constantinos-miltiadis.md"]
draft: true
keywords:
- archetype
- internal
- guide
abstract: |
This is a copy of the archetype for `editor` items and includes instructions for editing and publishing a new editor item -- copied from `root/archetypes/editor.md`
This is a copy of the archetype for `editor` items and includes instructions for editing and publishing a new editor item, found at `root/archetypes/editor.md`
Leave `draft:true`
---
Please follow ![conventions](article:int-conventions) for file names, and instructions for ![new content creation](article:int-content).
@ -17,7 +19,8 @@ The Hugo terminal command for creating a new `editor` is:
hugo new editor/name-surname.md
```
This will create new file at `content/editor/name-surname.md`. The new file will be created according to the archetype for articles at `root/archetypes/editor.md`, and will contain the content and instruction steps below.
This will create new file at `content/editor/name-surname.md`. The new file will be created according to the archetype for articles at `root/archetypes/editor.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 publishing new content.
---
@ -27,12 +30,12 @@ contact: something at something dot edu
# Instructions for editor-file creator/editor
- Filename should follow the convention: name-surname.md
- Insert your own name at the 'author' field.
- Set affiliation if applicable.
- Fill in content:
- **Filename** should follow the convention: `name-surname.md`
- File creator insert **your own name** in the `author` field.
- Set **affiliation** if applicable (`affiliation: "Some University"`)
- Fill in **content**:
- bio
- contact email
- Delete this section.
- Set draft flag (note that `draft: false` will make this entry public).
- Git commit and push your changes if/when applicable, providing a commit message describing your changes.
- Set **draft flag** (note that `draft: false` will make this entry public).
- Git **commit and push your changes if/when applicable**, providing a commit message describing your changes.

14
content/article/int-archetype-issue.md
View file

@ -2,13 +2,15 @@
title: "New Issue Archetype 📕"
date: "2023-07-13T14:15:05+03:00"
author: "anybody"
contributors: ["constantinos-miltiadis.md"]
draft: true
keywords:
- archetype
- internal
- guide
abstract: |
This is a copy of the archetype for new issues, and includes instructions for editing and publishing a new `issue` item -- copied from `root/archetypes/issue.md`
This is a copy of the archetype for new issues, and includes instructions for editing and publishing a new `issue` item, found at `root/archetypes/issue.md`
Leave `draft:true`
---
Please follow ![conventions](article:int-conventions) for file names, and instructions for ![new content creation](article:int-content).
@ -17,15 +19,14 @@ The Hugo terminal command for creating a new `issue` is:
hugo new issue/issue-5.md
```
This will create new file at `content/issue/issue-5.md`. The new file will be created according to the archetype for articles at `root/archetypes/issue.md`, and will contain the instruction steps below.
This will create new file at `content/issue/issue-5.md`. The new file will be created according to the archetype for articles at `root/archetypes/issue.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 publishing new content.
# Instructions for issue-file creator/editor
0. [x]  Put a checkmark to all items of this list that have been completed by changing:
> `1. [ ]` to `1. [x]`
1. [ ] **File naming**: Follow ![conventions for issue file-naming](article:int-conventions). Example:
> `issue-5.md`
2. (File editor) **Insert your name** in the `author` field inside "quotation marks" as in:
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 issue**, as in:
> `title: "Issue 5: What is Game Design Research?"`
@ -38,7 +39,7 @@ This will create new file at `content/issue/issue-5.md`. The new file will be c
- keyword one
- keyword two
```
7. [ ] Fill the **issue abstract** -- if applicable. Following precise formatting, otherwise the site will break.
7. [ ] Fill the **issue abstract** -- if applicable. Follow exact formatting as above, otherwise the site will break.
8. [ ] **Add the articles included in the issue** as above (comma separated; inside quotation marks; including extension):
> `has_articles: ["article-test.md", "article-2.md", "article-3.md"]`
9. [ ] **Parent issue to journal**
@ -48,11 +49,10 @@ This will create new file at `content/issue/issue-5.md`. The new file will be c
11. [ ] **Log potential problems or pending tasks** with this issue by making another check-list below (commented sample lists provided below).
12. [ ] **Git commit and push if/when applicable**, providing a commit message describing your changes.
13. [ ] **Set the draft flag** accordingly. *False will make this public*: only do that when ready to publish, and when there is already a 'print' file for the issue. Leave `draft: true` when in-progress.
14. [ ] Feel free to put this block inside comments, to be able to view the actual content properly. <!-- anything inside these symbols will be hidden -->
14. [ ] Feel free to put this block inside comments, to be able to view the actual content properly.
15. [ ] Delete this section when all is in order.
16. Done!
<!-- Editor's checklist temp
To do:
- [ ] Task 1

30
content/article/int-archetype-print.md
View file

@ -2,28 +2,40 @@
title: "New Print Archetype 🖶"
date: "2023-07-13T16:03:24+03:00"
author: "anybody"
contributors: ["jane-contributor.md"]
contributors: ["constantinos-miltiadis.md"]
draft: true
keywords:
- archetype
- internal
- guide
abstract: |
This is a copy of the archetype for creating new `print` items, including instructions for creating and properly editing such items -- copied from `root/archetypes/article.md`
This is a copy of the archetype for creating new `print` items, including instructions for creating and properly editing `print` items, found at `root/archetypes/article.md`
Leave `draft:true`
---
Please follow ![conventions](article:int-conventions) for file names, and instructions for ![new content creation](article:int-content).
The Hugo terminal command for creating a new `issue` is:
```
hugo new print/p-issue-5.md
```
This will create new file at `content/print/p-issue-5.md`. The new file will be created according to the archetype for articles at `root/archetypes/print.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 publishing new content.
# Instructions to file creator
Filename:
0. File naming: If this concerns an issue, say issue-5.md, name this file p-issue-5.md. If this concerns an article say article-title.md, name this file p-article-title.md
TOML Fields
1. Put your name at the field `author` inside "quotation marks" as in-> author: "creators-name"
2. Set the title to:
File naming
1. If this concerns an issue, say `issue-5.md`, name this file `p-issue-5.md`. If this concerns an article say `article-title.md`, name this file `p-article-title.md`
YAML Fields
1. Put **your name** in the field `author` inside "quotation marks" as in->`author: "creators name"`
2. Set the **title** to:
1. Issue X Print (for issues, where X is the issue number or name)
2. Article title Print (for articles)
3. Set the correct print destination (e.g. "issue/issue-x.md" or "article/article-name.md"). ERRORS WILL BREAK THE SITE.
4. Set the draft flag accordingly (false will make this public)
3. Set the correct **print destination** (e.g. "issue/issue-x.md" or "article/article-name.md"). ERRORS WILL BREAK THE SITE.
4. Set the **draft flag** accordingly (false will make this public)
5. Delete this comment section.
6. Git commit and push your changes if/when applicable, providing a commit message describing your changes.
7. Done!
*Note: Items that are not public/published (`draft: true`), cannot have a public/published print.*
*Note: Print items should not have any content under the YAML header.*

28
content/issue/int-archetypes.md
View file

@ -12,21 +12,23 @@ abstract: |
Leave `draft:true`
---
Please make sure to follow ![conventions](article:int-conventions) for file names, and instructions for ![new content creation](article:int-content).
Each new item created will have in its title some emojis. These are used to track new items, draft items, WIP items, and items potentially created by mistake.
Each newly created item:
- is set to draft (`draft: true`), meaning that it's not public/published;
- is created after its corresponding archetype (found in `root/archetypes/`);
- includes a list of required steps for preparing the entry for publication (copied in the articles of this isse);
- will have two emojis in its title.[^emj] These are used to track new items, draft items, WIP items, and items potentially created by mistake. Creating a new item will have both the draft emoji ⚫, and the emoji associated with the particular content type, as per the table below:
Creating a new item will have both the draft emoji ⚫, and the emoji associated with the particular content type
| Emoji | Explanation |
| Emoji | Description |
|-|-|
|⚫ | emoji to signal a draft item |
|📕 | default emoji for new issue|
|📑 | default emoji for new article|
|🧜 | default emoji for new contributor|
|♕ | default emoji for new editor |
|🖶 | default emoji for new print |
|⚫| draft/WIP entry (included in all new items; removed only when the article is ready for publishing)|
|📕| new issue entry|
|📑| new article entry|
|🧜| new contributor entry|
|♕| new editor entry |
|🖶| new print entry|
|☮| new journal entry (!do not create new journal entries!)|
<figcaption>Descriptions of emojis placed in the title of new entries.</figcaption>
Emojis found at https://www.compart.com/en/unicode/
[^emj]: Emojis found at https://www.compart.com/en/unicode/