Download the PHP package diversworld/contao-editorial-workflow without Composer
On this page you can find all versions of the php package diversworld/contao-editorial-workflow. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download diversworld/contao-editorial-workflow
More information about diversworld/contao-editorial-workflow
Files in diversworld/contao-editorial-workflow
Package contao-editorial-workflow
Short Description Contao Editorial Workflow The Contao Editorial Workflow bundle adds a structured content approval process to Contao CMS. Editors can create and modify content in a draft state, submit it for review, and track its approval status. Reviewers and publisher
License GPL-3.0-or-later
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package contao-editorial-workflow
Contao Editorial Workflow
Dieses Modul erweitert Contao um einen strukturierten Redaktions- und Freigabeprozess für Inhalte. Es ermöglicht die Umsetzung des Vier-Augen-Prinzips und stellt sicher, dass Änderungen an Inhalten vor der Veröffentlichung geprüft und freigegeben werden.
Funktionen
- Workflow-Status: Unterstützung verschiedener Status (Entwurf, In Prüfung, Freigegeben, Abgelehnt, Veröffentlicht, Archiviert).
- Vier-Augen-Prinzip: Optionale Prüfung durch eine zweite Instanz.
- Protokollierung: Revisionssichere Historie aller Statusänderungen und Kommentare in der
tl_editorial_workflow_log. - Kommentarfunktion: Review-Hinweise und Begründungen für Statusänderungen direkt am Inhalt.
- Dashboard: Übersicht ausstehender Prüfungen im Backend.
Unterstützte Inhalte
Das Modul integriert sich generisch in folgende Contao-Tabellen:
- Seiten (
tl_page) - Artikel (
tl_article) - Nachrichten (
tl_news) - Events (
tl_calendar_events) - Newsletter (
tl_newsletter) - FAQ (
tl_faq)
Technische Anforderungen
- Contao 5.x
- PHP 8.1+
- Symfony Security Bundle
Installation
-
Installation via Composer:
- Contao Installtool aufrufen oder Datenbank via Manager aktualisieren.
Aktivierung und Nutzung
Um das Modul erfolgreich zu nutzen, sind folgende Schritte erforderlich:
1. Installation und Datenbank-Update
Nach der Installation via Composer müssen die Datenbankfelder angelegt werden. Dies kann über das Contao Installtool
oder den Contao Manager erfolgen. Es werden Felder in den Tabellen der unterstützten Inhaltstypen sowie die neue
Tabelle tl_editorial_workflow_log für die Historie erstellt.
2. Konfiguration (Optional)
Standardmäßig ist das Modul für alle unterstützten Tabellen aktiv und das Vier-Augen-Prinzip ist eingeschaltet. Falls
gewünscht, kann dies in der config/config.yaml angepasst werden:
3. Rollen und Berechtigungen vergeben
Die Steuerung des Workflows erfolgt über das Contao-Berechtigungssystem. Editieren Sie eine Benutzergruppe oder einen Benutzer und vergeben Sie folgende Berechtigungen:
- Erlaubte Felder: Aktivieren Sie unter "Erlaubte Felder" für jede genutzte Tabelle (z.B.
tl_news,tl_page) die Felderworkflow_statusundworkflow_comment. Hinweis: Benutzer mit den Rollen "Prüfer" oder "Publisher" sehen die Felder automatisch, auch wenn diese nicht explizit freigeschaltet wurden. - Workflow-Berechtigungen: Wählen Sie die entsprechenden Rollen aus:
- Prüfer (Reviewer): Darf Inhalte auf "Freigegeben" oder "Abgelehnt" setzen.
- Publisher: Darf Inhalte auf "Veröffentlicht" setzen.
Redakteure ohne diese Rollen können Inhalte erstellen, bearbeiten und den Status auf "In Prüfung" setzen, sofern sie Zugriff auf die Felder haben.
4. Wichtige Hinweise zur Fehlerbehebung
Sollte es im Backend zu einer Fehlermeldung kommen (z.B. Unknown column 'workflow_status'), stellen Sie sicher, dass
Sie das Contao Installtool ausgeführt haben. Das Modul fängt diese Fehler zwar im Dashboard ab, aber für die volle
Funktionalität müssen die Spalten in der Datenbank vorhanden sein.
5. Benachrichtigungen (Notification Center)
Das Modul integriert sich vollständig in das Notification Center.
- Benachrichtigungstyp: Erstellen Sie im Backend eine neue Benachrichtigung. Wählen Sie als Typ einen der unter " Editorial Workflow" gelisteten Typen (z.B. "In Prüfung").
- Tokens: In den Nachrichtentexten können Sie folgende Tokens verwenden:
##workflow_table##: Die betroffene Tabelle (z.B.tl_news).##workflow_id##: Die ID des Datensatzes.##workflow_status##: Der neue Status.##workflow_comment##: Der hinterlegte Kommentar.##workflow_user##: Der Benutzer, der die Änderung vorgenommen hat.##workflow_data_*##: Alle Felder des betroffenen Datensatzes (z.B.##workflow_data_headline##).
- Versand: Sobald ein Redakteur oder Prüfer den Status ändert, werden alle für diesen Typ konfigurierten Benachrichtigungen automatisch versendet.
6. Workflow im Redaktionsalltag
- Erstellung/Bearbeitung: Ein Redakteur bearbeitet einen Inhalt (z.B. eine Nachricht). Er speichert diesen zunächst als "Entwurf".
- Prüfung anfordern: Sobald die Bearbeitung abgeschlossen ist, setzt der Redakteur den Status auf "In Prüfung". Optional kann ein Kommentar für den Prüfer hinterlassen werden.
- Freigabe durch Prüfer: Ein Benutzer mit der Rolle Prüfer sieht den Inhalt (z.B. über das Dashboard oder in der Listenansicht) und kann ihn nach Sichtung auf "Freigegeben" oder "Abgelehnt" setzen. Bei einer Ablehnung sollte ein Grund im Kommentarfeld angegeben werden.
- Veröffentlichung: Ein Benutzer mit der Rolle Publisher kann freigegebene Inhalte auf "Veröffentlicht" setzen. Erst in diesem Status (und wenn das Contao-Feld "Veröffentlichen" aktiv ist) wird der Inhalt im Frontend sichtbar.
7. Historie einsehen
Jede Statusänderung wird revisionssicher protokolliert. In der Listenansicht der jeweiligen Module (z.B. Nachrichten-Liste) kann über das Info-Icon des Datensatzes die Historie der Workflow-Änderungen eingesehen werden.
Lizenz
LGPL-3.0-or-later
Donation
If you like this extension and think it's worth a little donation: You can support me via Paypal.Me:
Donation for Diversworld EditorialWorkflow
Thank You!
