Tutorial to write Quarto for Evolv-ED
Basics
This .html
tutorial was built using a Quarto markdown document, which can be accessed from the Files tab above, along with all other template files.
You can build the tutorial with the quarto console application:
quarto render tutorial_template.qmd
Feel free to rename the file to anything you like. See hints here for the amazing set of options for building quarto documents:
The yaml metadata
Quarto documents use yaml
metadata at the front to give some bounds to the document. This document’s metadata are:
---
title: "Tutorial to write Quarto for Evolv-ED"
bibliography: 'references.bib'
author:
- name: Ádám T. Kocsis
orcid: 0000-0002-9028-665X
affiliations:
- name: GeoZentrum Nordbayern, Friedrich-Alexander-Universität Erlangen-Nürnberg, Loewenichstr. 28, D-91054, Erlangen, Germany
toc: true
resources:
- R-4.4.0
- Quarto-1.3.50
- yaml
- html
- bibtex
- pandoc
- Database
format:
html:
embed-resources: true
---
field | What goes there |
---|---|
title |
The title of your tutorial |
bibliography |
The name of the bibliography bibtex file - if used |
author |
Array of authors, see Quarto description for details |
resources |
Array of resources to be tagged |
Linking to resources
Although you could see some examples in this tutorial, in general please refrain from pointing links to the web because the persistence of these links are usually not guaranteed. Linking to the used resources will be taken care of by Evolv-ED internally.
Every resource (software or database) has a unique id, which has to be listed in the resources
field. If a specific version is used to build this tutorial, or if it is known that the tutorial depends on a specific version, it needs to be indicated, separating the version number with a hyphen:
resourceID-versionNumber
Software and data change over the years. If the same tutorial has to be updated because it no longer works with current versions of the software and data, a new version can be submitted.
External files
Tutorials can include and use external files, but they will have to be provided so the tutorial can be rebuilt. Here is an example of a separate image file earth.png
(See Files tab above) referred to in the document: