Skip to content

Commit

Permalink
Moved archetypes (wip) from newStructure over
Browse files Browse the repository at this point in the history
  • Loading branch information
RWTH-MK committed Nov 18, 2024
1 parent 5524df4 commit 5b7b778
Show file tree
Hide file tree
Showing 5 changed files with 275 additions and 16 deletions.
6 changes: 0 additions & 6 deletions archetypes/default.md

This file was deleted.

133 changes: 133 additions & 0 deletions archetypes/en/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
---
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: ['no', 'English', 'Localized', 'Silent'] # choose accordingly
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'
---
# {{ replace .Name "-" " " | title }}
*Put short description of the content here*

<!--more-->
<!-- What is written before the `<!--more--` comment is used for the summary -->

## A Midsummer Night's Dream

Written around 1595 or 1596 by William Shakespeare.[^1]

### Act I, Scene 1 {#example-id}
Enter THESEUS, HIPPOLYTA, PHILOSTRATE, and Attendants

Theseus
: Now, fair Hippolyta, our nuptial hour
Draws on apace; four happy days bring in
Another moon: but, O, methinks, how slow
This old moon wanes! [...]

Hippolyta
: Four days will quickly steep themselves in night;

## More examples

A dandy fine list of styles and options
- **bold**
- __bold as well__
- *italic*
- _italic as well_
- ***bold italic***
- ___yet again___
- ~~strikethrough~~
- `inline code`
- A [reference](#example-id) within the document

1. numbered
1. lists
2. work
2. lorem
- [ ] ipsum
- [x] dolor

You can use LaTeX style formating of math, even inline: \(U=R\cdot I\) (please note that you cannot use the typical
delimiter `$` here). Bit more complex:

\[
\begin{align}
E &= m\cdot c^2 \\
&=m\cdot (\nu\cdot\lambda)^2
\underset{would~you~look~at~that!}{=} \left(\frac{h\cdot c}{\lambda}\right)
\end{align}
\]
Another test:
$$
\vec{F} = \frac{\dot{\vec{p}}}{m}
$$

You can also write code

```python
import numpy as np

is_it_awesome = True
```

Tables are possible as well. Note that the second row defines the alignment of text (with :).
You might want to use an [online editor](https://www.tablesgenerator.com/markdown_tables)

<div style="text-align: center; margin-left: auto; margin-right: auto; width: 75%;" >

| Syntax | Description | Test Text |
|:----------|:-----------:|----------------------------------:|
| Header | Title | Here's this |
| Paragraph | Text | Here's how to escape the pipe: \| |

</div>

Have fun with all these possibilities :v:

## Literature and sources

Any comments on the literature might go here. There will be a horizontal line drawn before the footnotes, so you may
want to remove the heading. It's up to you eventually. You will see that the second footnote won't be rendered, because
it's not referred to in the text.

[^1]: W. Shakespeare (1595 or 1596), A Midsummer Night's Dream, [Open Source Shakespeare](https://www.opensourceshakespeare.org/views/plays/play_view.php?WorkID=midsummer)

[^2]: Author (year), title, Publisher/Journal Name (doi: XXX)
75 changes: 75 additions & 0 deletions archetypes/en/instruction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
title: '{{ replace .Name "-" " " | title }}'
date: '{{ .Date }}'
translationKey: # done by phyphox Team

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
requiredMaterials:
- 'Smartphone only'
- 'Household items'
- 'Basic experiment material'
- 'Special equipment'
tags: # All Tags start upper-case expect for 'phyphox'. This list can be expanded!
- 'phyphox'
- 'Smartphone'
- 'Experiment'
- 'Gyroscope'
- 'Coil'
summary: 'short description of the content (1-2 sentences)'
version: '1.0.0' # Increase last digit for corrected typos etc. Increase middle digit if tasks or values are changed. Increase first digit if larger rework is done, like adding a new task or figure. When a digit is increased, set all later digits back to 0.
---
# {{ replace .Name "-" " " | title }}

## Worksheet Instruction Template: Checklist
Refer to documentation at [GitHub](https://github.com/phyphox/expdb-generator/wiki) to get a better idea on what and
how to write in this document. Please cross of all the work done. If you have comments or questions, put them into a
sublist like shown below. Do not remove the checklist, it will be deleted once your work is checked. The percentages
are a rough estimate on how much effort should be put into the corresponding task.

**Meta**
- [x] Read the documentation:
- ***Sublist Example:*** *Put your questions/comments on the doc here*
- [ ] Fill out the Frontmatter

**Instruction**
- [ ] Add figures (40%)
- Meta:
- [ ] Read the instructions in documentation
- [ ] Make sure to include them in the correct folder
- What to do (ordered by relevance):
- [ ] Drawings of the setup
- [ ] Visualizing the physical phenomenon
- [ ] Pictures of an actual setup
- [ ] Information: (15%)
- [ ] Needed materials
- [ ] Time effort
- [ ] Skills developed
- [ ] Experienced problems & solutions (20%)
- [ ] Written explanation: (15%)
- [ ] How to set up
- [ ] How to measure
- [ ] Offer different degrees of difficulty (10%)
67 changes: 67 additions & 0 deletions archetypes/en/worksheet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
title: '{{ replace .Name "-" " " | title }}'
date: '{{ .Date }}'
translationKey: # done by phyphox Team

author: # Your 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
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'
summary: 'short description of the content (1-2 sentences)'
version: '1.0.0' # Increase last digit for corrected typos etc. Increase middle digit if tasks or values are changed. Increase first digit if larger rework is done, like adding a new task or figure. When a digit is increased, set all later digits back to 0.
---
# {{ replace .Name "-" " " | title }}

## Work Sheet Template: Checklist
Refer to documentation at [GitHub](https://github.com/phyphox/expdb-generator/wiki) to get a better idea on what and
how to write in this document. Please cross of all the work done. If you have comments or questions, put them into a
sublist like shown below. Do not remove the checklist, it will be deleted once your work is checked. The percentages
are a rough estimate on how much effort should be put into the corresponding task.

**Meta**
- [x] Read the documentation:
- ***Sublist Example:*** *Put your questions/comments on the doc here*
- [ ] Fill out the Frontmatter

**Work Sheet**
- [ ] Add explanatory and instructing text & formulas (10%)
- [ ] Add figures (50%)
- [ ] read the instructions in documentation
- [ ] make sure to include them in the correct folder
- [ ] Develop tasks (and solutions) (40%)
- [ ] comprehension
- [ ] measurement
- [ ] calculation
- [ ] contextualised
- [ ] sole calculus
- [ ] offer different degrees of difficulty
10 changes: 0 additions & 10 deletions archetypes/instructions.md

This file was deleted.

0 comments on commit 5b7b778

Please sign in to comment.