Der Block Knowledge Base Categories ermöglicht es dir, Kategorien aus deiner Dokumentation direkt auf der Startseite als visuelle Karten anzuzeigen. Anstatt von den Lesern zu erwarten, dass sie durch den Kategorienbaum navigieren, um das zu finden, was sie brauchen, bringt dieser Block Ihre wichtigsten Abschnitte nach vorne und bietet den Lesern einen visuellen, klickbaren Überblick darüber, was die Wissensdatenbank enthält, sobald sie auf der Startseite landen.
Der Block der Knowledge Base-Kategorien unterstützt nur Kategorien – nicht einzelne Artikel. Wenn eine Kategorie ausgewählt wird, wird standardmäßig der erste Artikel in dieser Kategorie angezeigt. Eine Kategorie erscheint nur im Block, wenn sie mindestens einen veröffentlichten Artikel enthält.
Wann sollte der Block Wissensdatenbank-Kategorien verwendet werden
- Große Wissensbasen – Wenn Ihre Dokumentation viele Kategorien enthält, hilft es den Lesern, die wichtigsten als Startkarten zu zeigen, die Leser direkt navigieren müssen, ohne im Kategorienbaum suchen zu müssen.
- Mehrere Audience-Typen – Verwenden Sie separate Karten für "Start", "API-Referenz" und "Fehlerbehebung", um verschiedene Lesertypen sofort zum richtigen Bereich zu routen.
- Berechtigungsbewusste Navigation – Im Gegensatz zu statischen Links oder benutzerdefiniertem HTML respektiert dieser Block die Zugriffsrechte des Lesers. Leser sehen nur die Kategoriekarten, auf die sie zugreifen dürfen, wodurch 404-Fehler für eingeschränkte Inhalte vermieden werden.
- Ersetzung einer Inhaltsverzeichnis-Einleitung – Anstatt eine Textliste der Hauptabschnitte zu schreiben, lassen Sie die Kategoriekarten die Arbeit visuell erledigen.
Wie man einen Block für Wissensdatenbank-Kategorien einfügt
- Navigiere zu () in der linken Navigationsleiste des Knowledge Base-Portals.
- Im linken Navigationsfenster navigieren Sie zur Knowledge base site > Site-Anpassung.
- Klicken Sie auf die Schaltfläche "Website anpassen ".
- Wählen Sie im linken Dropdown-Menü Startseite aus. Der Abschnitt "Körper" zeigt die Liste der Körperblöcke an.
- Klicken Sie auf Abschnitt Hinzufügen und wählen Sie die Kategorien der Wissensdatenbank. Der Block wird zur Liste hinzugefügt.
- Klicken Sie auf den Block Kategorien der Wissensbasis , um den Abschnittstitel und die Gesamtsymbolfarbe zu bearbeiten.
- Klicken Sie auf Element hinzufügen , um Kategoriekarten zum Block hinzuzufügen.
- Wählen Sie die gewünschten Kategorien aus Ihrer Wissensdatenbank aus. Verwenden Sie die Option Filterkategorie , um nach Namen zu suchen.
- Verwenden Sie das Symbol "Reordering ()", um Elemente neu zu ordnen. Die Symbole Umordnen und Verstecken () erscheinen, wenn du über einen Körperblock fährst.
Wie man Kategorienelemente konfiguriert
Klicken Sie auf ein beliebiges Kategorieelement, um die folgenden Attribute zu bearbeiten:
| Attribut | Was du konfigurieren kannst |
|---|---|
| Ikone | Klicken Sie auf Ändern , um ein Document360- oder Font Awesome-Symbol aus dem Icons-Tab auszuwählen, oder laden Sie die URL eines benutzerdefinierten Bildes im Bild-Tab hoch/geben Sie die URL eines eigenen Bildes ein |
| Titel | Geben Sie einen Anzeigetitel für die Kategoriekarte ein |
| Ikonenfarbe | Wähle eine Farbe für das Symbol aus |
| Absatztext | Fügen Sie eine kurze Beschreibung mit Markdown-Syntax hinzu |
| Textfarbe | Wählen Sie die Textfarbe für Titel und Absatz aus |
Verwenden Sie quadratische Bilddateien (z. B. 30×30px oder 50×50px) für benutzerdefinierte Symbole, um Verzerrungen zu vermeiden.
Wie man speichert und veröffentlicht
- Nutzen Sie rechts den Schalter Vorschau, um Ihre Änderungen zu überprüfen.
- Klicken Sie auf Speichern , um Ihre Änderungen zu speichern.
- Klicken Sie auf Veröffentlichen , um Änderungen live zu machen..
Best Practices
- Stellen Sie Ihre meistbesuchten Kategorien hervor – überprüfen Sie Ihre Analysen, um herauszufinden, welche Kategorien die Leser am häufigsten nutzen, und stellen Sie diese zuerst hervor.
- Halte die Kartenbeschreibungen kurz – ein Satz pro Karte reicht. Längere Absatztexte überladen das Kartenlayout.
- Verwende konsistente Symbolstile – das Mischen von Symboltypen über Karten im selben Block wirkt inkonsistent. Bleib bei Document360-Icons, Font Awesome-Icons oder benutzerdefinierten Bildern.
- Bestellen Sie Karten nach Leserreise – setzen Sie grundlegende Kategorien (Einstieg, Installation) vor fortgeschrittene (API-Referenz, Fehlerbehebung), um neue Leser auf natürliche Weise zu führen.
- Verwenden Sie diesen Block anstelle von benutzerdefiniertem HTML für Kategorienlinks – der eingebaute Block respektiert die Leserberechtigungen; statische Links in benutzerdefiniertem HTML tun das nicht.
FAQ
Wie entferne ich den Block Wissensdatenbank-Kategorien?
Navigiere zu {{variable. Einstellungen}} () > {{variable. Knowledge Base Site}} > Site-Anpassung und klicke auf Site anpassen. Wählen Sie im linken Dropdown-Menü Startseite aus. Wählen Sie den gewünschten Block der Wissensdatenbank-Kategorien im Abschnitt "Body" aus. Klicken Sie unter der Navigationsleiste auf Löschen () und dann auf Ja im Bestätigungsprompt Löschen. Um ein bestimmtes Kategorie-Element zu löschen, wählen Sie das Element aus und folgen Sie denselben Schritten. Klicken Sie auf Speichern und dann auf Veröffentlichen, um die Änderungen anzuwenden.
Warum kann ich den Titel der Kategorien im Block der Wissensdatenbank nicht bearbeiten?
Kategoriekarten in diesem Block sind direkt mit den Kategorien in deinem Dokumentationsbereich verknüpft – ihre Titel spiegeln die tatsächlichen Kategorienamen wider und können innerhalb des Blocks nicht geändert werden. Nur das Absatz-Textfeld ist hier bearbeitbar.
Um eine Kategorie umzubenennen, navigiere zu {{variable. Dokumentation}} () in der linken Navigationsleiste. Im Bereich Kategorien und Artikel finden Sie die Kategorie, klicken Sie auf das Symbol Mehr () daneben und wählen Sie Namen umbenennen oder doppelklicken Sie auf den Kategoriennamen, um sie inline zu bearbeiten. Drücken Sie Enter zum Speichern.
Gibt es eine Begrenzung für die Anzahl der Kategorienblöcke, die ich der Startseite hinzufügen kann?
Nein – es gibt keine Begrenzung für die Anzahl der Wissensdatenbank-Kategorienblöcke, die du der Startseite hinzufügen kannst.
Kann ich Kategoriekarten nur Lesern zeigen, die Zugang dazu haben?
Ja. Der Block der Wissensdatenbank-Kategorien respektiert automatisch die Leserrechte – die Leser sehen nur die Kategoriekarten, auf die sie berechtigt sind. Deshalb wird dieser Block gegenüber statischen Links oder benutzerdefiniertem HTML empfohlen, um Kategorien auf der Startseite zu zeigen. Wenn Kategorien über benutzerdefiniertes HTML oder fest kodierte Links hinzugefügt werden, erscheinen diese Links für alle Leser unabhängig von Berechtigungen, was zu 404-Fehlern für Leser ohne Zugriff führen kann.