Wissen teilen.
Arbeit erleichtern.
Mit UserGuide stellen Sie Ihren Redakteuren, Teams oder Kunden leicht verständliche Anleitungen direkt im Contao-Backend zur Verfügung – übersichtlich strukturiert, individuell gestaltbar und jederzeit erweiterbar. Die Inhalte können in Kategorien organisiert, gegliedert und optisch mit Icons versehen werden.
Ob kurze Hilfetexte oder detaillierte Schritt-für-Schritt-Erklärungen:
Mit UserGuide wird Contao für alle Benutzer einfach selbsterklärend.
Wir sind Contao Premium-Partner!
Als Contao Premium-Partner unterstützt Sie NetGroup® bei allen Contao-Fragen und -Projekten.
Von NetGroup. Für die Contao-Community.
Features des UserGuides
Installation
Bequem über den Contao Manager: netgroup/userguide .
Oder via Composer: composer require netgroup/userguide .
Nach der Installation steht UserGuide direkt im Backend zur Verfügung.
Verwendung
Eine Anleitung besteht aus mehreren in Contao verwalteten Abschnitten, die in Markdown verfasst und mit InsertTags für dynamische Inhalte wie Bilder oder Links ergänzt werden können.
Icons
Zur besseren Orientierung lassen sich Icons aus der Sammlung Font Awesome für einzelne Abschnitte auswählen.
Kategorien & Filter
Weisen Sie Inhalte individuellen Kategorien (Themen, Zielgruppen oder Projekte) zu, um auch bei vielen Einträgen den Überblick zu behalten und gezielt zu filtern.
Bearbeitung sperren
Schützen Sie Anleitungen oder einzelne Abschnitte vor Änderungen. Die Inhalte bleiben sichtbar, sind aber nicht mehr editierbar – ideal für freigegebene Dokumentationen oder Schulungsunterlagen.
Voraussetzungen & Lizenz
PHP: ^8.2
Contao: ^4.13 | ^5.0
UserGuide steht unter der Apache 2.0 Lizenz und kann frei verwendet, angepasst und erweitert werden.
Fragen zum UserGuide?
Haben Sie Fragen zum UserGuide?
Melden Sie sich gern bei uns. Wir beraten Sie – schnell, unkompliziert und unverbindlich!
Häufige Fragen
UserGuide eignet sich für Teams, Redakteure und Kunden, die schnelle Hilfestellungen, Schritt-für-Schritt-Anleitungen oder interne Dokumentationen benötigen.
So erstellen Sie in wenigen Minuten Ihre erste Anleitung:
- Neue Anleitung anlegen – Titel und Kategorie definieren
- Abschnitte hinzufügen – Texte bequem im Editor schreiben (Markdown-Unterstützung)
- InsertTags nutzen um Bilder, Links oder dynamische Inhalte einzufügen
- Icons zuweisen – für bessere Übersicht und Benutzerfreundlichkeit
Alle Inhalte werden übersichtlich im Contao-Backend dargestellt und können jederzeit erweitert oder angepasst werden.
Kategorien & Filter
Ordnen Sie Ihre Inhalte individuellen Kategorien zu – etwa nach Themen, Zielgruppen oder Projekten.
So behalten Sie auch bei vielen Einträgen stets den Überblick und ermöglichen ein gezieltes Filtern nach Themenbereichen.
Bearbeitung sperren
Schützen Sie Anleitungen oder einzelne Abschnitte vor Änderungen.
Die Inhalte bleiben sichtbar, sind aber nicht mehr editierbar – ideal für freigegebene Dokumentationen oder Schulungsunterlagen.
Hinweis: Die Sperrung kann nur direkt über die Datenbank aufgehoben werden.
Einzelne Anleitungen oder Abschnitte lassen sich zur Sicherung vor ungewollten Änderungen sperren. Sie sind dann weiterhin sichtbar, aber nicht mehr bearbeitbar. Dies ist sinnvoll, wenn man Anleitungen weitergeben will, diese aber nicht bearbeitet werden sollen.
Hinweis:
Die Sperrung kann nur direkt über die Datenbank aufgehoben werden.
Bei der entsprechenden Anleitung muss in der Tabelle "tl_manuals" die "1" im Feld "locked" entfernt werden.
Markdown ist eine leicht verständliche Auszeichnungssprache, mit der sich Texte schnell und übersichtlich formatieren lassen. Sie wurde entwickelt, um Inhalte einfach lesbar und gleichzeitig in HTML konvertierbar zu machen. Besonders für Dokumentationen, Readme-Dateien oder Notizen ist Markdown sehr beliebt.
Vorteile von Markdown
- Einfach zu erlernen – schon wenige Regeln reichen für den Einstieg aus.
- Gut lesbar – selbst ohne Formatierung sieht der Text klar und strukturiert aus.
- Plattformunabhängig – funktioniert in vielen Editoren, Webseiten und Tools wie GitHub, Notion oder Obsidian.
Die Grundidee
Statt HTML wie <h1>Überschrift</h1> zu schreiben, nutzt man einfache Symbole, die den Text formatieren. Das macht Markdown sehr lesbar im Rohtext und leicht zu bearbeiten. Hier die gängisten Beispiele:
- Überschrift 1: # Überschrift 1
- Überschrift 2: ## Überschrift 2
- Fett: **fetter Text**
- Kursiv: *kursiv*
Links zum Thema
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.
Getestete Versionen
Die Erweiterung wurde erfolgreich mit folgenden Kombinationen aus PHP und Contao getestet:
| Contao | PHP 8.2 | PHP 8.3 | PHP 8.4 |
|---|---|---|---|
 |
✓ | ✓ | ✓ |
 |
✓ | ✓ | ✓ |
 |
✓ | ✓ | ✓ |
 |
✓ | ✓ | ✓ |
 |
✓ | ✓ | ✓ |
 |
✓ | ✓ | ✓ |
 |
✓ | ✓ | ✓ |