jgdr/content/article/sample-article.md

126 lines
3.6 KiB
Markdown
Raw Normal View History

2023-07-12 02:00:07 +03:00
---
title: "Sample Article ⚫"
2023-07-12 02:00:07 +03:00
date: "2023-06-30T00:36:18+03:00"
author: "anybody"
contributors: ["jane-contributor.md"]
draft: false
keywords:
- sample article
- journal info
- guide
- draft
2023-07-12 02:00:07 +03:00
abstract: |
The text of your abstract. Max length..?
---
# Introduction
This is a sample article for submissions.
2023-07-15 16:39:43 +03:00
Contributions are natively processed in Markdown format. For a guide for writing in Markdown see ![Markdown guide](article:markdown-formatting), and ![Markdown bibliography workflow](article:md-workflow).
2023-07-12 02:00:07 +03:00
However, one can also submit in conventional word processor formats (DOCX, ODT).
# Submission sample package
[Download submission sample](/sample/dummy-package/dummy-package.txt).
# Main fields
## Title
> ! Capitalization conventions?
## Abstract
Abstract is to be included in the header file.
If the submission is not provided in Markdown format, clearly mark and place the Abstract *before* the introductory heading of your article.
## Keywords
Add three keywords at minimum.
# Article body
## Headings
Use up to three levels of headings.
> ! Heading capitalization?
## Tables
| Header 1 | Header 2 | Header 3 |
| - |- | - |
| Item 1 | Item 2| Item 3|
| Item 5 | Item 6| Item 7|
2023-07-15 16:39:43 +03:00
<figcaption>Table 1: Sample table.</figcaption>
2023-07-12 02:00:07 +03:00
## Images
Supported image formats are:
- SVG (vector)
- PNG (raster)
- JPG (raster; lossy, thus not preferred)
Place graphics in a subfolder e.g. `graphics/`.
> - What identifier to use ? (Figure / Image/ Graphic?)
> - !Images should appear **before/after** the first mention, and should be referred to in full, as in Figure 1 (not fig. 1).
2023-07-15 16:39:43 +03:00
The examples below use the same graphic exported via Illustrator to:
- SVG (optimized for text; with selectable text) --> 3KB
- PNG (upscaled 3 times: 2100x900; transparent background) --> 56KB
2023-07-12 02:00:07 +03:00
2023-07-15 16:39:43 +03:00
![Figure 1: Sample illustration in SVG (vector format).](/sample/graphics/jgdr-test-illustration.svg "(Optional mouse-over text description) This is a SVG vector image.")
![Figure 2: Sample illustration in PNG (raster format); tansparent background; export resolution x3.](/sample/graphics/jgdr-test-illustration-3x.png "(Optional mouse-over text description) This a PNG raster image.")
2023-07-12 02:00:07 +03:00
2023-07-15 16:39:43 +03:00
*Note: to view the full resolution version of an image (web version), right click on an image and select "Open image in new tab". Note also that the text of the SVG graphic is selectable.*
2023-07-15 16:39:43 +03:00
# Citations [??]
[Zotero]: https://www.zotero.org/ "free and open source, cross-platform citation management software."
2023-07-15 16:39:43 +03:00
For a guide on how to incorporate bibliographic citations in Markdown see ![Markdown workflow](article:md-workflow). We recommend the use of [Zotero][].
- > Citation style: Chicago?
2023-07-12 02:00:07 +03:00
## Quotes
> Block quotes are used for quotations that are 40 words or more, and are followed by a reference (Author 2015).
For shorter quotations, use in-line quotes, as in "this is a quotation" (Author 2015).
# Conclusion
Checklist:
- [ ] Consistent use of EN/US English.
- [ ] Submission has been proof read.
- [ ] Included graphics are provided in a subfolder.
- [ ] The contribution is anonymized.
2023-07-15 16:39:43 +03:00
For Markdown submissions, submit a zip file including:
2023-07-12 02:00:07 +03:00
- A Markdown file of the article.
- Bibliography included in the Markdown file, or in extra `.bib` file.
2023-07-15 16:39:43 +03:00
- A subfolder including all images (e.g. `graphics/`).
Provide necessary artifacts either
- via link to a drive or repository, or
- include them in full as separate `zip` files.
2023-07-12 02:00:07 +03:00
# References
2023-07-15 16:39:43 +03:00
Compile a sample list of references for:
- book
- book chapter
- conference paper
- journal paper
- website / blog / news post
- film
- Youtube/vimeo video
- presentation
- repository
- artifact
- and for games
2023-07-12 02:00:07 +03:00