Resources Frontmatter

The Frontmatter

The Frontmatter is used to save meta-data and get an overview on the website. As an example we take the frontmatter of the en/default.md archetype. It is written in YAML. This means, everything following # is comment (until a new line starts). The computer doesn't care about it, it is written just for you.

default.md

---
title: '{{ replace .Name "-" " " | title }}'
date: '{{ .Date }}'
translationKey: # done by phyphox Team
version: '0.4.2'
author: 
  - # Your Name
  - # Another Name
CreativeCommons: ['0', 'BY', 'BY-SA']  # choose. Remove everything else
categories:  # Remove all categories which are not accurate
  - 'Waves and Sound and Optics'
  - 'Mechanics'
  - 'Electricity and Magnetism'
  - 'Thermal and Statistical'
  - 'Astronomy' 
  - 'Quantum'
sensors:  # used by phyphox. Remove those which are not used
  - 'Gyroscope'
  - 'Proximity'
  - 'Accelerometer'
  - 'Magnetometer'
  - 'Light'
  - 'Location'
  - 'Pressure'
  - 'Temperature'
  - 'Humidity'
  - 'Voltage'
  - 'Current'
  - 'Speaker'
levels: ['0', '1', '2a', '2b', '3', '6', '7']  # see doc for explanation. Remove everything else
video: # remove all which are not available
  - 'English'
  - 'Localized'
  - 'Silent'
requiredMaterials:
  - 'Smartphone only'
  - 'Household items'
  - 'Basic experiment material'
  - 'Special equipment'
tags: # All Tag start upper-case expect for 'phyphox'. This list can be expanded!
  - 'phyphox'
  - 'Smartphone'
  - 'Experiment'
  - 'Gyroscope'
  - 'Coil'
  - 'Shakespeare'
  - 'Demonstration'
---

We will go through it step by step.

--- (three dashes)

These are the beginning and ending of the frontmatter.

title

The title of the document. You can write your title either within single quotes

title: 'my Example 1'

or double quotes

title: "my Example 2"

You don't need to worry about '{{ replace .Name "-" " " | title }}': It is the code used by Hugo as descriped in chapter Git & Bash.

date

Only needed if you start the work from scratch. It is the date of creation. This field uses the ISO 8601 format. This means, the timestamp is written like this (you could be more specific, but that is unnecessary)

YYYY-MM-DD

As of writing this, this would be 2024-11-22

You don't need to worry about '{{ .Date }}': It is the code used by Hugo.

The timstamp written by Hugo: 2024-11-22T14:15:05+01:00

We go from year to month to day, seperator T, hour, minute, second, seperator + or -, timezone shift

translationKey

You don't need to care about this.

version

This is inspired by Semantic Versioning. A new ressource should start at 0.0.0 if it is a proof-of-concept/draft/... and was never used in class. If it is already tested, you can start at 1.0.0. Increase the numbers as follows:

• x.y.Z: The last digit signifies small changes like typos/typesetting. When increased, do not change x or y.

  You have a proved worksheet of yours about a pendulum. You rewrite it for the database: It's a version 1.0.0!

  One problem: You wrote pendluum at some point. You fix this typo. Your new release is version 1.0.1

• x.Y.z: The middle digit is used to signify the fixing of major errors. When increased, do not change x, set z=0.

  When you edited typos in the pendulum worksheet, you were very tired. You didn't notice

  F = m*G, g=9.18 m/s^2

  and published the worksheet as version 1.9.2. Now you fix the errors

  F = m*g, g=9.81 m/s^2

  and release a new version: 1.10.0

• X.y.z: The first digit is used to signify major rework, like adding a new figure, removing a task and more. When increased, set y=0 & z=0.

  You got really good at creating figures. You decide to add one of your latest creations and also write a new task about it.

  The latest version of the pendulum worksheet was 1.10.2. Your new version is 2.0.0.

author

It's a list so you can append yourself. You can use a pseudonym (keep it civil) or don't write anything.

Nobody knows who exactly Phoebe Fox is. But her resources are pretty good.

Creative Commons

If you're reworking a resource where other people have been involved, don't change the CC. Keep in mind that all figures need to be equally or less strict licensed.

If you/your team start the work, choose your preferred Creative Commons License. As a short overview:

• 0: (Version 1.0) Everyone can do anything with the resource. When using the resource, it is good manner to cite authors, but there's no obligation.
• BY: (Version 4.0) Your name has/names have to be cited when using this resource.
• BY-SA: (Version 4.0) Your name has/names have to be cited when using this resource. Any re-release of the resource needs to be CC BY-SA 4.0 as well.

We advice against NC (Non-Commercial), since it would exclude any non-state-funded class, like students giving lessons.

We do not accept ND (Non-Deriative), since it would defeat the purpose of the database.

categories

Choose [1, all] from the list. Please remove all tags which do not fit.

The pendulum worksheet lists as

categories:
  - 'Mechanics'

sensors

Choose [0, all] from the list. These are the sensors in the smartphone. If you only use external sensors, this list is empty.

levels

Choose [1, all] from the list. This refers to the ISCED-2011 Levels.

• 0: pre-school (Vorschule in Germany)
• 1: primary school (Grundschule)
• 2 lower secondary education. We distinguish
  • 2a: German Orientierungsstufe (class level 5 and 6)
  • 2b: German Sekundarstufe I (class level 7, 8, 9 and 10)
• 3: upper secondary education (Oberstufe)
• 6: Bachelor level
• 7: Master level

video

Choose [0, all] options from the list. Give a link to the video(s) in the body of the resource.

• English: A video is available in English
• Localized:
  • If you're creating a non-English resource Use this if a video is available in your language
  • If you're from USA Use this if imperial units are used in the video
• Silent: A video with no text or speech

requiredMaterials

Choose [0, all] from the list. This is only an overview. The specific list is written out in the body.

tags

Write [0, inf) fitting tags. These are helping the searchbar on our website.