Editor-Auswahl in Document360

Die Nutzung des Texteditors in Document360 ist unerlässlich, um Knowledge Base-Artikel effizient zu erstellen und zu verwalten.

Document360 ermöglicht es Ihnen, Artikel in drei vielseitigen Editor-Optionen zu entwerfen:

1. Der Markdown-Editor ermöglicht es Autoren, Syntax und HTML zu verwenden, um Artikel anzupassen.

2. Der WYSIWYG-Editor (What You See Is What You Get) verwendet Rich-Text-Formatierung und enthält eine umfangreiche Formatierungsleiste; Sie dürfen jedoch keinen benutzerdefinierten Code in Artikeln verwenden.

3. Der Advanced WYSIWYG-Editor ist die neueste Ergänzung der Editor-Optionen in Document360 und fungiert als Hybrid zwischen den Markdown- und WYSIWYG-Editoren.

Document360 sorgt für ein benutzerfreundliches Erlebnis, das die Inhaltsklarheit, Konsistenz und Engagement erhöht.  

Markdown-Editor

Der Markdown-Editor verfügt über einen Splitscreen-Arbeitsbereich und Funktionen, die Ihnen helfen, einen Artikel während des Schreibens zu verwalten.

1. Die linke Seite des Bildschirms ist der Ort, an dem man die Markdown-Syntax eingibt und anwendet.

2. Der Vorschaubildschirm auf der rechten Seite ermöglicht es Ihnen, vor der Veröffentlichung zu sehen, wie Ihr Artikel aussehen wird.

3. Der Scroll on zeigt an, dass beide Abschnitte gleichzeitig scrollen. Klicken Sie auf Scrollen , um das automatische Scrollen auszuschalten.

4. Klicken Sie auf die Vorschau, um zu sehen, wie Ihr Artikel auf der Knowledge Base-Website erscheinen wird.

5. Nach der Veröffentlichung finden Sie das Symbol "Link kopieren ()" in der Nähe des Ansichts-in-Knowledge-Base-Symbols ().

Verwenden Sie die Pfeile auf dem Trenner, um eines der beiden Panels des Editors zusammenzuklappen.

Szenarien, in denen der Markdown-Editor empfohlen wird

Der Markdown-Editor bietet eine geführte Flexibilität bei der Erstellung und Anpassung von Artikeln und sorgt für einen einheitlichen Schreibstil und Formatierung in der gesamten Dokumentation. Diese Konsistenz ist entscheidend, um in der Produktdokumentation ein professionelles Erscheinungsbild aufrechtzuerhalten.

Zum Beispiel können Sie Bilder über die Werkzeugleiste einfügen, die folgenden Markdown einfügt:

![Image Alt Text] (Image URL){height="" width=""}.

Du kannst die Bildgröße anpassen, indem du gewünschte Werte hinzufügst (z. B. Höhe="600px", Breite="400px"). Fortgeschrittene Formatierungen, wie Schatten und Grenzen, können mit HTML-Anpassungsschnippeln erreicht werden.

WYSIWYG-Editor

Der WYSIWYG, was für What You See Is What You Get steht, ist ein HTML-basierter Editor, der sich vom Markdown-Editor unterscheidet. Es ermöglicht Ihnen, die tatsächliche Formatierung des Artikels zu sehen, während Sie tippen oder Inhalte einfügen.

Szenarien, in denen der WYSIWYG-Editor empfohlen wird

Wenn Teammitglieder, die zu Artikeln beitragen, mit HTML-basierten Editoren wie WordPress vertraut sind, ist dieser Editor relativ einfach zu bedienen. Außerdem bietet der WYSIWYG-Editor umfangreiche Formatierungsoptionen für Text, Bilder, Videos und mehr in Ihren Dokumentationsartikeln, wenn sie viel Code und Medien enthalten.

HINWEIS

Weitere Informationen finden Sie im Artikel über den WYSIWYG-Editor.

Fortgeschrittener WYSIWYG-Editor

Der leichte und leistungsstarke 'Advanced WYSIWYG Editor' bietet umfangreiche Textbearbeitungsmöglichkeiten und unterstützt Markdown-Syntax, was ein visuelleres und intuitiveres Erlebnis im Vergleich zum Markdown-Editor bietet und gleichzeitig eine Flexibilität ähnlich dem WYSIWYG-Editor beibehält.

Geben Sie den Editor ein / , und eine Liste mit Optionen erscheint. Du kannst nach den Optionen suchen, indem du Befehlsnamen eingibst. Klicken Sie auf den gewünschten Befehl oder drücken Sie die Enter-Taste, um den Befehl auszuwählen.

Szenarien, in denen der Advanced WYSIWYG-Editor empfohlen wird

Angenommen, Sie haben wissensbasierte Artikel, die textzentriert, codelastig und medienreich sind. In solchen Fällen ist der Advanced WYSIWYG-Editor eine flexible Alternative zu Markdown und WYSIWYG. Dies bietet schnelle, syntaxbasierte Bearbeitung ähnlich Markdown sowie breite Text- und Bildformatierungsoptionen wie den WYSIWYG-Editor.

HINWEIS

Weitere Informationen finden Sie im Document360-Hilfeartikel zum Advanced WYSIWYG Editor.

Änderung des Standardeditors auf Projektebene

Um den WYSIWYG/Advanced WYSIWYG-Editor zum Standardeditor zu machen:

1. Navigiere zu Einstellungen () in der linken Navigationsleiste im Knowledge base portal.

2. Im linken Navigationsfenster klicken Sie unter dem Abschnitt Knowledge Base Portal auf Allgemein.

3. Im Bereich Editor wählen Sie Ihren gewünschten Editor aus.

4. Klicken Sie auf Speichern.

HINWEIS

Wenn du den Standard-Editor deines Projekts änderst, werden alle neuen Artikel, die du erstellst, in der Auswahl deines jeweiligen Editors angezeigt.

Wechsel zwischen Markdown - WYSIWYG - Advanced WYSIWYG Editor

Der Markdown-Editor ist der Standard-Editor für alle neuen Projekte und Artikel in Document360. Wenn du den WYSIWYG- oder Advanced WYSIWYG-Editor verwenden möchtest, kannst du auf Projekt- oder Artikelebene darauf umsteigen.

Redakteur wechselt auf Artikelebene

Um die Editoren auf einer individuellen /Kategorie-Seite zu wechseln, folgen Sie den folgenden Schritten

1. Klicken Sie auf der Artikel-/Kategorie-Seite auf das Symbol Mehr () und wählen Sie die Optionen für mehr Artikel.

   Das Einstellungsfeld für Artikel erscheint.

2. Im Editor-Tab wählen Sie Ihren gewünschten Editor aus.

3. Wähle das Kästchen 'Bist du sicher, dass du weitermachen willst?' aus.

4. Klicken Sie auf Speichern.

   Die gleichen Schritte gelten für die API-Dokumentation.

   

HINWEIS

Sobald Sie auf Artikelebene zum Advanced WYSIWYG-Editor gewechselt sind, können Sie den Editorentyp für diesen speziellen Artikel nicht mehr zurücksetzen. Für zukünftige Artikel kann der Benutzer mit der Berechtigung Projekt Einstellungen – Aktualisieren den Standard-Editor über Einstellungen > Knowledge Base-Portal > General > Editor festlegen.

Umgang mit nicht unterstützten HTML-Tags und Attributen im erweiterten WYSIWYG-Editor

Der Advanced WYSIWYG-Editor in Document360 gewährleistet Inhaltssicherheit, indem er nicht unterstützte HTML-Tags und Attribute verwaltet. Anstatt sie zu entfernen, markiert und bewahrt der Editor diese Elemente, damit Nutzer sie überprüfen und korrigieren können.

Wann passiert das?

1. Migration von WYSIWYG zum Advanced WYSIWYG-Editor

   Beim Wechsel zwischen den Editoren werden nicht unterstützte Inhalte automatisch identifiziert und damit Nutzer potenzielle Probleme beheben können.

2. Inhaltsbearbeitung im erweiterten WYSIWYG-Editor

   Wenn nicht unterstützte Tags oder Attribute in der Code-Ansicht hinzugefügt werden, erkennt der Editor sie, markiert sie und markiert sie visuell zur Korrektur.

Was passiert, wenn nicht unterstützte Elemente erkannt werden?

• Der Editor erkennt während des Parsens nicht unterstützte <marquee>HTML-Tags (z. B. , <blink>) und Attribute (z. B. onmouseover, style="text-decoration:blink").

• Diese Elemente werden im Inhalt visuell mit benutzerdefinierten Indikatoren wie Tooltips und Block-Highlights markiert, ohne die Inhaltsstruktur zu stören.

• Im Editor kannst du den Block des gewünschten nicht unterstützten Elements nicht bearbeiten. Nutzer können jedoch mit markierten Elementen interagieren und erhalten Optionen zum Verändern, Entfernen oder Korrigieren dieser Elemente in der Code-Ansicht.