Regeln für Inhalt und Angaben

Was Du einreichst

Den Inhalt einer Lern-App vom Archetyp explainer: Kapitel mit Seiten, Erklärungen und Aufgaben als YAML-Dateien, dazu Datendateien, Bilder und Komponenten. Die Beschreibung der Dateien steht im Schema des Explainers und in der Anleitung zum Archetyp. Es gibt kein Lehrwerk dazu: Du reichst eigene Inhalte ein.

Aufbau der ZIP-Datei

Oben in der ZIP-Datei steht der Ordner src. Die Datei src/app.yaml muss da sein.
Es geht auch mit einem Ordner um alles herum (GitHub „Download ZIP“). Dann zählt nur <Ordner>/src/.
Was außerhalb von src liegt, ignorieren wir und entpacken es nie.
Wir ändern nichts an der Vorlage. src/main.ts gehört ihr: Steht die Datei in der ZIP-Datei, ignorieren wir sie, und der Bau nimmt die der Vorlage.
Eigene Komponenten liegen in src/components/, so wie der Explainer sie kennt: <Name>.vue, <Name>.ts und <Name>.test.ts, ohne Unterordner. Ihren Code prüft der Bau (siehe Prüfungen).
Datendateien liegen in src/data/, Bilder in src/images/.

Erlaubte Dateien

Regel	Wert
Endungen	`.yaml`, `.yml`, `.md`, `.png`, `.jpg`, `.webp`
Komponenten	`.vue` und `.ts` nur in `src/components/`; Namen wie `Zahlenstrahl.vue`, `Zahlenstrahl.ts`, `Zahlenstrahl.test.ts`
SVG-Bilder	`.svg` nur in `src/images/`, Namen aus Kleinbuchstaben, Ziffern und Bindestrichen (siehe SVG-Bilder)
Nicht erlaubt	alles andere, zum Beispiel `.js`, `.html`, `.json`
Namen	nur `a-z`, `A-Z`, `0-9`, `-` und `_`; genau ein Punkt vor der Endung (kein `bild.png.js`)
Versteckte Dateien	nicht erlaubt (Namen mit Punkt am Anfang, zum Beispiel `.DS_Store`)
Pfade	nur Ordner unter `src/`, höchstens 6 Ordner tief; kein `..`, kein absoluter Pfad, kein Rückwärtsstrich
Links und Sonderdateien	nicht erlaubt (Symlinks, Geräte); verschlüsselte Dateien nicht erlaubt
ZIP-Datei	höchstens 10 MB
Anzahl	höchstens 300 Dateien unter `src`
Größe entpackt	höchstens 25 MB zusammen, höchstens 10 MB je Datei
Zeitlimit beim Laden	60 Sekunden

Die Größen prüfen wir im Verzeichnis der ZIP-Datei und beim Entpacken. Eine ZIP-Datei, die falsche Größen angibt, wird abgelehnt. Umlaute in Dateinamen sind nicht erlaubt; im Text der YAML-Dateien sind sie selbstverständlich erlaubt.

SVG-Bilder

Ein SVG-Bild darf nur zeichnen. Denn öffnet jemand das Bild für sich, führt der Browser aus, was darin steht. Wir entpacken ein SVG-Bild deshalb nicht, wenn es eines davon enthält:

ein Skript (<script>) oder ein Ereignis-Attribut wie onload= oder onclick=,
eingebettetes HTML oder ein eingebettetes Dokument (<foreignObject>, <iframe>, <embed>, <object>),
einen Verweis auf JavaScript (javascript:),
einen Verweis nach außen: href, xlink:href oder url(…) auf etwas anderes als #… in derselben Datei, @import, eine Adresse in einem Attribut,
eine Entity-Definition (<!ENTITY).

Der Kommentar nennt das Bild und was darin stört.

Die Angaben im Formular

Feld	Regel
Fach	Pflicht, höchstens 60 Zeichen, eine Zeile. Steuerzeichen entfernen wir.
Klassenstufe	eine Zahl von 1 bis 13 aus der Liste
Bundesland	eines der 16 Bundesländer aus der Liste
ZIP-Datei	ein Link `https://github.com/user-attachments/files/<Zahl>/<Name>.zip`, den GitHub beim Hineinziehen schreibt. Andere Adressen laden wir nicht.
Erklärungen	alle drei angekreuzt

Die drei Erklärungen

Der Inhalt ist selbst erstellt (auch mit KI-Hilfe). Es ist nichts aus Büchern oder Arbeitsblättern abgeschrieben, und er enthält keine Fotos von Material.
Der Inhalt enthält keine persönlichen Daten (Namen, Schule, Klasse, Lehrkraft).
Ich erlaube, dass der Inhalt zwei Wochen lang veröffentlicht wird. Bei einer späteren Aufnahme in den Katalog gilt CC BY 4.0, und ich bin Urheberin oder Urheber.

Mehr dazu: Datenschutz und Urheberrecht.

Inhalt, der immer gilt

Texte für Lernende sind auf Deutsch und in einfacher Sprache.
Beispiele nutzen erfundene Namen, nie echte.
Quellen stehen im Feld sources von src/app.yaml, wenn Du Fakten übernimmst.
Die YAML-Regeln des Explainers sind streng. Ein Doppelpunkt oder ein Komma im Text ohne Anführungszeichen führt zu einem Fehler. Der Kommentar zeigt Dir dann die Zeile.