Ausschnitt

Pläne zur Unterstützung der Wiederverwendung von Inhalten

Snippets handelt es sich um einen vordefinierten 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.

Erstellen eines Snippets

So erstellen Sie ein Snippet:

1. Navigieren Sie zu Documentation () > Content tools > Content reuse > Snippets im Wissensdatenbankportal.

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

2. Klicken Sie oben auf Snippets erstellen , um sprachspezifische Snippets (Global, Englisch, Französisch usw.) auszuwählen, die Ihrem Projekt hinzugefügt wurden.

3. Geben Sie den Namen für Ihr Snippet ein.

   ANMERKUNG

   Der Name des Snippets kann Buchstaben, Zahlen, Bindestriche und Unterstriche mit einer maximalen Länge von 30 Zeichen enthalten.

4. Der Wert des Merge-Codes ist der Snippet-Name, der mit dem Snippet-Tag in Ihrem Editor angezeigt wird.

   Wenn der Name des Snippets z. B. "Haftungsausschluss" lautet, lautet der Wert des Merge-Codes {{snippet. Haftungsausschluss}}.

5. In der Dropdown-Liste Sprachauswahl ist die Standardauswahl Global (in allen Sprachen verfügbar). Bei Bedarf können Sie jedoch eine gewünschte verfügbare Sprache auswählen, um ein sprachspezifisches Snippet zu erstellen.

6. Geben Sie im Feld Inhalt den Inhalt des Snippets ein.

   Standardmäßig ist der Snippet-Editor WYSIWYG (HTML). Sie können jedoch bei Bedarf in den Markdown-Editor wechseln.

ANMERKUNG

Wechsel zu Markdown:

1. Klicken Sie auf Zu Markdown wechseln.

2. Klicken Sie in der Eingabeaufforderung zur Bestätigung der Änderung auf Weiter.

Der WYSIWYG-Inhalt geht verloren, wenn Sie zu Markdown wechseln.

7. Wenn Sie fertig sind, klicken Sie auf Snippet erstellen.

WYSIWYG

Die folgenden Formatierungsoptionen sind für Snippet-Inhalte in WYSIWYG verfügbar:

• Grundlegende Textformatierungsoptionen wie Fett, Kursiv, Durchgestrichen und Unterstrichen sind verfügbar.

• Zu den zusätzlichen Formatierungsoptionen gehören Schriftgröße, Schriftfamilie, Textfarbe, Hintergrundfarbe, Tiefgestellt, Hochgestellt und Klarformatierung.

• Sie können geordnete und ungeordnete Listen für Angebotsartikel erstellen.

• Mit der Option "Bild einfügen " können Sie ein Bild aus einer URL, einem lokalen Speicher oder Drive einfügen.

• Mit Link einfügen können Sie einen Hyperlink von einer bereitgestellten URL oder einem Link zu einem Wissensdatenbank-Artikel hinzufügen.

• Sie können Einfügebeschriftungen wie Info, Warnung, Fehler und Erfolg verwenden.

• Mit Insert latex können Sie Ausdrücke und Gleichungen hinzufügen:

  • Klicken Sie auf die Option Latex einfügen , und das Feld Latexausdruck einfügen wird angezeigt.

  • Geben Sie die gewünschte Latex-Syntax ein und klicken Sie auf Einfügen.

  • In diesem Artikel finden Sie grundlegende Latex-Befehle, die in der Latex-Syntax verwendet werden.

• Mit Tabelle einfügen können Sie eine Tabelle erstellen, indem Sie die gewünschte Anzahl von Zeilen und Spalten auswählen.

• Mit Codeblock einfügen können Sie Codeblöcke hinzufügen.

  • Klicken Sie auf Codeblock einfügen und wählen Sie die Sprache des gewünschten Codes aus dem Dropdown-Menü aus.

  • Fügen Sie Code in das Feld Code einfügen ein, und klicken Sie auf Einfügen.

• Sie können eine Vorschau des Snippets in der Codeansicht (HTML) anzeigen. Klicken Sie auf Codeansicht , um die Vorschau anzuzeigen. Wenn Sie zurück zur Editoransicht wechseln möchten, klicken Sie erneut auf Codeansicht .

Abschlag

Markdown ist praktisch, wenn signifikanter Text und minimale Medien am Snippet beteiligt sind. Sie können die Markdown-Syntax manuell verwenden, während Sie Text mithilfe der Markdown-Symbolleiste schreiben oder formatieren.

Sie können beispielsweise einen Text fett erscheinen lassen, indem Sie die entsprechende Syntax schreiben oder das Symbol Fett () in der Markdown-Symbolleiste verwenden.

• Grundlegende Textformatierungsoptionen wie Fett, Kursiv, Durchgestrichen sind verfügbar.

• Mit Blockzitaten können Sie Blockzitate hinzufügen.

• Mit Linie können Sie eine horizontale Linie einfügen.

• Geordnete Liste und Ungeordnete Liste sind für Auflistungsartikel verfügbar.

• Mit Tabelle einfügen können Sie eine Tabelle erstellen, indem Sie die gewünschte Anzahl von Zeilen und Spalten auswählen.

• Mit der Option "Bild einfügen " können Sie ein Bild aus einer URL, einem lokalen Speicher oder Drive einfügen.

• Mit Codeblock einfügen können Sie Codeblöcke hinzufügen:

  • Klicken Sie auf Codeblock einfügen und geben Sie den gewünschten Code in den Codeblock ein.

  • Beispiel: `code`.

• Sie können Einfügebeschriftungen wie Info, Warnung, Fehler und Erfolg verwenden.

• Mit Insert latex können Sie Ausdrücke und Gleichungen hinzufügen.

  • Klicken Sie auf die Option Latex einfügen , und eine Beispiel-Latexsyntax () wird angezeigt.

  • Geben Sie die gewünschte Syntax ein.

  • Die Syntax muss mit beginnen und enden $.

ANMERKUNG

Wenn Sie Latex hinzufügen, fügen Sie kein Leerzeichen zwischen $ der Syntax und ein. Weitere Informationen finden Sie in diesem Artikel für grundlegende Latex-Befehle.

• Mit Link einfügen können Sie einen Hyperlink von einer bereitgestellten URL oder einem Link zu einem Wissensdatenbank-Artikel hinzufügen.

• Mit der Funktion "Glossar " können Sie Ihrem Snippet Glossarbegriffe hinzufügen.

Einfügen eines Snippets in den Artikel

Es gibt zwei Methoden , mit denen Sie Ihrem Artikel ein Snippet hinzufügen können.

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

Methode 1: Verwenden der Syntax (Markdown-Editor)

Methode 2: Über die Symbolleiste (Markdown, WYSIWYG-Editor und erweiterter WYSIWYG-Editor)

Seite "Snippets"

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

1. Navigieren Sie zu Documentation () > Content tools > Content reuse > Snippets im Wissensdatenbankportal.

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

1. Sprachen: Um das Snippet in Global oder einer bestimmten Sprache zu filtern.

2. Snippets suchen: Durchsuchen Sie die Snippet-Liste anhand des Namens.

3. Verwendet in: Wenn kein Snippet zu einer Artikel-/Kategorieseite hinzugefügt wird, lautet -der Status . Wenn ein Snippet zu einer Artikel-/Kategorieseite hinzugefügt wird, können Sie auf die Schaltfläche Ansicht klicken, um die Liste der Artikel/Kategorieseiten anzuzeigen, die das Snippet enthalten.  

4. Sprache: Die gewünschte Sprache jedes Snippets.

5. Letzte Änderung: Der Zeitpunkt, zu dem der Snippet-Inhalt zuletzt aktualisiert wurde.

6. Vorschau: Klicken Sie auf den Namen des Snippets, um den Inhalt des Snippets anzuzeigen.

7. Fortschritt: Klicken Sie auf das Globus-Symbol, um den Fortschritt des Snippets in mehreren Sprachen anzuzeigen.

8. Symbol "Bearbeiten" (): Um den Inhalt des Snippets zu bearbeiten.

9. Symbol "Löschen" (): Um das Snippet zu entfernen.

Abhängigkeiten von Artikel-/Kategorieseiten anzeigen

Auf der Snippets Seite finden Sie die Spalte Verwendet in .

1. Klicken Sie in der Spalte Verwendet in auf die Schaltfläche Ansicht .

   Das Fenster "Referenzen anzeigen " wird angezeigt, in dem Sie die Liste der Artikel-/Kategorieseiten anzeigen können, zu denen das Snippet hinzugefügt wurde.

2. Klicken Sie auf den Artikel, um den Abschnitt zu erweitern.

3. Folgende Informationen finden Sie hier:

   • Die Artikelversion.

   • Der Arbeitsbereich und die Sprache des Projekts.

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

   • Der Artikel lautet (Veröffentlicht, Entwurf, Neuer Artikel).

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

Bearbeiten eines vorhandenen Snippets

1. Navigieren Sie zu Documentation () > Content tools > Content reuse > Snippets im Wissensdatenbankportal.

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

2. Bewegen Sie den Mauszeiger über das gewünschte Snippet und klicken Sie auf das Symbol Bearbeiten ().

3. Nachdem Sie die Inhaltsbearbeitung abgeschlossen haben, klicken Sie auf die Schaltfläche Aktualisieren .

ANMERKUNG

Wenn Sie ein Snippet in der Bibliothek aktualisieren, werden die Änderungen automatisch in allen Artikeln und Kategorieseiten widergespiegelt, auf denen es verwendet wird. Dazu gehören auch veröffentlichte Artikel, die aktualisiert werden, ohne dass sie erneut veröffentlicht werden müssen.

Löschen eines Snippets

1. Navigieren Sie zu Documentation () > Content tools > Content reuse > Snippets im Wissensdatenbankportal.

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

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

3. Klicken Sie in der Bestätigungsaufforderung auf Ja .

So löschen Sie mehrere Snippets in großen Mengen

Wählen Sie auf der Seite "Snippets" mehrere gewünschte Snippets aus und klicken Sie oben in der Liste auf die Option Löschen .

Snippets übersetzen

Sie können Snippets in mehreren Sprachen erstellen und verwalten. Dadurch wird sichergestellt, dass die Snippets bei der Übersetzung Ihrer Artikel mit der Sprache des Artikels übereinstimmen, was eine konsistente und lokalisierte Benutzererfahrung bietet.  

ANMERKUNG

Globale Snippets können nicht übersetzt werden.

Übersetzen neuer Snippets

1. Navigieren Sie zum > Content tools > Content reuse > Snippets Documentation () im Wissensdatenbankportal.

2. Klicken Sie auf Snippet erstellen.

3. Wählen Sie in der Dropdown-Liste Sprache die gewünschte Sprache aus.

4. Geben Sie den Namen des Snippets und den Inhalt des Snippets in Englisch (oder Ihrer Standardsprache) ein.

5. Klicken Sie auf Zu Markdown wechseln , um den Inhaltseditor von WYSIWYG in den Markdown-Editor zu ändern.

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

7. Wählen Sie die gewünschte(n) Sprache(n) aus dem Dropdown-Menü aus und klicken Sie auf Übersetzen.

ANMERKUNG

• Die Standardsprache wird als Main markiert.

• Übersetzte Sprachen werden mit einem grünen Häkchen gekennzeichnet, um anzuzeigen, dass die Übersetzung vollständig ist. Bei Bedarf können Sie zu nicht übersetzten Sprachen navigieren und deren Übersetzung abschließen.

7. Sobald die Übersetzungen abgeschlossen sind, klicken Sie auf Snippet erstellen , um das Snippet zusammen mit seinen Ü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 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 Sprache entfernen.

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