Dokumentation in die Wissensdatenbank importieren

Aktualisiert am 19 Nov. 2026 6 Min. Lesezeit

Feedback gespeichert.

Ticketix-Artikel durchsuchen

Administratoren können Produktdokumentation aus einer einzigen ZIP-Datei mit Markdown-Dokumenten und Bildern in die Wissensdatenbank importieren. Wird dieselbe ZIP-Datei später erneut importiert, werden die Artikel aktualisiert.

So finden Sie es: Inhalt → Wissensdatenbank, Schaltfläche Dokumente importieren (nur Administratoren).

Bevor Sie beginnen

  • Prüfen Sie die PHP-Upload-Grenzen Ihres Servers. upload_max_filesize und post_max_size müssen größer als die ZIP-Datei sein. Einrichtung → System → Werkzeuge, Bereich Übersicht, zeigt beide Werte an.
  • Planen Sie Ihre Kategoriepfade: ein Produkt und seine Abschnitte, zum Beispiel Ticketix/Getting Started, Ticketix/Features und Ticketix/FAQ.

Was in die ZIP-Datei gehört

Die Beispiele auf dieser Seite verwenden die Struktur dieser Dokumentation, die auf dieselbe Weise importiert wird:

categories.json
articles/
  ticketix-introduction.md
  ticketix-install.md
images/
  ticketix-ai-connections-screenshot.webp
  • categories.json (optional) listet die Kategorien auf.
  • .md-Dateien sind die Artikel. Sie können in jedem Ordner liegen; Dateien, deren Name mit _ beginnt, sowie README.md-Dateien werden übersprungen.
  • Bilder können in jedem Ordner liegen. Jeder Artikel verweist auf sie mit einem Pfad relativ zu seiner eigenen .md-Datei.

Wenn Sie einen Ordner zippen und sich alles in diesem einen Ordner befindet, liest Ticketix die Dateien darunter.

categories.json

Eine Liste von Kategorien. path ist erforderlich; die anderen Felder sind optional.

[
  {"path": "Ticketix", "slug": "ticketix", "description": "Documentation for Ticketix.", "order": 100},
  {"path": "Ticketix/Getting Started", "slug": "ticketix-getting-started", "description": "Install and set up Ticketix.", "order": 10}
]
  • path ist ein Produkt und sein Abschnitt, getrennt durch /. Fehlende übergeordnete Kategorien werden angelegt.
  • slug, description und order gelten für den letzten Teil des Pfads. Niedrigere order-Werte kommen zuerst.

Front Matter der Artikel

Jede .md-Datei beginnt mit Front Matter zwischen zwei ----Zeilen, gefolgt vom Markdown-Inhalt:

---
title: Install Ticketix
slug: ticketix-install
category: Ticketix/Getting Started
order: 30
excerpt: Upload the installation package and run the setup.
tags: install, setup
status: published
visibility: public
---

The body of the article starts here.
FeldErforderlichBedeutung
titleJaDer Artikeltitel
categoryJaDer Kategoriepfad, zum Beispiel Ticketix/Getting Started; wird angelegt, falls nicht vorhanden
slugNeinDie Adresse des Artikels; wird aus dem Dateinamen übernommen, wenn leer
orderNeinDie Reihenfolge innerhalb der Kategorie
excerptNeinEine Zusammenfassung als reiner Text
tagsNeinKommagetrennte Schlagwörter
statusNeinpublished (Standard) oder draft
visibilityNeinpublic (Standard) oder internal
langNeinDie Sprache des Artikels, zum Beispiel en, tr oder de (siehe „Übersetzungen importieren“ unten)

Verwendbares Markdown

  • Überschriften mit #. Der Artikeltitel ist die Seitenüberschrift, daher werden # und ## beide zu Abschnittsüberschriften.
  • Absätze, **bold**, *italic* und Inline-Code.
  • Codeblöcke zwischen drei Backticks.
  • Einstufige Aufzählungslisten und nummerierte Listen.
  • Tabellen mit |-Spalten.
  • Hinweise mit > am Zeilenanfang.
  • Horizontale Linien.
  • Links. Verlinken Sie einen anderen Artikel mit kb: und seinem Slug, zum Beispiel [Write and publish Knowledge Base articles](kb:ticketix-knowledge-base).
  • Bilder mit einem Pfad relativ zur .md-Datei, zum Beispiel ![Ticketix AI settings screen](../images/ticketix-ai-connections-screenshot.webp).

Bilder müssen im Format PNG, JPEG, GIF oder WebP vorliegen und jeweils höchstens 5 MB groß sein. In Artikeln werden nur von Ticketix gespeicherte Bilder angezeigt; fügen Sie daher jedes Bild der ZIP-Datei bei. Dasselbe Bild wird nur einmal gespeichert, auch wenn mehrere Artikel es verwenden.

Import ausführen

  1. Öffnen Sie Inhalt → Wissensdatenbank und klicken Sie auf Dokumente importieren.
  2. Prüfen Sie die Standardsprache: die Sprache von Dateien, die keine angeben (Englisch, sofern Sie keine andere wählen). Ziehen Sie die ZIP-Datei in das Fenster oder wählen Sie sie aus. Noch wird nichts geändert.
  3. Ticketix prüft die ZIP-Datei und zeigt, was passieren würde: die Anzahl der Artikel Neu, Aktualisiert und Unverändert, Kategorien und Bilder, dieselben Zahlen für jede Sprache, die Artikel, die Werden erstellt oder aktualisiert, und die Dateien, die nicht importiert werden können, mit dem Grund, zum Beispiel ein fehlendes Bild oder ein fehlender title.
  4. Klicken Sie auf … Änderungen importieren, um sie zu übernehmen, oder auf Abbrechen.
  5. Lesen Sie das Ergebnis, zum Beispiel „Import abgeschlossen: 19 erstellt, 0 aktualisiert, 0 unverändert, 4 Kategorien geändert, 20 neue Bilder.“

Ein Fehler in einer Datei hält die anderen nicht auf. Korrigieren Sie die Datei und importieren Sie die ZIP-Datei erneut. Wenn Sie nach der Prüfung zu lange warten, bittet Ticketix Sie, die Datei erneut auszuwählen.

Dokumentation aktualisieren

Importieren Sie die neue Version der ZIP-Datei. Artikel werden anhand von Slug und Sprache zugeordnet:

  • Ein neuer Slug erstellt einen neuen Artikel.
  • Ein vorhandener Slug aktualisiert den Artikel derselben Sprache. Der vorherige Text bleibt in seinem Revisionsverlauf erhalten, mit der Änderungsnotiz „Importiert aus“ und dem Dateinamen.
  • Ein Artikel, dessen Inhalt sich nicht geändert hat, wird als unverändert gezählt.

Ein Import löscht nichts. Um einen Artikel zu entfernen, archivieren Sie ihn in der Artikelliste oder auf seiner Seite.

Übersetzungen importieren

Eine Übersetzung hat denselben Slug wie ihr englisches Original und eine andere Sprache. Importieren Sie Übersetzungen mit einer eigenen ZIP-Datei nach der englischen Dokumentation, zum Beispiel:

de_DE/
  categories.json
  articles/
    ticketix-install.md
  images/
    ticketix-ai-connections-screenshot.webp
  • Die Sprache einer Datei ist ihre lang:-Zeile, zum Beispiel lang: de; andernfalls ihr Sprachordner auf oberster Ebene der ZIP-Datei (tr/, tr_TR/ und de_DE/ ergeben tr und de); andernfalls die Standardsprache des Imports. Jede andere Sprache als Englisch, Arabisch, Türkisch, Japanisch und Deutsch macht diese Datei zu einem Fehler.
  • Eine Übersetzung übernimmt Kategorie und Reihenfolge ihres englischen Originals; die Zeilen category und order der Datei werden nicht verwendet. Eine Übersetzung ohne visibility-Zeile ist nur für Mitarbeiter sichtbar, wenn ihr Original es ist. Der englische Artikel ändert sich nicht.
  • Eine Übersetzung ohne englisches Original wird als eigenständiger Artikel importiert, und die Prüfung führt sie als Warnung auf.
  • Eine categories.json in einem Sprachordner oder auf oberster Ebene einer ZIP-Datei, deren Artikel alle in einer anderen Sprache als Englisch sind, findet jede Kategorie über ihren englischen path und schreibt nur den Namen (title, optional) und die description dieser Sprache. Englischer Name, Reihenfolge und übergeordnete Kategorie bleiben unverändert.
  • Fügen Sie die Bilder hinzu, die die übersetzten Artikel verwenden. Ein bereits gespeichertes Bild, zum Beispiel aus der englischen Dokumentation, wird nicht erneut gespeichert.

Ein übersetzter Eintrag in categories.json:

[
  {"path": "Ticketix/Getting Started", "slug": "ticketix-getting-started", "title": "Erste Schritte", "description": "Ticketix installieren und einrichten."}
]

Was Besucher sehen, erfahren Sie unter Sprachen und übersetzte Inhalte.

Grenzen

GrenzeWert
Dateien in der ZIP-DateiBis zu 2.000
Gesamtgröße nach dem EntpackenBis zu 200 MB
BildgrößeBis zu 5 MB pro Bild
BildtypenPNG, JPEG, GIF und WebP

Aus Sicherheitsgründen lehnt Ticketix eine ZIP-Datei ab, die absolute Pfade oder Pfade mit .. enthält.

Verwandte Artikel

Auf dieser Seite

Ticket senden

Erstellen Sie eine neue Supportanfrage, ohne ein Portalkonto zu benötigen.

Priorität
Anhänge
Nur Sie und unser Team sehen ein Ticket. Senden Sie niemals Passwörter oder Lizenzcodes.

Ticket verfolgen

Verwenden Sie die Ticketnummer und das Passwort aus Ihrer Bestätigungs-E-Mail.

Die Nummer und das Passwort finden Sie in Ihrer Bestätigungs-E-Mail.

Anmelden

Greifen Sie auf Ihr Konto im Support-Portal zu.

Neu hier?

Konto erstellen

Erstellen Sie Ihr Konto für das Support-Portal.

Sie haben bereits ein Konto?

Passwort vergessen?

Wir senden Ihnen per E-Mail einen Link, um ein neues Passwort zu wählen.

Verlauf

War das hilfreich?
Ganzen Artikel öffnen
↑ ↓ zum NavigierenEnter zum ÖffnenEsc zum Schließen