netgroup/userguide

Es handelt sich um eine Erweiterung für das Open Source CMS Contao. Sie stellt eine Möglichkeit zur Verfügung, um im Backend Anleitungen für die Nutzer zur Verfügung zu stellen. Für jede Anleitung können eingene Kategorien für die Texte angelegt werden.

1.0.2 2025-09-29 07:23 UTC

Requires

• php: ^8.2
• contao/core-bundle: ^4.13 || ^5.0

Requires (Dev)

• contao/test-case: ^5.3
• phpunit/phpunit: ^9.6
• roave/security-advisories: dev-master

proprietary

• NetGroup GmbH

README

Beschreibung

UserGuide ist eine Erweiterung für das Open Source CMS Contao, die es Administratoren ermöglicht, hilfreiche Anleitungen direkt im Backend bereitzustellen. Die Inhalte können in Kategorien organisiert, übersichtlich gegliedert und optisch mit Icons versehen werden – ideal für Teams, Redakteure oder Kunden.

Ob kurze Hilfetexte oder umfassende Schritt-für-Schritt-Erklärungen: Mit UserGuide wird die Contao-Installation selbsterklärend.

Autor

NetGroup GmbH - Patrick Froch [e-mail]

Voraussetzungen

• PHP: ^8.2
• Contao: ^4.13 | ^5.0

Installation

Die Erweiterung kann bequem über den Contao Manager installiert werden. Einfach nach netgroup/userguide suchen.

Alternativ via Composer:

composer require netgroup/userguide

Verwendung

Eine Anleitung besteht aus mehreren Abschnitten, die in der Contao-typischen Benutzeroberfläche verwaltet werden können. Jeder Abschnitt ist ein eigenständiger Text, der in Markdown verfasst wird. Zusätzlich können InsertTags verwendet werden – etwa um Bilder oder Links dynamisch einzufügen.

Icons

Zur besseren Orientierung lassen sich Icons aus der Sammlung Font Awesome Free für einzelne Abschnitte auswählen.

Kategorien

Abschnitten kann eine Kategorie zugewiesen werden, die pro Anleitung individuell definiert werden können. So ist auch bei vielen Inhalten ein optimaler Überblick gewährleistet und es kann gezielt filtert werden.

Bearbeitung sperren

Einzelne Anleitungen oder Abschnitte lassen sich zur Sicherung vor ungewollten Änderungen sperren. Sie sind dann weiterhin sichtbar, aber nicht mehr bearbeitbar.

⚠️ Hinweis: Die Sperrung kann nur direkt über die Datenbank aufgehoben werden.

Dies ist sinnvoll, wenn man Anleitungen weitergeben will, diese aber nicht bearbeitet werden sollen.

Ausgabe

Die Ausgabe geschieht direkt im Backend:

Mitwirken

Beiträge sind herzlich willkommen! Bitte erstellen Sie bei größeren Änderungen zunächst ein Issue, um die geplanten Anpassungen zu besprechen.

Pull Requests sollten mit entsprechenden Tests ergänzt werden.

Tests

Tests können mit folgendem Skript im Wurzelverzeichnis der Erweiterung ausgeführt werden:

./build/runtests.sh

Getestete Versionen

Die Erweiterung wurde erfolgreich mit folgenden Kombinationen aus PHP und Contao getestet:

Contao
	✓	✓	✓
	✓	✓	✓
	✓	✓	✓
	✓	✓	✓
	✓	✓	✓
	✓	✓	✓
	✓	✓	✓

Lizenz

Dieses Projekt steht unter der Apache 2.0 Lizenz.