README

Live-Demo: drupal.dokaudit.de · Download: aktuelle Version als ZIP · Composer: dokaudit/drupal-dokaudit · Quellcode: github.com/nlappenbusch/drupal-dokaudit · Lizenz: GPL-2.0-or-later · Änderungen: CHANGELOG.md

Prüft die PDFs der Drupal-Mediathek mit DokAudit auf Barrierefreiheit (PDF/UA-1, WCAG 2.2, BITV 2.0) und ersetzt sie durch die korrigierte Fassung, ohne dass sich etwas an der Website ändert:

Die Datei-Entität (fid) und ihre URI bleiben gleich. Medien, Dateifelder und Links im Text stimmen weiter.
Das Original wird vorher in public://_dokaudit_backup/ gesichert und lässt sich mit einem Klick (oder drush dokaudit:restore <fid>) wiederherstellen.
Ersetzt wird nur, wenn die Punktzahl wirklich steigt (Mindest-Punktgewinn).
Neu hochgeladene oder ersetzte PDFs werden automatisch eingereiht (hook_file_insert/hook_file_update).

Drupal 10.3 und 11, PHP ≥ 8.1, Drush 12/13 für die Konsolenbefehle. Läuft als Demo unter https://drupal.dokaudit.de.

Installation

Empfohlen mit Composer (Paket auf Packagist):

composer require dokaudit/drupal-dokaudit
drush en dokaudit -y        # legt die Tabelle dokaudit_file an

Das Paket hat den Typ drupal-module; in Projekten auf Basis von drupal/recommended-project landet es über composer/installers in web/modules/contrib/dokaudit. Updates wie bei jedem anderen Modul: composer update dokaudit/drupal-dokaudit, danach drush updatedb. Eine neue Version zeigt das Modul außerdem selbst an (Übersicht und Statusbericht).

Ohne Composer: ZIP herunterladen, nach web/modules/custom/ entpacken (Ordner dokaudit) und mit drush en dokaudit -y aktivieren.

Einrichtung

Im DokAudit Hub unter Integrationen → API-Schlüssel einen Schlüssel mit Recht write anlegen. Der Schlüssel gehört zur Organisation: Dokumente erscheinen in deren Hub und werden mit deren Guthaben abgerechnet.
In Drupal unter Konfiguration → Medien → DokAudit API-Adresse und Schlüssel eintragen (ohne Eintrag dort gilt die Umgebungsvariable DOKAUDIT_API_KEY; der Eintrag in den Einstellungen hat Vorrang).
Fertig: Der Abgleich läuft mit jedem Cron-Lauf (abschaltbar), zusätzlich per Schaltfläche oder Drush.

Einstellung	Bedeutung
Modus	prüfen und ersetzen · nur prüfen
Nur diese Ordner / Nie anfassen	relativ zum Dateisystem, z. B. `formulare/, satzungen/`
Mindest-Punktgewinn	erst ab dieser Verbesserung ersetzen (Standard 1)
Uploads je Cron-Lauf	Standard 10
Sicherungsordner	Standard `_dokaudit_backup`
Größere PDFs überspringen	Standard 50 MB

Bedienung

Inhalt → DokAudit (PDF-Barrierefreiheit) (/admin/content/dokaudit, Recht „DokAudit verwalten“): Verbindung und Guthaben, Kennzahlen, Liste aller erfassten PDFs mit Punktzahl vorher/nachher, „Jetzt abgleichen“, „Original wiederherstellen“, „Erneut prüfen“.
Drush:

drush dokaudit:sync --limit=20 --wait=120   # abgleichen und bis zu 2 min auf Ergebnisse warten
drush dokaudit:restore 123                  # Original von Datei 123 zurückspielen

Ablauf je Datei

new → (Upload, Vollautomatik) → submitted → DokAudit prüft, repariert, prüft nach → replaced (ersetzt, Original gesichert) oder checked (nur geprüft / keine Verbesserung). Weitere Zustände: waiting (wartet auf Guthaben), error, restored, skipped. Wird eine Datei während der Verarbeitung neu hochgeladen, verwirft das Modul das Ergebnis und reiht die neue Fassung ein. Abrechnung wie im Hub: 1 Credit je angefangene 5 Seiten.

Datenschutz

Übertragen werden nur die PDF-Dateien selbst (HTTPS, Bearer-Schlüssel). Die Verarbeitung erfolgt auf den Servern von DokAudit (Deutschland) nach dem Auftragsverarbeitungsvertrag der Organisation.

English summary

DokAudit for Drupal checks PDFs in the media library for accessibility (PDF/UA-1, WCAG 2.2, EN 301 549) using the DokAudit service and replaces them in place with the remediated version: file ID, URI and all references stay the same, the original is backed up and can be restored with one click. Requires a DokAudit account and an API key (each key belongs to one organisation and is billed there). Drupal 10.3 and 11, PHP 8.1+, Drush 12/13 for the console commands. Licence: GPL-2.0-or-later.

dokaudit / drupal-dokaudit

Package info

Security

Statistics