Markdown Support
osTicket-Plugin Markdown Support: Markdown als zusätzliches Format für Ticket-Antworten und Notizen mit Toolbar, Live-Vorschau, Bild-Upload, Textbaustein-Konvertierung und XSS-Schutz über Parsedown SafeMode.
Markdown Support
Live Demo: Teste alle Plugins für OXID eShop, Shopware und osTicket von Markus Michalski live, ohne Installation und ohne Risiko. demo.markus-michalski.net
Überblick
Das Plugin fügt osTicket 1.18.x das Thread-Format Markdown hinzu. Antworten und Notizen lassen sich dann in Markdown schreiben, mit Toolbar und Live-Vorschau, und werden beim Anzeigen mit Parsedown im SafeMode zu HTML gerendert.
Ohne das Plugin: Antworten und Notizen gibt es nur als Text oder als HTML aus dem WYSIWYG-Editor. Code-Blöcke und strukturierte Texte sind dort umständlich zu erstellen.
Mit dem Plugin: Ein Format-Umschalter bietet Markdown und HTML an. Im Markdown-Modus erscheinen Toolbar, Tastenkürzel, Live-Vorschau und Bild-Upload.
Das Plugin ändert eine osTicket-Core-Datei: Beim Aktivieren wird
include/class.thread.phpgepatcht (mit Backup). Details stehen unter Technische Details.
Dokumentation
| Seite | Inhalt |
|---|---|
| Installation | Voraussetzungen, Dateien, Aktivierung, Update, Deaktivieren und Entfernen |
| Konfiguration | Die Optionen der Plugin-Konfiguration mit Standardwerten |
| Nutzung | Editor, Toolbar, Bild-Upload, Textbausteine, Syntax |
| API-Integration | Format per API setzen, Auto-Erkennung, Zusammenspiel mit API Endpoints |
| Technische Details | Ablauf, Core-Patch, E-Mail-Verarbeitung, Sicherheit, Dateistruktur |
| Fehlerbehebung | Häufige Probleme und häufige Fragen |
Funktionen
| Funktion | Beschreibung |
|---|---|
| Markdown-Format | Thread-Einträge mit dem Format markdown werden mit Parsedown (SafeMode) gerendert |
| Toolbar | Schaltflächen für Fett, Kursiv, Überschrift, Link, Inline-Code, Code-Block, Listen, Zitat, Linie und Bild |
| Tastenkürzel | Strg+B, Strg+I, Strg+K und Strg+H (auf dem Mac Cmd) |
| Live-Vorschau | Serverseitiges Rendering über einen Endpoint, 500 ms nach der letzten Eingabe |
| Format-Umschalter | Wechsel zwischen Markdown und HTML im Editor |
| Bild-Upload | Bilder per Drag & Drop, Einfügen aus der Zwischenablage oder Toolbar-Button, abgelegt als osTicket-Draft-Anhang |
| Textbausteine | HTML-Textbausteine werden im Markdown-Modus clientseitig in Markdown umgewandelt |
| Ausgehende E-Mails enthalten das gerenderte HTML, in der Datenbank bleibt das Markdown | |
| Auto-Erkennung | Optional: Einträge ohne Format-Angabe werden bei erkannter Markdown-Syntax als Markdown gespeichert |
Ablauf
graph TD
A["Agent schreibt im Markdown-Modus"] --> B["POST mit format=markdown"]
B --> C["Plugin rendert das Markdown zu HTML für die E-Mail"]
C --> D["osTicket legt den Eintrag an und versendet die E-Mail"]
D --> E["Plugin schreibt Markdown und Format in die Datenbank zurück"]
E --> F["Anzeige: Parsedown SafeMode und Format::sanitize"]
Anforderungen
| Anforderung | Version | Hinweise |
|---|---|---|
| osTicket | 1.18.x | Ziel-Version laut README und Plugin-Quelltext |
| PHP | 8.0 oder neuer | composer.json deklariert >=7.4, der Code nutzt aber PHP-8.0-Syntax (Typ mixed in ConfigCache). Unter PHP 7.4 treten TypeErrors auf |
| Parsedown | ^1.7 |
Laufzeit-Abhängigkeit über Composer (erusev/parsedown), im Release-ZIP enthalten |
| Browser | JavaScript aktiv | Editor, Toolbar und Vorschau laufen im Browser |
Lizenz
GNU General Public License v2, kompatibel mit osTicket. Siehe LICENSE.
Support
Fehler und Fragen im Issue Tracker. Gib dabei osTicket-Version, PHP-Version, Plugin-Version, Fehlermeldungen aus der Browser-Konsole und die Schritte zur Reproduktion an.