Editor-Auswahlmöglichkeiten in Document360

Pläne, die den Einsatz von Editoren unterstützen

Die Verwendung des Texteditors in Document360 ist für die effiziente Erstellung und Verwaltung von Wissensdatenbankartikeln unerlässlich.

Mit Document360 können Sie Artikel in drei vielseitigen Editoroptionen erstellen:

1. Mit der Markdown editor können Autoren Syntax und HTML verwenden, um Artikel anzupassen.

2. Der WYSIWYG -Editor (What You See Is What You Get) verwendet Rich-Text-Formatierung und enthält eine umfangreiche Formatierungssymbolleiste. Sie können jedoch keinen benutzerdefinierten Code in Artikeln verwenden.

3. Der Advanced WYSIWYG editor ist die neueste Ergänzung der Editoroptionen in Document360 und fungiert als Hybrid zwischen dem Markdown- und dem WYSIWYG-Editor.

Document360 sorgt für eine benutzerfreundliche Erfahrung, die die Klarheit, Konsistenz und Interaktion von Inhalten verbessert.

Markdown-Editor

Der Markdown-Editor verfügt über einen Arbeitsbereich mit geteiltem Bildschirm und Funktionen, mit denen Sie einen Artikel während des Schreibens verwalten können.

1. Auf der linken Seite des Bildschirms können Sie die Markdown-Syntax eingeben und anwenden.

2. Auf dem Vorschaubildschirm auf der rechten Seite können Sie vor der Veröffentlichung sehen, wie Ihr Artikel aussehen wird.

3. Scroll on zeigt an, dass beide Abschnitte gleichzeitig gescrollt werden. Klicken Sie auf Scroll on , um den automatischen Bildlauf zu deaktivieren.

4. Klicken Sie auf Vorschau , um zu sehen, wie Ihr Beitrag auf der Wissensdatenbank-Website angezeigt wird.

5. Nach der Veröffentlichung finden Sie das Symbol Link kopieren () in der Nähe des Symbols In Wissensdatenbank anzeigen ().

Verwenden Sie die Pfeile auf der Trennlinie, um eines der Fenster des Editors zu reduzieren.

Szenarien, in denen der Markdown-Editor empfohlen wird

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

Sie können z. B. Bilder mithilfe der Symbolleiste einfügen, die das folgende Markdown einfügt:

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

Sie können die Bildgröße anpassen, indem Sie die gewünschten Werte hinzufügen (z. B. height="600px" width="400px"). Erweiterte Formatierungen, wie z. B. Schatten und Rahmen, können mit HTML-Anpassungsausschnitten 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 Beitrags anzuzeigen, während Sie Inhalte eingeben oder 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. Wenn Ihre Dokumentationsartikel viel Code und Medien enthalten, bietet der WYSIWYG-Editor außerdem umfangreiche Formatierungsoptionen für Text, Bilder, Videos und mehr.

ANMERKUNG

Weitere Informationen finden Sie im Artikel auf WYSIWYG editor.

Erweiterter WYSIWYG-Editor

Der schlanke und leistungsstarke "Advanced WYSIWYG Editor" bietet Rich-Text-Bearbeitungsfunktionen und unterstützt die Markdown-Syntax, was im Vergleich zum Markdown-Editor eine visuellere und intuitivere Erfahrung bietet und gleichzeitig eine ähnliche Flexibilität wie der WYSIWYG-Editor bietet.

Geben Sie etwas in / den Editor ein, und eine Liste mit Optionen wird angezeigt. Sie können nach den Optionen suchen, indem Sie Befehlsnamen eingeben. Klicken Sie auf den gewünschten Befehl oder drücken Sie die Eingabetaste, um den Befehl auszuwählen.

Szenarien, in denen der erweiterte WYSIWYG-Editor empfohlen wird

Angenommen, Sie verfügen über Wissensdatenbankartikel mit textzentrierten, codelastigen und medienintensiven Artikeln. In solchen Fällen ist der Advanced WYSIWYG-Editor eine flexible Alternative zu Markdown und WYSIWYG. Dies ermöglicht eine schnelle syntaxbasierte Bearbeitung, ähnlich wie bei Markdown, und umfangreiche Text- und Bildformatierungsoptionen wie der WYSIWYG-Editor.

ANMERKUNG

Weitere Informationen finden Sie im Document360-Hilfeartikel zu Advanced WYSIWYG editor.

Ändern des Standardeditors auf Projektebene

So legen Sie den WYSIWYG/Advanced WYSIWYG-Editor als Standardeditor fest:

1. Navigieren Sie im Wissensdatenbank-Portal zu Einstellungen () > Wissensdatenbank-Portal > Allgemein .

2. Wählen Sie im Abschnitt Editor den gewünschten Editor aus.

3. Klicken Sie auf Speichern.

ANMERKUNG

Wenn Sie den Standard-Editor Ihres Projekts ändern, können Sie für alle neuen Artikel, die Sie erstellen, den jeweiligen Editor auswählen.

Wechseln zwischen Markdown - WYSIWYG - Erweiterter WYSIWYG-Editor

Der Markdown-Editor ist der Standardeditor für alle neuen Projekte und Artikel in Document360. Wenn Sie den WYSIWYG-Editor oder den erweiterten WYSIWYG-Editor verwenden möchten, können Sie auf Projekt- oder Artikelebene zu diesem Editor wechseln.

Editorwechsel auf Artikelebene

Um den Editor auf einer einzelnen /category-Seite zu wechseln, führen Sie die folgenden Schritte aus

1. Klicken Sie auf der Artikel-/Kategorieseite auf das Symbol Mehr (•••) und wählen Sie Weitere Artikeloptionen aus.

   Das Fenster "Artikeleinstellungen " wird angezeigt.

2. Wählen Sie auf der Registerkarte Editor den gewünschten Editor aus.

3. Aktivieren Sie das Kontrollkästchen Sind Sie sicher, dass Sie fortfahren möchten.

4. Klicken Sie auf Speichern.

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

   5_Screenshot-Switching_editors

   

ANMERKUNG

Nachdem Sie auf Beitragsebene zum erweiterten WYSIWYG-Editor gewechselt haben, können Sie den Editortyp für diesen bestimmten Artikel nicht mehr zurücksetzen. Für zukünftige Artikel kann der Benutzer mit der Berechtigung "Projekteinstellungen - Aktualisieren" jedoch den Standard-Editor über "Einstellungen" > Wissensdatenbank-Portal > "Allgemeiner >-Editor" festlegen.

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

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

Wann ist das der Fall?

1. Migrieren von WYSIWYG zum erweiterten WYSIWYG-Editor

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

2. Bearbeiten von Inhalten im erweiterten WYSIWYG-Editor

   Wenn nicht unterstützte Tags oder Attribute in der Codeansicht hinzugefügt werden, werden sie vom Editor erkannt, gekennzeichnet und visuell zur Korrektur markiert.

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

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

• Diese Elemente werden innerhalb des Inhalts mithilfe von benutzerdefinierten Indikatoren wie QuickInfos und Blockhervorhebungen visuell gekennzeichnet, ohne die Inhaltsstruktur zu stören.

• Im Editor können Sie den Block des gewünschten, nicht unterstützten Elements nicht bearbeiten. Benutzer können jedoch mit gekennzeichneten Elementen interagieren und Optionen zum Ändern, Entfernen oder Korrigieren in der Codeansicht erhalten.