|||
-|-|-|
| Zusammenfassung | Discourse Doc Categories bietet die Möglichkeit, bestimmte Kategorien für Dokumentationen bereitzustellen, wodurch zusätzliche Funktionen für sie aktiviert werden.
| Repository-Link | https://github.com/discourse/discourse-doc-categories
| Installationsanleitung | How to install plugins in Discourse
Beachten Sie, dass sich dieses Plugin in aktiver Entwicklung befindet und noch nicht vollständig abgeschlossen ist.
Funktionen
Das Discourse Doc Categories Plugin ermöglicht es Ihnen, strukturierte Dokumentationen auf einem bestehenden Discourse-Forum zu hosten. Es funktioniert, indem bestimmte Kategorien für Dokumentationen reserviert werden und Funktionen bereitgestellt werden, um das Auffinden spezifischer Dokumentationsthemen zu erleichtern.
Sie können es in Aktion in der Documentation Kategorie sehen.
Wenn eine Kategorie als Speicherort für Dokumentationen markiert wird, werden die folgenden Funktionen für diese Kategorie aktiviert:
- Ein bestimmtes Thema, das als Index für alle Dokumentationsthemen in der Kategorie verwendet wird
- Eine neue Seitenleiste zur Navigation zwischen verschiedenen Themen in der Kategorie, einschließlich integrierter Filter- und Suchfunktionen
- Neue Berichte, die Ihnen helfen, die Integrität der Index-Themen zu wahren
Darüber hinaus behandelt das Plugin Weiterleitungen für Websites, die vom zurückgezogenen Docs-Plugin migriert werden. Dokumentationslinks von diesem Plugin werden zu ihren bestehenden Themen-URLs weitergeleitet, und es gibt eine Einstellung, um Ihre vorherige Dokumentations-Homepage auf Ihre Hauptdokumentationskategorie weiterzuleiten.
Konfiguration
Konfigurationseinstellungen sind unter example.discourse.com/admin/site_settings/category/doc_categories verfügbar. Hier finden Sie die folgenden Einstellungen:
doc categories enabled: Wählen Sie diese Option, um das Doc Categories Plugin zu aktivieren.doc categories docs legacy enabled: Wählen Sie diese Option, wenn Sie vom veralteten Docs-Plugin migriert haben.doc categories homepage: Wenn die vorherige Einstellung aktiviert ist, wird die Landingpage des veralteten Docs-Plugins zu dieser URL weitergeleitet.
Um anzugeben, welche Kategorien für Dokumentationen verwendet werden sollen, weisen Sie ihnen ein Index-Thema zu. Tun Sie dies, indem Sie die Einstellungen der Kategorie durch Klicken auf das 
Symbol auf der Kategorieseite öffnen. Klicken Sie von dort aus auf den Link ‘Einstellungen’ und scrollen Sie nach unten zum Abschnitt ‘Dokumentationsmodus’. Verwenden Sie das Feld ‘Index-Thema’, um das Thema anzugeben, das für den Index der Kategorie verwendet werden soll.
Index-Themen
Die Index-Themen einer Dokumentationskategorie dienen zwei Zwecken:
- Sie sind eine zentrale Liste aller Themen, die in der Kategorie enthalten sind
- Die mit diesem Plugin gelieferte Seitenleiste wird mit dem Inhalt des Index-Themas gefüllt
Formatieren von Index-Themen
Index-Themen können beliebige Inhalte enthalten. Damit die Seitenleiste korrekt funktioniert, müssen sie eine Aufzählung (oder mehrere Aufzählungen) von Dokumentationsthemen enthalten. Dies können einfach die Themen-URLs in einer Liste sein, in diesem Fall zeigt die Seitenleiste den vollständigen Titel für jedes Dokumentationsthema an.
Die Angabe des vollständigen Titels in der Seitenleiste ist möglicherweise nicht praktikabel, wenn Ihre Titel länger als ein paar Wörter sind. Um einen kürzeren Titel für ein bestimmtes Thema festzulegen, stellen Sie der URL einen verkürzten Titel gefolgt von einem Doppelpunkt (
voran. Der gesamte Text vor dem Doppelpunkt wird in der Seitenleiste angezeigt und verlinkt zur Themen-URL.
Sie können Ihr Index-Thema in Abschnitte unterteilen und mehrere Listen mit Überschriften (beliebiger Ebene) darüber verwenden - diese werden dann in der Seitenleiste in diesen Abschnitten angezeigt.
Hier ist ein Beispiel für ein Index-Thema, mit dem Sie beginnen können:
Sie können mit einer optionalen kurzen Beschreibung der Kategorie beginnen.
## Erster Abschnitt
* https://discourse.example.com/t/topic-title/12
* https://discourse.example.com/t/another-topic-title/34
* Kurzer Titel: https://discourse.example.com/t/topic-with-a-long-title/56
* Anderer Titel: https://discourse.example.com/t/another-topic-with-a-long-title/78
## Zweiter Abschnitt
* Thema Titel: https://discourse.example.com/t/documentation-topic/98
* https://discourse.example.com/t/new-topic/76
Dieses Beispiel erzeugt eine Dokumentationsseitenleiste, die wie folgt aussieht:
Sehen Sie sich das Index-Thema Documentation > Site Management für ein Beispiel einer Dokumentationskategorie-Indexierung in Aktion an: https://meta.discourse.org/t/site-management-index/308032
Index-Themen pflegen
Obwohl die Index-Themen nicht automatisch aktualisiert werden, wenn Inhalte in der Kategorie hinzugefügt, entfernt oder bearbeitet werden, enthält das Plugin neue Berichte, die Inkonsistenzen innerhalb der Index-Themen hervorheben.
- Nicht indizierte Themen:
example.discourse.com/admin/reports/doc_categories_missing_topics
Dieser Bericht zeigt alle Themen in den Dokumentationskategorien an, die nicht in den Index aufgenommen wurden. - Fremde Elemente:
example.discourse.com/admin/reports/doc_categories_extraneous_items
Dieser Bericht zeigt Elemente an, die im Index enthalten sind und dort nicht hingehören sollten. Der Bericht gibt den Grund an, warum das Thema in den Bericht aufgenommen wurde - zum Beispiel, wenn es gelöscht wurde oder sich in einer anderen Kategorie befindet als die Index-Thema, in das es aufgenommen wurde.
Zusätzliche Informationen
Das Hinzufügen der Zeichenfolge in:docs zu einem Suchbegriff durchsucht alle Kategorien, die für die Dokumentation markiert sind (d. h. sie haben ein zugewiesenes Index-Thema).
Die maximale Anzahl von Elementen im Index wird durch die Site-Einstellung Max oneboxes per post festgelegt, die standardmäßig auf 50 gesetzt ist. Wenn Sie mehr als 50 Index-Elemente benötigen, erhöhen Sie die Zahl in dieser Einstellung.
)
Ich habe erwogen, meine Dokumentationen mit 
