Verwenden von Snippets

Snippets ist ein vordefinierter Satz von Inhaltsblöcken, die der Content-Manager oder Autor als wiederverwendbaren Inhalt verwendet. Der Inhalt des Snippets kann von einfachem Text oder Phrasen bis hin zu langen Absätzen, Tabellen, Bildern und mehr variieren. In Document360 werden die Snippets in einer Bibliothek gespeichert, und Sie können sie während der Bearbeitung mit nur einem Klick auf eine Schaltfläche in Artikel einfügen.

ANMERKUNG

Das Snippet wird dem Leser als regulärer Inhalt auf der Wissensdatenbank-Website angezeigt. Der Leser wird nicht wissen, dass der Inhalt über Snippet gerendert wurde.

Zugriff auf die Seite "Snippets"

Sie können ein Snippet auf der Snippets Seite anzeigen, bearbeiten oder löschen.

1. Navigieren Sie zu Documentation () in der linken Navigationsleiste in .Knowledge base portal

2. Wechseln Sie im linken Navigationsbereich zu Content tools > Content reuse > Snippets.

   Auf der Snippets Seite wird eine Liste aller Snippets angezeigt, die zu Ihrem Projekt hinzugefügt wurden.

1.   Gewusst wie: Sehen Sie sich ein Tutorial zur Verwendung von Codeausschnitten an.

2.   Dokumente: Öffnen Sie den Dokumentationsartikel zu Snippets.

3. Erstellen: Erstellen Sie ein neues Snippet.

4. Sprachen: Filtern Sie die Snippet-Liste nach Global oder einer bestimmten Sprache.

5. Snippets suchen: Suchen Sie nach Snippets anhand des Namens.

6. Verwendet in: Zeigt an, wo das Snippet verwendet wird.

   • Wenn das Snippet nicht verwendet wird, wird im Feld ein Bindestrich -angezeigt.

   • Wenn das Snippet verwendet wird, klicken Sie auf Anzeigen , um die Beitrags- oder Kategorieseiten anzuzeigen, auf denen es eingefügt wurde.

7. Sprache: Gibt die Sprache des Snippets an.

8. Letzte Änderung: Zeigt das Datum und die Uhrzeit der letzten Aktualisierung des Snippets an.

9. Vorschau: Klicken Sie auf den Namen des Snippets, um eine Vorschau des Inhalts anzuzeigen.

10. Fortschritt: Zeigen Sie den Übersetzungsfortschritt des Snippets an. Klicken Sie auf das Globussymbol () neben jeder Variablen. A zeigt an, dass das Snippet in diese Sprache übersetzt wurde, während das Symbol anzeigt, dass es noch nicht übersetzt wurde.

11. Bearbeiten (): Bearbeiten Sie den Snippet-Inhalt.

12. Löschen (): Klicken Sie hier, um ein Snippet zu löschen. Um mehrere Snippets in einer Instanz zu löschen, aktivieren Sie das gewünschte Kontrollkästchen und klicken Sie oben auf Löschen .

Erstellen eines Snippets

So erstellen Sie ein neues Snippet:

1. Navigieren Sie zu Documentation () in der linken Navigationsleiste in .Knowledge base portal

2. Navigieren Sie im linken Navigationsbereich zu Content tools > Content reuse > Snippets.

   Die Snippets Seite wird angezeigt. Wenn Sie zuvor Snippets hinzugefügt haben, können Sie sie hier aufgelistet sehen.

3. Klicken Sie oben rechts auf Erstellen .

4. Gehen Sie im Dialogfeld "Neues Snippet erstellen " wie folgt vor:

   1. Geben Sie einen Namen ein (bis zu 50 Zeichen). Sie können Buchstaben, Zahlen, Bindestriche und Unterstriche verwenden.

   2. Wählen Sie eine Sprache aus (Standardeinstellung ist Global). Bei Bedarf können Sie eine bestimmte Sprache auswählen.

   3. Erweitern Sie das Dropdown-Menü Erweitert , und wählen Sie Ihren Editor aus (Markdown oder Erweitertes WYSIWYG). Der Standard-Editor basiert auf Ihren allgemeinen Projekteinstellungen.

5. Klicken Sie auf Erstellen.

Nach der Erstellung:

6. Verwenden Sie den ausgewählten Editor, um Ihren Snippet-Inhalt einzugeben.

   1. Wenn Sie Markdown verwenden, wird der Markdown-Editor angezeigt.

   2. Wenn Sie Advanced WYSIWYG verwenden, sind die Symbolleiste des Editors, die Codeansicht, der Eddy AI-Zusammenfassungsgenerator und der Eddy AI FAQ-Generator verfügbar.

ANMERKUNG

• Nachdem Sie den erweiterten WYSIWYG-Editor ausgewählt haben, können Sie nicht mehr zu Markdown zurückkehren.

• Wenn Sie mit Markdown beginnen, können Sie zu Übersetzungszwecken in Advanced WYSIWYG konvertieren (da Markdown keine maschinelle Übersetzung unterstützt). Dann können Sie nicht mehr zu Markdown wechseln.

7. Sie können die Sprache über das Dropdown-Menü "Sprache" oben wechseln.

8. Nachdem Sie Ihr Snippet erstellt haben, klicken Sie auf Speichern oder drücken Sie Ctrl+S , um die Tastenkombination zu verwenden.

ANMERKUNG

Formatierungsoptionen

• Sie können die Formatierung auf Ihren Snippet-Inhalt anwenden, indem Sie die Symbolleiste verwenden:

  • Markdown-Editor: Hilfe zum Formatieren finden Sie im Artikel Markdown editor.

  • Erweiterter WYSIWYG-Editor: Eine vollständige Liste der Funktionen finden Sie im Artikel auf .Advanced WYSIWYG editor

• Sie können benutzerdefinierten HTML-Code in den Codeansichten verwenden. Nicht unterstützte Tags werden jedoch automatisch bereinigt.

• Wenn Sie den erweiterten WYSIYWG-Editor auswählen, können Sie das Schrägstrich-Menü im Snippet-Editor verwenden, um auf Formatierungstools wie Überschrift 2, Überschrift 3, Überschrift 4, Nummerierte Liste, Aufzählungsliste, Checkliste, Inline-Code und Codeblock zuzugreifen, und Sie können auch Elemente wie Bild, Video, Link, Tabelle, Trennlinie, Akkordeon, Legende, Registerkarten, FAQs, LaTeX und Emoji einfügen.

Verwenden von Eddy AI in Snippet-Inhalten

Während Sie ein Snippet erstellen, können Sie mit der Maus über den gewünschten Inhalt fahren und Eddy AI verwenden, um den Text länger oder kürzer zu machen, ihn zu verbessern, den Ton zu ändern, Sprache umzuwandeln, die Stimme zu ändern, Sätze zu teilen oder Elemente wie Tabellen, Tortendiagramme und Flussdiagramme zu generieren.

In der unteren rechten Ecke können Sie auch auf die Generator-FAQ und die Generator-Zusammenfassung von Eddy AI zugreifen (die Zusammenfassungsoption ist nur für englischsprachige Snippets verfügbar).

Einfügen eines Snippets in den Artikel

Sie können Snippets auf zwei Arten in die Artikel einfügen:

Methode 1: Verwenden der Syntax (Markdown-Editor)

Methode 2: Verwenden der Symbolleiste (Markdown und WYSIWYG)

Methode 3: Verwenden des Slash-Menüs (Erweiterter WYSIWYG-Editor)

Anzeigen der Snippet-Nutzung (Abhängigkeit von Artikeln/Kategorien)

So zeigen Sie an, wo ein Snippet verwendet wird:

1. Klicken Sie in der Spalte Verwendet in auf Ansicht.

2. Der Bereich Ansichtsreferenzen wird angezeigt. Du wirst sehen:

   • Die Artikelversion.

   • Der Arbeitsbereich und die Sprache des Projekts.

   • Der Name des Teamkontos und das Profilbild, das das Snippet hinzugefügt hat.

   • Im Artikel heißt es (Entwurf und Veröffentlicht).

   • Die Zeit-/Datumsangaben, zu denen das Snippet auf der Artikel-/Kategorieseite eingefügt wurde.

   • Klicken Sie auf das Symbol, um dieselbe Beitragsversion in einem neuen Tab zu öffnen.

Bearbeiten eines Snippets

So bearbeiten Sie ein Snippet:

1. Navigieren Sie zu Documentation () in der linken Navigationsleiste in .Knowledge base portal

2. Wechseln Sie im linken Navigationsbereich zu Content tools > Content reuse > Snippets.

   Die Snippets Seite wird angezeigt. Hier finden Sie die Liste der Snippets, die Sie bereits hinzugefügt haben.

3. Bewegen Sie den Mauszeiger über das Snippet, das Sie bearbeiten möchten, und klicken Sie auf das Symbol Bearbeiten ().

4. Aktualisieren Sie den Inhalt nach Bedarf.

5. Klicken Sie auf Aktualisieren.

ANMERKUNG

Wenn Sie ein Snippet aktualisieren, werden die Änderungen automatisch in allen Beiträgen und Kategorieseiten übernommen, auf denen es verwendet wird, einschließlich der veröffentlichten, ohne dass sie erneut veröffentlicht werden müssen.

Löschen eines Snippets

So löschen Sie ein Snippet:

1. Navigieren Sie zu Documentation () in der linken Navigationsleiste in .Knowledge base portal

2. Navigieren Sie im linken Navigationsbereich zu Content tools > Content reuse > Snippets.

   Die Seite Snippets wird angezeigt. Hier finden Sie die Liste der Snippets, die Sie bereits hinzugefügt haben.

3. Bewegen Sie den Mauszeiger über das gewünschte Snippet und klicken Sie auf das Symbol Löschen ().

4. Klicken Sie im Bestätigungsdialogfeld "Löschen" auf Ja.

5. Um mehrere Snippets in großen Mengen zu löschen, wählen Sie auf der Seite "Snippets" mehrere gewünschte Snippets aus und klicken Sie oben in der Liste auf die Option "Löschen " ().

ANMERKUNG

• Wenn Sie ein Snippet löschen, wird es aus allen Beiträgen entfernt, in denen es referenziert wird.

• Der Artikel behält seine aktuelle Version bei.

• Auf der Wissensdatenbank-Website wird der umgebende Inhalt so angepasst, dass an der Stelle, an der das Snippet entfernt wurde, kein leerer Bereich mehr übrig bleibt.

• Im Portal erscheint ein Ladesymbol in dem Inhaltsblock, aus dem das Snippet entfernt wurde. Sie können diesen Block auswählen, um ein weiteres Snippet einzufügen oder den Block manuell zu löschen.

Snippets übersetzen

Sie können Snippets in mehreren Sprachen erstellen, um die Lokalisierung in Ihrer Wissensdatenbank sicherzustellen.

ANMERKUNG

Globale Snippets können nicht übersetzt werden.

Übersetzen neuer Snippets

So übersetzen Sie ein neues Snippet während der Erstellung:

1. Navigieren Sie zu Documentation () in der linken Navigationsleiste in .Knowledge base portal

2. Navigieren Sie im linken Navigationsbereich zu Content tools > Content reuse > Snippets.

3. Klicken Sie auf Erstellen.

4. Geben Sie im Dialogfeld Neues Snippet erstellen den Namen des Snippets ein, wählen Sie die gewünschte Sprache aus und wählen Sie Ihren bevorzugten Editor aus.

5. Klicken Sie auf Erstellen.

6. Wählen Sie in der Dropdown-Liste Sprache die gewünschte Sprache für das Snippet aus.

7. Geben Sie den Inhalt in der gewünschten Sprache ein.

8. Um den Inhalt in andere Sprachen zu übersetzen, klicken Sie auf das Dropdown-Menü In andere Sprachen übersetzen .

9. Wählen Sie die gewünschten Sprachen aus der Liste aus und klicken Sie auf Übersetzen.

ANMERKUNG

• Die Standardsprache wird als Main markiert.

• Übersetzte Sprachen werden mit einem grünen Häkchen (✔) angezeigt, sobald die Übersetzung abgeschlossen ist.

• Sie können manuell zu nicht übersetzten Sprachen wechseln und bei Bedarf Übersetzungen hinzufügen.

10. Klicken Sie auf Speichern , um es mit allen Übersetzungen zu speichern.

Wenn Sie beispielsweise ein Snippet für eine Willkommensnachricht auf Englisch erstellen, können Sie die Übersetzungsfunktion verwenden, um dieselbe Nachricht auf Französisch, Spanisch, Niederländisch usw. hinzuzufügen.

Übersetzen vorhandener Snippets

1. Klicken Sie auf der Seite Snippets auf das gewünschte vorhandene Snippet, das Sie übersetzen möchten.

2. Navigieren Sie zu In andere Sprachen übersetzen und wählen Sie die gewünschte Sprache aus, in die das Snippet übersetzt werden soll.

3. Klicken Sie auf Übersetzen.

4. Bei Bedarf können Sie zu anderen Sprachen navigieren und erneut in diese Sprachen übersetzen.

5. Um den Inhalt erneut zu übersetzen, klicken Sie auf Erneut übersetzen. Dadurch wird die vorhandene Übersetzung durch eine neue überschrieben.

6. Wenn Sie das übersetzte Snippet für eine bestimmte Sprache entfernen müssen, klicken Sie auf das Symbol Mehr () und wählen Sie Sprache entfernen aus.

   Sie können den Inhalt bei Bedarf jederzeit neu übersetzen.

Fehlerbehebung

Snippets werden nicht im Editor-Menü angezeigt

Dieses Problem tritt in der Regel auf, wenn ein Snippet in einer Sprache erstellt, aber in einem Artikel verwendet wird, der in einer anderen Sprache verfasst wurde. In Document360 sind Snippets sprachspezifisch, es sei denn, sie werden unter der globalen Spracheinstellung erstellt.

Schritte zur Behebung:

• Stellen Sie sicher, dass das Snippet in derselben Sprache erstellt wird wie der Artikel, an dem Sie arbeiten.

• Wenn das Snippet in einer anderen Sprache erstellt wurde, verwenden Sie die Option In andere Sprachen übersetzen , die im Abschnitt Wiederverwendung von Inhalten verfügbar ist.

• Wechseln Sie nach der Übersetzung im Artikeleditor in die gewünschte Sprache. Das Snippet sollte jetzt angezeigt werden, wenn Sie versuchen, es in den Artikel einzufügen.

ANMERKUNG

Snippets, die in einer bestimmten Sprache erstellt wurden, werden nur in Artikeln angezeigt, die in derselben Sprache verfasst wurden.

Wenn die Snippets nach dem Ausführen der oben genannten Schritte immer noch nicht angezeigt werden, wenden Sie sich bitte an uns support@document360.com mit den folgenden Details:

• Ein Screenshot des Snippets im Abschnitt Wiederverwendung von Inhalten.

• Ein Screenshot, der zeigt, dass das Snippet nicht im Beitragseditor angezeigt wird.