Dokumentation
Aufbau der Inhalte
Gliederung des Projekts
- Die sechs Kacheln auf der Startseite sind die Themenbereiche.
- Die Themenbereiche gliedern sich in Kapitel, diese ggf. noch einmal in Unterkapitel.
- Mehrere Seiten bilden einen Abschnitt.
Als Muster für den Aufbau eines Kapitels dient das Demokapitel.
Gliederung der Startseiten
- Worum geht es hier? (thematische Orientierung)
- Für dieses Thema solltest du ... (Vorwissen mit Links zu den passenden Zusammenfassungsseiten)
- Hier lernst du ... (Lernziele)
- Diese Inhalte findest du hier: (blaue Inhaltsbox, die die Seitenleiste widerspiegelt, einschließlich Exkursen)
Gliederung einzelner Seiten
-
Überschriften mit Operatoren:
<h3>Überschrift</h3>Normalerweise enthält eine Überschrift einen Operator, z. B. „Das Maximum experimentell bestimmen“ oder „Erarbeitung: …“. Bei Einstiegen kann das ungünstig sein, wenn dadurch eine Pointe vorweggenommen wird. „Einstieg: Das Problem kennenlernen“ oder einfach „Einstieg“ ist dort in Ordnung. -
Aufgabe:
<h3 class="aufgabe">Aufgabe 1</h3> -
Aufgabe mit Text:
<h3 class="aufgabe">Aufgabe 1: Das Ziegenproblem erkunden</h3> -
Aufgabe mit Phase (nur wenn sinnvoll):
<h3 class="aufgabe">Aufgabe 1 (Einstieg)</h3>Die Phasen Einstieg/Erarbeitung/Sicherung/Vertiefung können auch als Lernstrecke abgebildet werden. -
Teilaufgaben: fett und mit Klammern
<b>(a)</b>
Boxen und Symbole
Boxen
Alle aktuellen Boxen stehen auf der Unterseite Boxen. Nur diese sollen verwendet werden.
Aufklappbare Boxen
Der gesamte Inhalt nach </summary> muss in einem <div> stehen, sonst fehlt die graue Umrandung:
<details class="ombox ombox--aufklappbar">
<summary>💡 Tipp</summary>
<div>
<p>Text</p>
</div>
</details>
Didaktische Kommentare
didaktik-temp kommt zurzeit noch auf vielen Seiten vor.
Didaktik:
Text für einen didaktischen Kommentar, wird später durch neue Funktion ersetzt. Code sieht so aus:
<details class="didaktik-temp">
<summary>Didaktischer Kommentar</summary>
<p>Text</p>
</details class="didaktik-temp">
Kann auch als „normales“ div verwendet werden. Beim schließenden Tag wird die Klasse ergänzt; das hat keinen Effekt, erleichtert aber später eine automatisierte Änderung.
Textauszeichnungen
-
Definitionen im Fließtext:
<span class="om__definition">Ableitung</span>; darauf achten, dass man sich in einem<p></p>befindet.
Symbole: bereits verbreitet
| Symbol | HTML-Code | Erläuterung |
|---|---|---|
| 💡 | 💡 |
Glühbirne bei Tipps und anderen Hilfen, z. B. <summary>💡 Tipp</summary>
|
| 🔑 | 🔑 |
Schlüssel bei Kontrollergebnissen auf der Seite, z. B. <summary>🔑 Zur Kontrolle</summary>
|
| 🎯 | 🎯 | Zielscheibe für Zielsetzungen |
| 🚀 | 🚀 | Rakete bei Aufgaben für Schnellere |
Symbole: weitere Ideen
Diese Symbolliste muss noch ausgedünnt werden. Sinnvoll wäre außerdem ein Symbol für Überspringbares, also für Inhalte, die für den weiteren Verlauf nicht zwingend sind.
| Symbol | HTML-Code | Erläuterung |
|---|---|---|
| 📖 | 📖 | Buch bei Verweisen zum Nachlesen, siehe Unterseite Boxen |
| 🧮 🔢 📱 | 🧮 🔢 📱 | Abakus, Zahlen oder Smartphone für Rechner-Tools wie den Wahrscheinlichkeitsrechner (noch zu entscheiden) |
| 🖊️ | 🖊️ | Stift bei Aufgaben, in denen etwas ins Heft geschrieben werden soll |
| 💬 | 💬 | Sprechblase bei Partnerarbeit u. ä. |
| ▶ | ▶ | Pfeil für Links |
| 🎓 | 🎓 | Hut bei didaktischem Kommentar |
| 🕵 | 🕵 | Spion bei Fehlersuchen |
| ★ | ★ | ein Stern bei leichten Aufgaben |
| ★★ | ★★ | zwei Sterne bei mittleren Aufgaben |
| ★★★ | ★★★ | drei Sterne bei schweren Aufgaben |
| ☠ | ☠ | Totenkopf bei extrem kniffligen Aufgaben |
| 👤👤 | 👤👤 | zwei Köpfe für Partnerarbeit |
Sprache und Notation
Sprachliches
- überall Du-Anrede
- GeoGebra-Applet, wenn Lernende etwas interaktiv verändern können
- GeoGebra-Animation, wenn etwas automatisch abläuft
Mathematische Notation
- $P(1|2)$ statt $P=(1,2)$
- $1.23$ statt $1{,}23$
- Einträge/Komponenten/Koordinaten eines Vektors?
Farbverwendung einzelner mathematischer Inhalte
Funktionen
- rot: Stelle $x$
- blau: Funktionswert $y$
Differentialrechnung
- schwarz: Graph der Ursprungsfunktion $f$
- blau: Graph der Ableitungsfunktion $f'$ und Tangente
- grün: Sekante
Technik
Sprungmarken
Abschnitte lassen sich direkt verlinken: Die Überschrift bekommt eine id, also z. B. <h3 id="lokal">Überschrift</h3>, der Link hängt sie an den Pfad an, also z. B. <a href="pfad/zur/seite#lokal">Text</a>.
Parameter zur Einbindung der GeoGebra-Applets
https://wiki.geogebra.org/en/Reference:GeoGebra_App_Parameters
Quellen-Generator für inf-schule.de
https://www.inf-schule.de/infschule/dokumentation/kapitel-erstellen/textbereich/imgtaggenerator
Farben
- #2c8f78 – abgeschwächt: #d8f3ed
- #2f4858
- #007fbb
- #7661b3
- #f3eada
- #9facbd
- #bb0a21 – abgeschwächt: #fccfd5
- #eb9928 – abgeschwächt: #fbe9d0
- #f9f871
Redaktion
Autor:innen
Die:Der Hauptautor:in einer Seite steht an erster Stelle. Alle anderen, die dazu beigetragen haben – auch durch Korrekturlesen – folgen danach.
Offene Punkte
- GK/LK-Kennzeichnung: Wir brauchen bald eine Kennzeichnung für GK- und LK-Inhalte, die dann im ganzen Buch durchgezogen werden muss.
- Symbol für Überspringbares: siehe „Symbole: weitere Ideen“.
- Die i-Box ist sehr prominent, insbesondere als details-Box. Solche Informationen stechen schon sehr hervor. Wir nutzen sie aktuell aber auch für weniger wichtige Punkte.
- In den einzelnen Themenbereichen sollten die Boxen für Definition und Satz beim ersten Auftreten (bzw. dem ersten passenden Auftreten) kurz thematisiert werden, ggf. mit Verweis auf ein Kapitel in den Grundlagen.