From 5b7b778b3ba418700ffaa3dba4055120c1e1141c Mon Sep 17 00:00:00 2001 From: RWTH-MK Date: Mon, 18 Nov 2024 15:26:50 +0100 Subject: [PATCH] Moved archetypes (wip) from newStructure over --- archetypes/default.md | 6 -- archetypes/en/default.md | 133 +++++++++++++++++++++++++++++++++++ archetypes/en/instruction.md | 75 ++++++++++++++++++++ archetypes/en/worksheet.md | 67 ++++++++++++++++++ archetypes/instructions.md | 10 --- 5 files changed, 275 insertions(+), 16 deletions(-) delete mode 100644 archetypes/default.md create mode 100644 archetypes/en/default.md create mode 100644 archetypes/en/instruction.md create mode 100644 archetypes/en/worksheet.md delete mode 100644 archetypes/instructions.md diff --git a/archetypes/default.md b/archetypes/default.md deleted file mode 100644 index 22a7858..0000000 --- a/archetypes/default.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "{{ replace .Name "-" " " | title }}" -date: {{ .Date }} -draft: true ---- - diff --git a/archetypes/en/default.md b/archetypes/en/default.md new file mode 100644 index 0000000..4791f63 --- /dev/null +++ b/archetypes/en/default.md @@ -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* + + + + +## 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) + +
+ +| Syntax | Description | Test Text | +|:----------|:-----------:|----------------------------------:| +| Header | Title | Here's this | +| Paragraph | Text | Here's how to escape the pipe: \| | + +
+ +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) diff --git a/archetypes/en/instruction.md b/archetypes/en/instruction.md new file mode 100644 index 0000000..d77b225 --- /dev/null +++ b/archetypes/en/instruction.md @@ -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%) diff --git a/archetypes/en/worksheet.md b/archetypes/en/worksheet.md new file mode 100644 index 0000000..6b83ee2 --- /dev/null +++ b/archetypes/en/worksheet.md @@ -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 diff --git a/archetypes/instructions.md b/archetypes/instructions.md deleted file mode 100644 index 34d0880..0000000 --- a/archetypes/instructions.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: string -date: Date -last_mod: '{{ .Now.Date }}' -author: -taxonomies: - target_group: ISO... - difficulty: enum -draft: true ---- \ No newline at end of file