Home How to use the database

How to use and contribute to the database

All content within the database is open-source and is either available as Open Educational Resources (OER) under Creative Commons licenses or part of the code, which is available under the GNU General Public Licence. This intends to make it easy to use everything for your own needs.

To make it easy to get the teaching ressources, a website is available under . You can find a hopefully ever-growing number of different ressources in a variety of languages.

If you want to contribute to the database: You are awesome! In this wiki are a few guides on how to do that.

Teaching Ressources

All content is originally written in Markdown (.md) and later compiled to different formats with Pandoc. The files are located within subdirectories of /content/.

As a User

The easiest option to get the ressources is to visit the website, where you can download the files directly in a variety of formats.

If you are not pleased with the general layout of the resources and are capable of using a command line, you can change them more to your liking by using Pandoc Templates. Likewise, you can edit the files if you are unsatisfied with or critical of their content.

If you think others share your view or preference, feel free to contribute!

As a Contributor

First of all we are extremely glad for every bit of help. Thank you very much! There are different ways to contribute to the database, and you can choose what to focus on.

• You can add language support. This includes the website on its own and the ressources. We use a translation management system, so you can easily work together with others.
• You can create new instructions, worksheets, etc. Please refer to the standards and given examples.
• You can give feedback and input for improvement on anything related to the database.

We advise you to write to contact@phyphox.org before doing any work. We can help you with any questions, give detailed insight, tips and much more.

The website

The website uses:

• Hugo for the creation of the website
• Pandoc to export the Markdown code to other formats, namely .pdf, .tex, .odt, .docx, .html

The structure of the database is built upon the Hugo basis:

• The heart of the project is stored under config/, layouts/, assets/ & i18n/
  • The appearance, functionality and language support are to be found here
• The soul of the project is stored unter content/
  • Each language has its own directory
  • Here you can find the Markdown files and multimedia files used in the ressources
  • The Pandoc output is stored here as well
• The idea of the project is stored under archetypes/
  • these are the basis of the ressources

If you want and can contribute, you are welcome to!

We advise you to write to contact@phyphox.org before doing any work. We can help you with any questions, give detailed insight, tips and much more.