README

Backend-Hinweise als Inhaltselement und Formularfeld für Contao ab Version 5.7.

Das Bundle ermöglicht es, Hinweise und Arbeitsanweisungen direkt im Contao-Backend zu hinterlegen. Die Hinweise dienen ausschliesslich Redakteuren und Administratoren und erzeugen keine Ausgabe im Frontend.

Backend Hinweise ist inspiriert von der Erweiterung do-while/contao-ce_be_remarks von Hagen Klemp.

Funktionen

Backend-Hinweis als Inhaltselement
Backend-Hinweis als Formularfeld im Formulargenerator
optionale Überschrift
formatierbarer Hinweistext
Auswahl eines passenden Contao-Icons
eigene Darstellung im Contao-Backend
Unterstützung des Dark Mode
keine Ausgabe im Frontend

Voraussetzungen

PHP 8.3 oder höher
Contao 5.7 oder höher

Installation

Das Bundle kann über Composer installiert werden:

composer require berecont/contao-backend-remark-bundle

Anschliessend den Contao-Cache leeren und – falls erforderlich – die Datenbankmigration ausführen.

Verwendung als Inhaltselement

Nach der Installation steht in Contao das Inhaltselement Backend-Hinweis zur Verfügung.

Der Hinweis kann beispielsweise verwendet werden für:

redaktionelle Anweisungen
Hinweise zur Pflege eines Artikels
interne Informationen zu Inhalten
Erinnerungen für Redakteure

Zur Gestaltung stehen eine Überschrift, ein Hinweistext und verschiedene Contao-Icons zur Verfügung.

Das Inhaltselement wird ausschliesslich im Backend dargestellt und erzeugt keine Ausgabe im Frontend.

Verwendung im Formulargenerator

Im Contao-Formulargenerator steht zusätzlich das Formularfeld Backend-Hinweis zur Verfügung.

Damit können Hinweise direkt zwischen den einzelnen Formularfeldern platziert werden, beispielsweise um die Bearbeitung komplexerer Formulare im Backend zu erläutern.

Auch dieses Element wird ausschliesslich im Backend angezeigt und ist nicht Bestandteil des im Frontend ausgegebenen Formulars.

Icons

Für Backend-Hinweise können verschiedene Icons aus dem Contao-Backend ausgewählt werden, unter anderem:

Information
Frage
Achtung
Stopp
Fehler
Bearbeitung
OK
Abbrechen
Hinzufügen
Sichtbar
Favorit
Sperre

Die Icons werden aus dem jeweiligen Contao-Backend-Theme verwendet.

Templates

Das Bundle verwendet Twig-Templates.

Inhaltselement:

content_element/backend_remark.html.twig

Formularfeld:

form_backend_remark.html.twig

Eigene Templates können über die in Contao vorgesehenen Template-Funktionen verwendet werden.

Backend-Styling

Die Darstellung der Hinweise und der Icon-Auswahl erfolgt über die mitgelieferte CSS-Datei:

bundles/contaobackendremark/css/remarkstyle.css

Die Styles werden ausschliesslich im Contao-Backend eingebunden.

Frontend-Ausgabe

Backend-Hinweise sind bewusst rein redaktionelle Elemente.

Sowohl das Inhaltselement als auch das Formularfeld erzeugen im Frontend keine Ausgabe. Es werden somit auch keine leeren Hinweis-Container oder versteckten DIV-Elemente ausgegeben.

Lizenz

Dieses Bundle ist unter der GNU Lesser General Public License v3.0 or later (LGPL-3.0-or-later) veröffentlicht.

Siehe LICENSE.

Autor

Bernhard Renner https://berecont.at
https://werbepanorama.at

berecont / contao-backend-remark-bundle

Package info

Security

Statistics