diff --git a/archetypes/article.md b/archetypes/article.md new file mode 100644 index 0000000..521e033 --- /dev/null +++ b/archetypes/article.md @@ -0,0 +1,52 @@ +--- +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 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. +14. [ ] Delete this section when all is in order. +15. Done! + + \ No newline at end of file diff --git a/archetypes/contributor.md b/archetypes/contributor.md new file mode 100644 index 0000000..81ee88f --- /dev/null +++ b/archetypes/contributor.md @@ -0,0 +1,23 @@ +--- +title: "{{ replace .Name "-" " " | title }}" +date: "{{.Date}}" +author: "file-creator-put-your-name-here" +affiliation: "Some affiliation if applicable" +draft: true +--- + +**{{ replace .Name "-" " " | title }}** is .... + +contact: something at something dot edu + +# Instructions for issue-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: + - 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. diff --git a/archetypes/editor.md b/archetypes/editor.md new file mode 100644 index 0000000..4ea7b90 --- /dev/null +++ b/archetypes/editor.md @@ -0,0 +1,24 @@ +--- +title: "{{ replace .Name "-" " " | title }}" +date: "{{.Date}}" +author: "file-creator-put-your-name-here" +affiliation: "Some affiliation if applicable" +draft: true +--- + + +**{{ replace .Name "-" " " | title }}** is .... + +contact: something at something dot edu + +# Instructions for issue-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: + - 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. \ No newline at end of file diff --git a/archetypes/issue.md b/archetypes/issue.md new file mode 100644 index 0000000..4c38972 --- /dev/null +++ b/archetypes/issue.md @@ -0,0 +1,55 @@ +--- +title: "{{ replace .Name "-" " " | title }}" +date: "{{.Date}}" +author: "file-creator-put-your-name-here" +draft: true +has_articles: ["article-test.md"] +editors: ["jane-editor.md", "joe-editor.md"] +keywords: + - draft +abstract: | + The text of your abstract. (Below is an instruction checklist for issue-file creators/editors) +--- + +# 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: + > `author: "creators-name"` +3. [ ] Set the `title` to the **title of the issue**, as in: + > `title: "Issue 5: What is Game Design Research?"` +4. [ ] Create **entries for issue editors** – if they are not there – and add their bio/info. +5. Add **issue editors** as above (comma separated; inside quotation marks; including extension): + > `editors: ["jane-editor.md", "joe-editor.md"]` +6. [ ] Add **issue keywords** -- if applicable. Follow exact formatting as above, otherwise the site will break. + ``` + keywords: + - keyword one + - keyword two + ``` +7. [ ] Fill the **issue abstract** -- if applicable. Following precise formatting, 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**: go to `content/journal/index.md` and add the name of this file (not title) to the field `has_issues`. Note: articles included in this issue will not appear unless this is parented to the journal item. Example: + > `has_issues: ["this-issues-file-name.md"]` +10. [ ] **Add issue-editorial text** below this section. +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. +15. [ ] Delete this section when all is in order. +16. Done! + + + \ No newline at end of file diff --git a/archetypes/journal.md b/archetypes/journal.md new file mode 100644 index 0000000..1e3fcf0 --- /dev/null +++ b/archetypes/journal.md @@ -0,0 +1,14 @@ +--- +title: "{{ replace .Name "-" " " | title }}" +date: "{{.Date}}" +author: "editor-put-your-name-here" +draft: true +has_issues: [] +keywords: + - draft +abstract: | + The text of your abstract. Probably this doesn't apply to a journal item. +--- + + +**Attention: You shouldn't be making a new `journal` item!!! Except if you are experimenting.** \ No newline at end of file diff --git a/archetypes/print.md b/archetypes/print.md new file mode 100644 index 0000000..33433e2 --- /dev/null +++ b/archetypes/print.md @@ -0,0 +1,23 @@ +--- +title: "{{ replace .Name "-" " " | title }}" +date: "{{.Date}}" +author: "editor-put-your-name-here" +draft: true +print: "article/article-test.md" +--- + +