Gebruik van fragmenten

Snippets is een vooraf gedefinieerde set contentblokken die de contentmanager of auteur gebruikt als herbruikbare inhoud. De inhoud van het Snippet kan variëren van eenvoudige tekst of zinnen tot lange alinea's, tabellen, afbeeldingen en meer. In Document360 worden de fragmenten opgeslagen in een bibliotheek, en je kunt ze eenvoudig in artikelen invoegen tijdens het bewerken met slechts één klik op de knop.

NOTITIE

Het Snippet zal als reguliere inhoud voor de lezer verschijnen op de Knowledge Base-site. De lezer zal niet weten dat de inhoud via Snippet is gerenderd.

Toegang tot de Snippets-pagina

Je kunt een fragment van de Snippets pagina bekijken, bewerken of verwijderen.  

1. Navigeer naar Documentation () in de linker navigatiebalk in de Knowledge base portal.

2. Ga in het linker navigatiepaneel naar Content tools > Content reuse > Snippets.

   De Snippets pagina toont een lijst van alle fragmenten die aan je project zijn toegevoegd.

1.   Hoe je: Bekijk een tutorial over het gebruik van snippets.

2.   Documentatie: Open het documentatieartikel over snippets.

3. Aanmaken: Maak een nieuw fragment.

4. Detectie van dubbele inhoud: Identificeer en beheer dubbele tekst in je documentatie en zet deze om in fragmenten.

5. Talen: Filter de snippetlijst op Global of een specifieke taal.

6. Zoek snippets: Zoek naar snippets op naam.

7. Gebruikt in: Toont waar het fragment wordt gebruikt.

   • Als het fragment niet wordt gebruikt, toont het veld een streepje -.

   • Als het fragment is gebruikt, klik dan op Weergeven om de artikelen of categoriepagina's te zien waarop het is ingevoegd.

8. Taal: Geeft de taal van het fragment aan.

9. Laatst gewijzigd: Toont de datum en tijd waarop het fragment voor het laatst is bijgewerkt.

10. Voorbeeld: Klik op de naam van het fragment om de inhoud te bekijken.

11. Voortgang: Bekijk de vertaalstatus van het fragment. Klik op het globe () icoon naast elk fragment. A geeft aan dat het fragment in die taal is vertaald, terwijl het icoon aangeeft dat het nog niet is vertaald.

12. Bewerking (): Bewerk de snippet-inhoud.

13. Verwijderen (): Klik om een fragment te verwijderen. Om meerdere snippets in één instantie te verwijderen, selecteer je de gewenste selectievakjes en klik je bovenaan op Verwijderen .

Banner voor detectie van dubbele inhoud

Om dubbele tekst in je documentatie te identificeren en te beheren, is er bovenaan de pagina Snippets een nieuwe banner voor het detecteren van dubbele inhoud beschikbaar.

Deze functie, aangedreven door Eddy AI, is alleen beschikbaar voor klanten met Enterprise-abonnementen . Het scant je project op paragrafen die meerdere keren in artikelen voorkomen. Zodra de scan voltooid is, genereert het systeem een gedetailleerd rapport waarin wordt weergegeven waar dubbele inhoud voorkomt en wordt voorgesteld deze om te zetten in herbruikbare fragmenten.

Duplicaat van inhoud detecteren

1. Klik op Duplicaten zoeken op de banner om je project te scannen op dubbele content.

2. Zodra de scan is voltooid, wordt het totale aantal gedetecteerde dubbele tekstblokken weergegeven.

3. Als er al een scan is uitgevoerd, klik dan opnieuw op Scannen om het proces opnieuw uit te voeren.

4. Klik op Suggesties beoordelen om het rapport Duplicate Content Detection te openen en de bevindingen te bekijken.

NOTITIE

Voor meer informatie lees het artikel over Duplicate content detection.

Een fragment maken

Om een nieuw fragment te maken:

1. Navigeer naar Documentation () in de linker navigatiebalk in de Knowledge base portal.

2. Navigeer in het linker navigatiepaneel naar Content tools > Content reuse > Snippets.

   De Snippets pagina verschijnt. Als je eerder snippets hebt toegevoegd, kun je ze hier zien.

3. Klik rechtsboven op Aanmaken .

4. In het dialoog 'Nieuw fragment aanmaken ':

   1. Voer een Naam in (tot 50 tekens). Je kunt letters, cijfers, koppeltekens en onderstrepen gebruiken.

   2. Kies een taal (standaard is Globaal). Je kunt indien nodig een specifieke taal kiezen.

   3. Vouw de Geavanceerde dropdown uit en kies je editor (Markdown of Advanced WYSIWYG). De standaardeditor is gebaseerd op je algemene projectinstellingen.

5. Klik op Aanmaken.

Eenmaal aangemaakt:

6. Gebruik de geselecteerde editor om je snippet-inhoud in te voeren.

   1. Als je Markdown gebruikt, verschijnt de Markdown-editor.

   2. Als je Advanced WYSIWYG gebruikt, zijn de editor-werkbalk, codeweergave, Eddy AI samenvattingsgenerator en Eddy AI FAQ-generator beschikbaar.

NOTITIE

• Zodra je de Advanced WYSIWYG-editor hebt geselecteerd, kun je niet meer terug naar Markdown.

• Als je begint met Markdown, kun je voor vertaaldoeleinden omzetten naar Advanced WYSIWYG (omdat Markdown geen machinevertaling ondersteunt). Dan kun je niet terug naar Markdown gaan.

7. Je kunt van taal wisselen via het keuzemenu bovenaan.

8. Na het opstellen van je fragment klik je op Opslaan of druk Ctrl+S je om de snelkoppeling te gebruiken.

NOTITIE

Opmaakopties

• Je kunt opmaak toepassen op je snippet-inhoud met behulp van de werkbalk:

  • Markdown-editor: Voor hulp bij opmaak, lees het artikel op de Markdown editor.

  • Geavanceerde WYSIWYG-editor: Voor een volledige lijst van functies, lees het artikel over de Advanced WYSIWYG editor.

• Je kunt aangepaste HTML gebruiken in de Codeweergaven. Niet-ondersteunde tags worden echter automatisch gesaniteerd.

• Door de geavanceerde WYSIYWG-editor te selecteren, kun je het Slash-menu in de Snippet-editor gebruiken om toegang te krijgen tot opmaaktools zoals Kop 2, Kop 3, Kop 4, Genummerde lijst, Meerlaagse lijst, Bulletlijst, Checklist, Inline code en Codeblok, en je kunt ook elementen invoegen zoals Afbeelding, Video, Link, Tabel, Verdeler, Accordeon, Callout, Tabs, FAQ's, LaTeX,  en Emoji.

Eddy AI gebruiken in snippet-content

Tijdens het opstellen van een fragment kun je met de muis over de gewenste inhoud gaan en Eddy AI gebruiken om de tekst langer of korter te maken, te verbeteren, toon te veranderen, spraak te converteren, de stem te veranderen, zinnen te splitsen of elementen te genereren zoals tabellen, taartdiagrammen en stroomdiagrammen.

Rechtsonder kun je ook de Generator FAQ en de samenvatting van Eddy AI bekijken (de samenvattingsoptie is alleen beschikbaar voor Engelstalige fragmenten).

Een fragment in het artikel invoegen

Je kunt een fragment op twee manieren in de artikelen invoegen:

Methode 1: Gebruik van de syntaxis (Markdown-editor)

Methode 2: Gebruik van de werkbalk (Markdown en WYSIWYG)

Methode 3: Gebruik van het Slash-menu (Geavanceerde WYSIWYG-editor)

Het gebruik van fragmenten bekijken (artikel-/categorieafhankelijkheid)

Om te zien waar een fragment wordt gebruikt:

1. Klik in de kolom 'Gebruikt in ' op Weergeven.

2. Het paneel 'Referenties bekijken ' verschijnt. Je zult zien:

   • De artikelversie.

   • De projectwerkruimte en taal.

   • De teamnaam en profielfoto van de gebruiker die het fragment heeft toegevoegd.

   • Het artikel vermeldt (Concept en Gepubliceerd).

   • De tijd/datum-informatie wanneer het fragment in de artikel-/categoriepagina is ingevoegd.

   • Klik op het pictogram om dezelfde artikelversie in een nieuw tabblad te openen.

Een fragment bewerken

Om een fragment te bewerken:

1. Navigeer naar Documentation () in de linker navigatiebalk in de Knowledge base portal.

2. Ga in het linker navigatiepaneel naar Content tools > Content reuse > Snippets.

   De Snippets pagina verschijnt. Je kunt de lijst met fragmenten vinden die je al hebt toegevoegd.

3. Beweeg je muis over het fragment dat je wilt bewerken en klik op het pictogram Bewerken () ().

4. Werk de inhoud bij indien nodig.

5. Klik op Update.

NOTITIE

Wanneer je een fragment bijwerkt, worden de wijzigingen automatisch weergegeven in alle artikelen en categoriepagina's waar het wordt gebruikt, inclusief gepubliceerde, zonder dat je ze opnieuw hoeft te publiceren.

Een fragment verwijderen

Om een fragment te verwijderen:

1. Navigeer naar Documentation () in de linker navigatiebalk in de Knowledge base portal.

2. Navigeer in het linker navigatiepaneel naar Content tools > Content reuse > Snippets.

   De pagina Snippets zal verschijnen. Je kunt de lijst met fragmenten vinden die je al hebt toegevoegd.

3. Beweeg je muis over het gewenste fragment en klik op het Verwijderen ()-icoon.

4. Klik op Ja in het bevestigingsvenster Verwijderen .

5. Om meerdere snippets in bulk te verwijderen, selecteer je meerdere bedoelde snippets op de pagina Snippets en klik je bovenaan de lijst op de optie Verwijderen ()

NOTITIE

• Wanneer je een fragment verwijdert, wordt het verwijderd uit alle artikelen waar het naar wordt verwezen.

• Het artikel behoudt zijn huidige versie.

• Op de kennisbanksite past de omliggende inhoud zich aan zodat er geen lege ruimte overblijft waar het fragment is verwijderd.

• In het portaal verschijnt er een laadsymbool in het contentblok waar het fragment is verwijderd. Je kunt dit blok selecteren om een nieuw fragment in te voegen of het blok handmatig verwijderen.

Fragmenten vertalen

Je kunt snippets maken in meerdere talen om lokalisatie in je kennisbank te garanderen.

NOTITIE

Globale fragmenten kunnen niet worden vertaald.

Nieuwe fragmenten vertalen

Om een nieuw fragment te vertalen tijdens het creëren:

1. Navigeer naar Documentation () in de linker navigatiebalk in de Knowledge base portal.

2. Navigeer in het linker navigatiepaneel naar Content tools > Content reuse > Snippets.

3. Klik op Aanmaken.

4. In het dialoogvenster 'Nieuw snippet aanmaken ' voer je de naam van het fragment in, selecteer je de gewenste taal en kies je je favoriete editor.

5. Klik op Aanmaken.

6. Selecteer in het keuzemenu Taal de bedoelde taal voor het fragment.

7. Voer de inhoud in de gewenste taal in.

8. Om de inhoud in andere talen te vertalen, klik je op het keuzemenu Vertaal naar andere talen .

9. Selecteer de gewenste talen uit de lijst en klik op Vertalen.

NOTITIE

• De standaardtaal wordt als Main-taal gemarkeerd.

• Vertaalde talen tonen een groen vinkje (✔) zodra de vertaling is voltooid.

• Je kunt handmatig overschakelen naar niet-vertaalde talen en vertalingen toevoegen wanneer nodig.

10. Klik op Opslaan om het met alle vertalingen op te slaan.

Als je bijvoorbeeld een fragment maakt voor een welkomstbericht in het Engels, kun je de vertaalfunctie gebruiken om hetzelfde bericht in het Frans, Spaans, Nederlands, enzovoort toe te voegen.

Bestaande fragmenten vertalen

1. Klik vanaf de pagina Fragmenten op het gewenste bestaande fragment dat je wilt vertalen.

2. Ga naar Translate to other languages en selecteer de gewenste taal die het fragment vertaald moet worden.

3. Klik op Vertalen.

4. Indien nodig kun je naar andere talen navigeren en opnieuw vertalen naar die talen.

5. Om de inhoud opnieuw te vertalen, klik je opnieuw op Vertaal. Dit zal de bestaande vertaling overschrijven met een nieuwe.

6. Als je het vertaalde fragment voor een specifieke taal moet verwijderen, klik dan op het More () icoon en selecteer Taal verwijderen.

   Je kunt de inhoud op elk moment opnieuw vertalen indien nodig.

Probleemoplossing

Snippets verschijnen niet in het editormenu

Dit probleem doet zich meestal voor wanneer een fragment in één taal wordt gemaakt maar in een artikel in een andere taal wordt gebruikt. In Document360 zijn snippets taalspecifiek, tenzij ze onder de Globale taalinstelling zijn aangemaakt.

Stappen om op te lossen:

• Zorg ervoor dat het fragment in dezelfde taal is geschreven als het artikel waaraan je werkt.

• Als het fragment in een andere taal is gemaakt, gebruik dan de optie Vertalen naar andere talen die beschikbaar is in de sectie Inhoud hergebruiken.

• Na vertaling schakel je over naar de gewenste taal in de artikeleditor. Het fragment zou nu moeten verschijnen wanneer je het probeert in het artikel in te voegen.

NOTITIE

Fragmenten die onder een specifieke taal zijn gemaakt, verschijnen alleen in artikelen die in diezelfde taal zijn geschreven.

Als de fragmenten na het volgen van bovenstaande stappen nog steeds niet verschijnen, neem dan contact op support@document360.com met de volgende gegevens:

• Een screenshot van het fragment in de sectie Content-hergebruik.

• Een screenshot waarop het fragment niet in de artikeleditor verschijnt..