||||
-|-|
| Zusammenfassung | Discourse Doc Categories ermöglicht es, bestimmte Kategorien für Dokumentationseinträge zu reservieren, wodurch zusätzliche Funktionen für diese Kategorien aktiviert werden.
| Repository-Link | https://github.com/discourse/discourse-doc-categories
| Installationsanleitung | So installieren Sie Plugins in Discourse
Beachten Sie, dass sich dieses Plugin noch in der aktiven Entwicklung befindet und noch nicht vollständig abgeschlossen ist.
Funktionen
Das Plugin Discourse Doc Categories ermöglicht es Ihnen, strukturierte Dokumentation auf einem bestehenden Discourse-Forum zu hosten. Es funktioniert, indem bestimmte Kategorien für Dokumentationseinträge reserviert und Funktionen bereitgestellt werden, die das Auffinden spezifischer Dokumentationsthemen erleichtern.
Sie können es in Aktion in der Kategorie Documentation sehen.
Wenn eine Kategorie als Ort für Dokumentation markiert wird, werden für diese Kategorie die folgenden Funktionen aktiviert:
- Ein festgelegtes 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 verarbeitet das Plugin Umleitungen für Websites, die vom eingestellten Docs-Plugin migrieren. Dokumentationslinks von diesem Plugin werden zu ihren bestehenden Themen-URLs umgeleitet, und es gibt eine Einstellung zum Umleiten Ihrer vorherigen Dokumentations-Startseite zu Ihrer Hauptdokumentationskategorie.
Konfiguration
Konfigurationseinstellungen sind unter example.discourse.com/admin/site_settings/category/doc_categories verfügbar. Hier finden Sie die folgenden Einstellungen:
doc categories enabled: Aktivieren Sie dies, um das Doc Categories-Plugin zu aktivieren.doc categories docs legacy enabled: Aktivieren Sie dies, wenn Sie vom veralteten Docs-Plugin migriert haben.doc categories homepage: Mit der vorherigen Einstellung aktiviert, wird die Landingpage des veralteten Docs-Plugins zu dieser URL umgeleitet.
Um anzugeben, welche Kategorien für Dokumentation verwendet werden sollen, weisen Sie ihnen ein Index-Thema zu. Öffnen Sie dazu die Einstellungen der Kategorie, indem Sie auf das 
-Symbol auf der Kategorieseite klicken. Klicken Sie dort 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 erfüllen zwei Zwecke:
- Sie sind eine zentrale Liste aller Themen, die in der Kategorie enthalten sind
- Die mit diesem Plugin enthaltene Seitenleiste wird durch den Inhalt des Index-Themas gefüllt
Formatierung von Index-Themen
Index-Themen können jeden gewünschten Inhalt enthalten. Damit die Seitenleiste korrekt funktioniert, müssen sie eine Aufzählungsliste (oder mehrere Aufzählungslisten) 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 Anzeige des vollständigen Titels in der Seitenleiste ist möglicherweise nicht praktisch, wenn Ihre Titel länger als ein paar Wörter sind. Um kürzere Titel für ein bestimmtes Thema festzulegen, fügen 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 (jeglicher Ebene) über jedem Abschnitt verwenden – diese werden dann in der Seitenleiste in diesen Abschnitten angezeigt.
Hier ist ein Beispiel für ein Index-Thema, um Ihnen den Einstieg zu erleichtern:
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
* Ein anderer Titel: https://discourse.example.com/t/another-topic-with-a-long-title/78
## Zweiter Abschnitt
* Themen-Titel: https://discourse.example.com/t/documentation-topic/98
* https://discourse.example.com/t/new-topic/76
Dieses Beispiel erzeugt eine Dokumentations-Seitenleiste, die wie folgt aussieht:
Sehen Sie sich das Index-Thema Documentation > Site Management an, um ein Beispiel für eine Dokumentationskategorie-Index in Aktion zu sehen: https://meta.discourse.org/t/site-management-index/308032
Pflege von Index-Themen
Während 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 auf Inkonsistenzen innerhalb der Index-Themen hinweisen.
-
Nicht indizierte Themen:
example.discourse.com/admin/reports/doc_categories_missing_topics
Dieser Bericht zeigt alle Themen in den Dokumentationskategorien an, die nicht zum Index hinzugefügt wurden. -
Überflüssige Einträge:
example.discourse.com/admin/reports/doc_categories_extraneous_items
Dieser Bericht zeigt Einträge an, die im Index enthalten sind, aber wahrscheinlich nicht dort hingehören. 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 als dem Index-Thema befindet, in dem es enthalten ist.
Zusätzliche Informationen
Das Hinzufügen der Zeichenkette in:docs zu einem Suchbegriff durchsucht alle Kategorien, die für Dokumentation markiert sind (d. h. sie haben ein Index-Thema zugewiesen).
Die maximale Anzahl von Elementen im Index wird durch die Site-Einstellung Max oneboxes per post festgelegt, die standardmäßig auf 50 steht. Wenn Sie mehr als 50 Index-Elemente benötigen, erhöhen Sie die Zahl in dieser Einstellung.
)
Ich habe erwogen, meine Dokumentationen mit 
