Allgemeines Metadatenprofil für Bildungsressourcen

---

English description

A schema.org/LRMI-based profile for describing learning resources.

• GitHub Repo: https://github.com/dini-ag-kim/amb
• Specification:
  • latest published version: https://w3id.org/kim/amb/latest/
  • current draft: https://w3id.org/kim/amb/draft/

---

Ein schema.org-/LRMI-basiertes Metadatenprofil für die Beschreibung von Lehr- und Lernressourcen mit Fokus auf den deutschsprachigen Raum.

• GitHub Repo: https://github.com/dini-ag-kim/amb
• Spezifikation:
  • letzte publizierte Version: https://w3id.org/kim/amb/latest/
  • aktueller Entwurf: https://w3id.org/kim/amb/draft/

Status

Publiziert

Zum Entwicklungsprozess

Siehe auch die StöberSpecs-Prozesse.

Implementierungen

In der implementations.md sammeln wir Akteure, die das Profil verwenden. Falls du weitere Akteure kennst, trage sie dort gerne ein oder melde dich bei uns.

Frequently Asked Questions

In unserem FAQ beantworten wir häufig gestellte Fragen.

Beteiligte Personen

• Adrian Pohl (hbz & KIM), @acka47 (GitLab)
• Axel Klinger (TIB), @axel-klinger (GitLab
• Fabian Steeg (hbz), @fsteeg (GitLab)
• Manuel Oellers (WWU Münster), @oellers
• Mikey Stengel (Serlo Education e.V.), @CodingDive
• Mirjan Hoffmann (TIB), @mirjan-hoffmann, (GitLab)
• Sebastian Herrmann (SHRIMP_PODS, Uni Leipzig), @smherrmann
• Steffen Rörtgen (GWDG), @sroertgen
• Stephan Kulla (Serlo Education e.V.), @kulla
• Tobias Bülte (hbz), @TobiasNx (GitLab)
• Ergänze dich selbst, wenn du Interesse hast mitzumachen

Lokales Setup

Installation der notwendigen Packete

Über npm install kannst du die für die Entwicklung notwendigen Packete installieren.

Ansicht der HTML-Spezifikation im Browser

Um die index.html-Datei lokal editieren und anzeigen zu können, klone das Repo und wechsle in das amb-Verzeichnis:

git clone [email protected]:dini-ag-kim/amb.git ; cd amb

Lasse einen Server im amb-Verzeichnis laufen:

python3 -m http.server

Dann lässt sich die Spezifikation im Web-Browser anschauen unter http://localhost:8000.

Tests

Schema-Tests werden gegen valide (draft/examples/valid) und invalide (draft/examples/invalid) Beispiel-Dateien durchgeführt. Lokal können die Tests mit $ sh test.sh oder mit npm run test ausgeführt werden. Durch die inkrementelle Ergänzung von invaliden Beispielen soll das Schema stetig genauer werden, um in der Praxis die Einhaltung des Profils zu gewährleisten.

Um die Tests laufen lassen zu können, müssen die NPM Packete ajv-cli und ajv-formats installiert sein, was du über npm install erreichst.

Formatierung

Über npm run format kannst du die Dateien in diesem Repository formatieren. Zur Formatierung nutzen wir prettier, siehe .prettierrc.json für unsere Konfigurationseinstellungen. Für prettier gibt es auch Integrationsmöglichkeiten in vielen Editoren.

Weiterführende Informationen

• "Entwicklung eines Profils für OER-Metadaten mit JSON Schema & SkoHub", Adrian Pohl. Präsentation beim DINI-KIM-Workshop 2020, WWW.