English Version

Zurück zur Übersicht

Wiki.js Plugin: Arbeitsabläufe

Diese Dokumentation bezieht sich immer auf die aktuellste veröffentlichte Version.

Eine bestehende Seite sicher aktualisieren

wikijs_update_page ersetzt den kompletten Inhalt. So gehst du vor:

1. Die Seite mit wikijs_get_page laden (Pfad und Locale angeben, der Standard ist en).
2. Den vollständigen Text lokal ändern.
3. Mit wikijs_update_page den gesamten neuen Text senden, dazu isPublished: true.
4. Bei beabsichtigter starker Kürzung zusätzlich confirmContentShrink: true.
5. Die Seite erneut lesen und das Ergebnis prüfen.

Seiten mit mehr als 100.000 Zeichen liefert wikijs_get_page gekürzt. Ein Update würde den gekürzten Text samt Hinweis zurückschreiben. Bearbeite solche Seiten nicht über dieses Tool.

Doku neu erstellen mit docs-wiki

graph TD
    A["docs-wiki starten"] --> B["Projekttyp und Projekt klären"]
    B --> C["Inventar aus dem Code"]
    C --> D["Hub und Unterseiten erzeugen, DE und EN"]
    D --> E["source-check"]
    E --> F["translation-check"]
    F --> G["Publish: Unterseiten, dann Hub"]
    G --> H["updatedAt lesen und wikijs_mark_verified"]

1. /wikijs-plugin:docs-wiki aufrufen und Projekttyp, Projekt und Modus angeben.
2. Der Skill baut ein Inventar aus dem Code und plant Hub und Unterseiten.
3. Source-Check und Translation-Check laufen über den gesamten Seitensatz. Bei FAIL wird korrigiert, bei WARN entscheidest du.
4. Zuerst werden die DE-Unterseiten, dann der DE-Hub angelegt, danach EN, zuletzt die Kategorie-Karte.
5. Jede Seite wird mit isPublished: true und dem Git-Stand des Projekts (sourceRepo, sourceRef, summary) geschrieben.
6. Nach dem Publish wird je Seite und Sprache updatedAt gelesen und der geprüfte Ref markiert.

Bestehende Doku prüfen (Baseline)

/wikijs-plugin:source-check baseline

Der Lauf verändert keine Seite. Er markiert bestandene Seiten und berichtet Fundstellen. Korrigiert wird anschließend über den normalen docs-wiki-Update-Ablauf.

Updates aus dem Code-Diff

Hat eine Seite einen gültigen verifizierten Ref (wikijs_get_verified_refs, page_updated_at passt zum Live-updatedAt), liest source-check nur die seitdem geänderten Dateien und die geänderten Textabschnitte. Ohne gültigen Ref wird die ganze Seite geprüft, und dieser Lauf wird die neue Baseline.

Einzelseite zu Hub und Unterseiten umbauen

1. DE und EN laden und die Abschnitte inventarisieren.
2. Jedem Abschnitt genau eine Zielseite zuweisen, kein Abschnitt darf entfallen.
3. Source-Check und Translation-Check über den fertigen Seitensatz.
4. Unterseiten anlegen, danach den Hub mit wikijs_update_page auf die Kurzfassung reduzieren (confirmContentShrink: true).
5. Eingehende Links reparieren und die Kategorie-Karte auf die Unterseiten umstellen.

Historie und verified-Marker lesen

Seiten suchen und verschieben

1. Mit wikijs_search_pages die betroffenen Seiten finden.
2. Je Seite wikijs_move_page mit destinationPath aufrufen.
3. Verweise in anderen Seiten und in Kategorie-Seiten nachziehen. Historie und verified-Marker bleiben beim alten Pfad.

Hintergründe zu Datenbank und Server stehen auf der Seite Technik.