Open Data Wizard 🧙

📖 Dokumentation · 📋 Feld-Referenz · 📐 Technische Spezifikation · 📝 Changelog · 🛡️ Security · ⚖️ Lizenz

Ein WordPress-Plugin zur einfachen Veröffentlichung offener Daten nach DCAT-AP 3.0

Open Data Wizard ermöglicht es Organisationen und Einzelpersonen, Datensätze direkt in WordPress zu beschreiben und als maschinenlesbare, standardkonforme Metadaten bereitzustellen — ohne technische Vorkenntnisse, ohne externe Plattformabhängigkeit.

Das Problem

Offene Daten zu veröffentlichen ist schwieriger als es sein müsste. Wer Daten auf einer Open-Data-Plattform einstellen will, landet schnell vor komplexen Formularen, unbekannten Fachbegriffen oder muss sich auf eine externe Infrastruktur verlassen, über die keine Kontrolle besteht.

Dabei besitzen viele Organisationen bereits eine WordPress-Website und damit eine Infrastruktur, die sie kennen und die sie kontrollieren.

Hier kann der Open Data Wizard helfen.

Die Idee

Das Plugin bringt einen geführten Metadaten-Wizard ins WordPress-Backend. Organisationen beschreiben ihre Datensätze dort, wo sie ohnehin arbeiten. Das Plugin generiert daraus eine maschinenlesbare Beschreibung nach dem internationalen Standard DCAT-AP 3.0 und stellt sie unter einer persistenten URL bereit.

Open-Data-Plattformen können diese URL als Harvest-Quelle einbinden und die Metadaten automatisch einsammeln. Die Daten bleiben bei der Organisation. Die Plattform kommt zu ihr.

Was ist DCAT-AP?

DCAT-AP (Data Catalog Vocabulary — Application Profile) ist ein europäischer Standard zur Beschreibung von Datensätzen und Datenkatalogen. Er definiert, welche Angaben ein Datensatz braucht, damit er von Plattformen, Suchmaschinen und Anwendungen einheitlich gelesen und verarbeitet werden kann — Titel, Beschreibung, Lizenz, Format, Herausgeber und mehr.

Open Data Wizard implementiert DCAT-AP 3.0 und erzeugt valide JSON-LD-Ausgaben.

Für wen ist das Plugin?

Vereine, NGOs und gemeinnützige Organisationen, die Daten transparent zugänglich machen möchten
Forschungseinrichtungen und Bildungsträger, die Daten unter offener Lizenz veröffentlichen wollen
Kommunen und öffentliche Einrichtungen mit WordPress-Infrastruktur
Alle, die offene Daten standardkonform veröffentlichen wollen — ohne Programmierkenntnisse

Funktionsübersicht

🗂 Datensätze verwalten

Eigener Bereich im WordPress-Backend mit Übersicht, Filterung und Statusverwaltung (Entwurf / Veröffentlicht).

😊 Benutzerfreundliche Formularsprache

Das Wizard-Formular wurde vollständig überarbeitet, um es auch ohne DCAT-AP-Kenntnisse intuitiv zu machen:

Klare Fragen statt technischer Begriffe: Statt „Herausgebende Organisation (dct:publisher)" fragt das Plugin: „Wer gibt diese Daten heraus?"
Hilfreiche Beispiele: Jedes Feld hat konkrete, praxisnahe Beispiele
Ursprüngliche Labels in Hilfetexten: DCAT-AP Bezeichnungen und technische Details bleiben in den Hilfetexten sichtbar
Validierungsmeldungen in Klartext, mit Ort: Wird die Veröffentlichung blockiert, nennt die Meldung den Tab und den verständlichen Feldnamen (der technische DCAT-AP-Begriff steht nur klein daneben) — ein Klick auf „Zum Feld springen" öffnet den passenden Tab und hebt das Feld hervor

🧭 Geführter Wizard

Fünf-Tab-Assistent mit praktischen Beispielen. Pflichtfelder sind mit einem roten Sternchen (*) gekennzeichnet; als Entwurf lässt sich jederzeit unvollständig speichern — erst zum Veröffentlichen müssen alle Pflichtangaben ausgefüllt sein.

Grundlegende Informationen — „Wer gibt diese Daten heraus?", „Worum geht es in diesem Datensatz?", „Welchem Thema ist dieser Datensatz zugeordnet?". Weniger häufige Angaben (CESSDA-Themenklassifikation, ZiviZ-Engagementfeld, Titel-/Beschreibungs-Übersetzungen) liegen in einer aufklappbaren Untergruppe am Tab-Ende.
Inhaltliche Angaben — „In welcher Sprache sind die Daten?", „Mit welchen Schlagworten finde ich diese Daten?", Veröffentlichungs- und Änderungsdatum
Datenbereitstellung — Zugriffs-URL oder Datei-Upload (Mediathek), Format, Dateigröße, Lizenz (Pflicht je Distribution), Namensnennungstext; optional weitere Distributionen (wiederholbar)
Erweiterte Angaben — Projektseite, Aktualisierungsfrequenz, geografische und zeitliche Abdeckung, Kontaktinformationen, Verantwortlichkeiten (Urheber/pflegende Stelle, GovData-Contributor-ID), High-Value-Datensatz (HVD) Kategorie
Vorschau — generiertes JSON-LD live einsehen

🏷 Lizenz-Auswahl

Vordefinierte Auswahlliste mit ausgeschriebenen Lizenznamen (z. B. „CC BY 4.0 — Namensnennung")
Unter der Auswahl erscheint eine allgemeinverständliche Erklärung, was die gewählte Lizenz erlaubt
Option „Sonstige" öffnet ein Freitextfeld mit Auto-Suggest aus config/licenses.txt
Lizenz ist Pflichtfeld pro Distribution (nicht am Datensatz selbst)

🎓 CESSDA-Themenklassifikation

Auswahlfeld aus der CESSDA Topic Classification 4.2.3 (95 deutsche Konzepte, SKOS/RDF, 24h Cache). Im Feld wird das sprechende Label (z. B. „Bildung") angezeigt; die zugehörige URI wird im Hintergrund gespeichert und als Hinweis eingeblendet.

🗺 Geografische Region (GeoNames)

Kuratierte Auswahlliste (Deutschland, alle 16 Bundesländer, größere Städte). Die Auswahl wird im JSON-LD automatisch mit der passenden GeoNames-URI verknüpft; Freitext und eigene URIs bleiben möglich.

📥 Batch-Import (CSV & JSON)

Datensätze → Batch-Import

Importiere mehrere Datensätze auf einmal aus CSV oder JSON Dateien. Der Import-Wizard zeigt eine Vorschau aller gültigen Zeilen, markiert Fehler, und lässt dich auswählen, welche Datensätze importiert werden. Alle importierten Datensätze werden als Entwürfe erstellt — zur Bearbeitung vor Publishing bereit.

Unterstützte Formate:

CSV: Spaltenköpfe = Feldnamen (title, publisher, description, access_url, license, theme, language, format, issued, keywords, byte_size, attribution)
JSON: Array von Objekten oder einzelnes Objekt mit gleichen Feldnamen

Pflichtfelder beim Import:

title — Datensatztitel
publisher — Herausgebende Organisation
description — Beschreibung (Mindestens 10 Zeichen)
access_url — Download-URL (muss mit http/https beginnen)
license — Lizenz (short code wie cc-by oder volle URI)

Optionale Felder:

theme — Thema (z.B. SOCI, ECON, EDUC)
language — Sprache (z.B. de, en)
format — Dateiformat (z.B. CSV, JSON, PDF)
issued — Veröffentlichungsdatum
keywords — Schlagworte (komma-getrennt)
byte_size — Dateigröße in Bytes (nur ganze Zahl; abweichende Werte werden als Fehler markiert)
attribution — Namensnennungstext

Gut zu wissen:

Excel-kompatibel: UTF-8-CSVs mit BOM (Excel-Standardexport) werden korrekt eingelesen.
Limit: Bis zu 2.000 Datensätze pro Import (Schutz vor Speicher-/Timeout-Problemen).
Sicherheit: Zell-Inhalte, die als Tabellen-Formel interpretiert werden könnten (Beginn mit = + @ -), werden beim Import automatisch neutralisiert; Datei-Typ wird anhand der echten Endung geprüft, nicht des Browser-MIME-Typs.

Die Batch-Import-Seite ist vollständig ins WordPress-Admin-Design integriert (Standard-Buttons, dezente Icons).

📥 CSV-Beispiel herunterladen | 📄 JSON-Beispiel

📎 Datei-Upload (Mediathek)

Sidebar-Meta-Box — vollständig unabhängig von Carbon Fields:

„Datei auswählen / hochladen"-Button öffnet den nativen WordPress Media Library Frame
Beim Speichern werden _odw_file_size (Bytes) und _odw_file_format (z.B. „CSV") automatisch berechnet
Sicherheit: wp_verify_nonce + current_user_can('edit_post')

⚙️ Einstellungsseite

Untermenü unter Datensätze → Einstellungen mit vier Bereichen:

Katalog — Titel und Herausgebende Organisation
Standardwerte — Standard-Sprache (wird bei neuen Datensätzen vorausgefüllt)
REST API — Cache-Laufzeit (60–86400 Sekunden)
Deinstallation — Opt-in Checkbox für vollständige Datenlöschung

📊 Qualitätsindikatoren

Automatische Metadaten-Qualitätsprüfung nach der EU-MQA-Methodik. Der Leitwert ist überall Prozent + Stufe (z. B. „72 % · Gut"):

Stufe	Prozent	Bedeutung
Ausgezeichnet	≥ 87 %	nahezu vollständig
Gut	55–86 %	über der Mindestanforderung
Ausreichend	30–54 %	Grundangaben vorhanden
Mangelhaft	< 30 %	wesentliche Angaben fehlen

Berechnung nach jedem Speichern. Die Listenspalte zeigt Prozent + Stufe; die Qualitäts-Meta-Box ergänzt den MQA-Rohwert (z. B. „54 / 259 Punkte, von max. 405") als Detailzeile.

📥 Download-Card Shortcode

[odw_dataset id="123"]

Rendert eine strukturierte Download-Card im Frontend: Titel, Thema-Badge, Lizenz, Schlagwörter als Tag-Pillen, Download-Button sowie einen Metadaten-Download-Button (JSON-LD). CSS (assets/css/frontend.css) wird nur auf Seiten geladen, die den Shortcode enthalten.

🔗 REST API Endpoints

GET https://deine-website.de/wp-json/datenatlas/v1/catalog
GET https://deine-website.de/wp-json/datenatlas/v1/datasets/<id>
GET https://deine-website.de/wp-json/datenatlas/v1/delta?since=<ISO8601>

Diese URLs können bei einer Open-Data-Plattform als Harvest-Quelle eingetragen werden — einmalig, ohne weiteren Aufwand.

Catalog-Parameter: page, per_page, theme, license, format (jsonld, json oder turtle), full

Content Negotiation: Alle drei Endpunkte liefern jsonld, json und turtle. Ohne ?format= entscheidet der Accept-Header (mit q-Werten); ein explizites ?format= hat immer Vorrang. Antworten tragen Vary: Accept.

Delta-Parameter: since (erforderlich, ISO 8601), page, per_page, format — liefert nur Datensätze, die nach dem angegebenen Zeitstempel geändert wurden, plus Tombstones für gelöschte Datensätze

🌾 Harvesting durch externe Open-Data-Portale

Viele Open-Data-Portale holen Metadaten per Pull-Harvesting ab: Sie hinterlegen beim Portal eine stabile URL, unter der Ihr kompletter Katalog als ein DCAT-AP.de-Dokument liegt. Genau dafür bietet der Catalog-Endpoint einen Voll-Modus:

# Vollständiger Katalog als Turtle (empfohlen für RDF-Harvester)
GET https://deine-website.de/wp-json/datenatlas/v1/catalog?full=1&format=turtle   →  text/turtle

# … oder als JSON-LD
GET https://deine-website.de/wp-json/datenatlas/v1/catalog?full=1                 →  application/ld+json

full=1 liefert alle veröffentlichten Datensätze in einem Abruf (ohne Paginierung) als dcat:Catalog → dcat:Dataset → dcat:Distribution — das Muster, das RDF-Harvester erwarten.
format=turtle serialisiert denselben Graphen als Turtle (text/turtle) — ohne externe RDF-Bibliothek. JSON-LD (application/ld+json) und json bleiben verfügbar. Harvester, die rein über Header aushandeln, senden stattdessen Accept: text/turtle.
Die Datensatz-URIs (@id) sind über Releases stabil (an die Post-ID gebunden), sodass Harvester Aktualisierungen/Löschungen korrekt zuordnen und keine Duplikate anlegen.

Die fertigen Harvest-URLs zeigt das Plugin kopierfertig unter Datensätze → Einstellungen → Harvesting an.

✅ DCAT-AP 3.0 Konformität

Alle Ausgaben sind DCAT-AP 3.0 konform und in JSON-LD serialisiert.

🔎 DCAT-AP-Validierung (SHACL)

Ob die erzeugten Metadaten dem Standard formal entsprechen, lässt sich mit SHACL prüfen — der offiziellen Regelsprache, mit der die EU und GovData DCAT-AP-Konformität definieren. Damit du nicht auf inoffizielle Regeln angewiesen bist, bringt das Plugin die maßgeblichen, offiziellen Shape-Dateien gebündelt mit (unter config/shacl/):

Datei	Herkunft	Zweck	Lizenz
`dcat-ap-SHACL.ttl`	SEMICeu/DCAT-AP (Release 3.0.0)	generische EU-DCAT-AP-3.0-Regeln	CC BY 4.0
`dcat-ap-SHACL-DE.ttl`	GovDataOfficial (v3.0)	DCAT-AP.de-Ergänzungen (u. a. `dcatde:`-Felder, deutschsprachige Meldungen)	CC0

Wichtig: Das Plugin führt SHACL nicht selbst aus — dafür gibt es in PHP keine praxistaugliche Engine. Die Dateien liegen als Referenz bei; die eigentliche Prüfung erfolgt über einen externen Validierungsdienst oder ein lokales SHACL-Werkzeug. So bleibt das Plugin self-contained und ohne Pflicht-Netzwerkzugriff.

So validierst du einen Datensatz

JSON-LD abrufen — jeder veröffentlichte Datensatz ist über die REST-API erreichbar:
```
https://<deine-site>/wp-json/datenatlas/v1/datasets/<ID>
```
(den ganzen Katalog liefert …/datenatlas/v1/catalog).
Gegen die Shapes prüfen — mit einem der offiziellen Dienste (Datei hochladen bzw. JSON-LD einfügen):
- EU-Validator (SHACL / ITB): https://www.itb.ec.europa.eu/shacl/dcat-ap/upload
- data.europa.eu MQA: https://data.europa.eu/mqa/
- DCAT-AP.de-Validator (Docker/ITB): siehe DCAT-AP.de-SHACL-Validation

Oder lokal validieren, z. B. mit pySHACL gegen die gebündelten Shapes:

# JSON-LD des Datensatzes speichern …
curl -s "https://<deine-site>/wp-json/datenatlas/v1/datasets/42" -o datensatz.jsonld
# … und gegen die DCAT-AP.de-Shapes prüfen
pyshacl -s config/shacl/dcat-ap-SHACL-DE.ttl -df json-ld datensatz.jsonld

Der Validierungs-Report zeigt Verstöße (sh:Violation) mit Pfad und Meldung — so siehst du genau, welches Feld ggf. nachzubessern ist.

Verhältnis zum Qualitäts-Score

Die integrierten Qualitätsindikatoren (siehe oben) decken die „gesetzt?"- und Vokabular-Prüfungen der EU-MQA-Methodik bereits offline ab. Die MQA-Metrik „DCAT-AP-Konformität" (SHACL, 30 Punkte) wird davon bewusst nicht automatisch bewertet, sondern über die hier beschriebene externe Validierung geprüft (Ansatz „achievable max"). Details im MQA-Konzept.

Installation

Für Anwender:innen

ZIP-Datei aus den Releases herunterladen
Im WordPress-Backend: Plugins → Installieren → Plugin hochladen
Plugin aktivieren

Keine weiteren Abhängigkeiten. Keine Programmierkenntnisse erforderlich.

Für Entwickler:innen

git clone https://github.com/daimpad/OpenDataWizard.git
cd OpenDataWizard
composer install   # erzeugt vendor/ (Carbon Fields + PHPStan, WPCS, PHPUnit)

composer install ist zwingend erforderlich. vendor/ ist bewusst nicht im Repository — es wird reproduzierbar aus composer.lock erzeugt (lokal, in der CI und beim Release-Build). Ohne diesen Schritt fehlt Carbon Fields und das Plugin zeigt einen entsprechenden Admin-Hinweis.

Den Plugin-Ordner in eine lokale WordPress-Instanz einbinden (z.B. via LocalWP).

Systemvoraussetzungen:

WordPress ≥ 6.4
PHP ≥ 8.1
Composer (nur für Entwicklung)

Dev-Tools:

composer phpcs      # WordPress Coding Standards prüfen
composer phpcbf     # Automatisch korrigieren
composer phpstan    # Statische Analyse (Level 6)
composer test       # PHPUnit-Tests ausführen

CI läuft via GitHub Actions (.github/workflows/ci.yml) auf PHP 8.1, 8.2 und 8.3.

Für Entwickler: Siehe CLAUDE.md für Architektur-Übersicht, Patterns, Debugging-Tipps und Workflows.

🛠 Technische Dokumentation

Die ausführliche Entwickler-Dokumentation (Architektur, Dateistruktur, DCAT-AP-Feldmapping, REST-API, Erweiterbarkeit, WP-CLI, Abhängigkeiten) ist in einem eigenen Dokument gepflegt:

➡️ DOCUMENTATION.md

🧩 Technische Spezifikationen

Alle technischen Spezifikationen — Metadatenmodell, JSON-LD-Namespaces, kontrollierte Vokabulare, der vollständige DCAT-AP-/DCAT-AP.de-Feldkatalog mit Gap-Analyse, das Feld-Registry-Schema sowie die phasierte Umsetzungsplanung samt Umsetzungsstand — sind in einem eigenen Dokument gepflegt:

➡️ TECHNICAL-SPEC.md

Neue technische Festlegungen gehören in dieses Dokument (nicht in die anwenderorientierten Kapitel oben).

Roadmap

Abgeschlossen (v1.0 — v2.1):

In Planung (v2.2+): — Details siehe Technische Spezifikationen § 7

Mitwirken

Beiträge sind willkommen — ob Fehlermeldungen, Verbesserungsvorschläge oder Pull Requests.

Bitte öffne zunächst ein Issue, bevor du größere Änderungen einreichst.

Deinstallation

Das Plugin löscht bei Deinstallation standardmäßig keine Daten (Opt-in).

Um alle Plugin-Daten zu löschen, die Checkbox unter Datensätze → Einstellungen → Deinstallation aktivieren und dann das Plugin im WordPress-Backend deinstallieren. uninstall.php entfernt alle odw_dataset-Posts, alle _odw_*-Metafelder sowie die Plugin-Optionen.

Lizenz

GPL-2.0-or-later — siehe LICENSE

Name		Name	Last commit message	Last commit date
Latest commit History 218 Commits
.github		.github
assets		assets
bin		bin
config		config
docs		docs
includes		includes
languages		languages
samples		samples
tests		tests
.gitignore		.gitignore
API.md		API.md
CHANGELOG.md		CHANGELOG.md
CLAUDE.md		CLAUDE.md
DOCUMENTATION.md		DOCUMENTATION.md
E2E_TESTING.md		E2E_TESTING.md
LICENSE		LICENSE
README.md		README.md
SECURITY.md		SECURITY.md
TECHNICAL-SPEC.md		TECHNICAL-SPEC.md
composer.json		composer.json
composer.lock		composer.lock
open-data-wizard.php		open-data-wizard.php
package.json		package.json
playwright.config.js		playwright.config.js
uninstall.php		uninstall.php

Folders and files

Latest commit

History

Repository files navigation