Utilisation d’extraits de code

Snippets Il s'agit d'un ensemble prédéfini de blocs de contenu que le gestionnaire de contenu ou l'auteur utilise comme contenu réutilisable. Le contenu de l'extrait peut varier de simples textes ou phrases à de longs paragraphes, tableaux, images, etc. Dans Document360, les extraits sont stockés dans une bibliothèque et vous pouvez facilement les insérer dans les articles lors de l'édition d'un simple clic sur un bouton.

NOTE

Le Snippet apparaîtra comme un contenu normal pour le lecteur sur le site de la base de connaissances. Le lecteur ne saura pas que le contenu a été rendu via Snippet.

Accéder à la page Extraits de code

Vous pouvez afficher, modifier ou supprimer un extrait de la Snippets page.

1. Naviguez jusqu'à Documentation () dans la barre de navigation de gauche de la .Knowledge base portal

2. Dans le volet de navigation de gauche, accédez à Content tools > Content reuse > Snippets.

   La Snippets page affiche une liste de tous les extraits de code qui ont été ajoutés à votre projet.

1.   Comment faire : consultez un tutoriel sur l'utilisation des extraits.

2.   Docs : Ouvrez l'article de documentation sur les snippets.

3. Créer : créez un extrait de code.

4. Langues : filtrez la liste des extraits de code par Globale ou par une langue spécifique.

5. Rechercher des extraits : Recherchez des extraits par leur nom.

6. Utilisé dans : Indique où l'extrait de code est utilisé.

   • Si l'extrait n'est pas utilisé, le champ affiche un tiret -.

   • Si l'extrait est utilisé, cliquez sur Afficher pour voir les articles ou les pages de catégorie où il a été inséré.

7. Langue : indique la langue de l'extrait.

8. Dernière modification : affiche la date et l'heure de la dernière mise à jour de l'extrait.

9. Aperçu : cliquez sur le nom de l'extrait pour prévisualiser son contenu.

10. Progression : affichez la progression de la traduction de l'extrait de code. Cliquez sur l'icône du globe () en regard de chaque variable. A indique que l'extrait a été traduit dans cette langue, tandis que l' icône indique qu'il n'a pas encore été traduit.

11. Modifier () : Modifiez le contenu de l'extrait.

12. Supprimer () : cliquez pour supprimer un extrait. Pour supprimer plusieurs extraits de code dans une seule instance, cochez la case souhaitée et cliquez sur Supprimer en haut.

Création d'un extrait de code

Pour créer un extrait de code :

1. Naviguez jusqu'à Documentation () dans la barre de navigation de gauche de la .Knowledge base portal

2. Dans le volet de navigation de gauche, accédez à Content tools > Content reuse > Snippets.

   La Snippets page s'affiche. Si vous avez ajouté des extraits précédemment, vous pouvez les voir répertoriés ici.

3. Cliquez sur Créer en haut à droite.

4. Dans la boîte de dialogue Créer un extrait de code :

   1. Entrez un nom (jusqu'à 50 caractères). Vous pouvez utiliser des lettres, des chiffres, des traits d'union et des traits de soulignement.

   2. Choisissez une langue (globale par défaut). Vous pouvez sélectionner une langue spécifique si nécessaire.

   3. Développez la liste déroulante Avancé et choisissez votre éditeur (Markdown ou Advanced WYSIWYG). L'éditeur par défaut est basé sur les paramètres généraux de votre projet.

5. Cliquez sur Créer.

Une fois créé :

6. Utilisez l'éditeur sélectionné pour saisir le contenu de votre extrait.

   1. Si vous utilisez Markdown, l'éditeur Markdown s'affiche.

   2. Si vous utilisez le WYSIWYG avancé, la barre d'outils de l'éditeur, la vue de code, le générateur de résumé Eddy AI et le générateur de FAQ Eddy AI sont disponibles.

NOTE

• Une fois que vous avez sélectionné l' éditeur WYSIWYG avancé, vous ne pouvez pas revenir à Markdown.

• Si vous commencez avec Markdown, vous pouvez convertir en WYSIWYG avancé à des fins de traduction (car Markdown ne prend pas en charge la traduction automatique). Ensuite, vous ne pouvez pas revenir à Markdown.

7. Vous pouvez changer de langue dans la liste déroulante des langues en haut.

8. Après avoir rédigé votre extrait, cliquez sur Enregistrer ou appuyez pour Ctrl+S utiliser le raccourci.

NOTE

Options de formatage

• Vous pouvez appliquer une mise en forme au contenu de votre extrait de code à l'aide de la barre d'outils :

  • Éditeur Markdown : pour obtenir de l'aide sur le formatage, lisez l'article sur le Markdown editor.

  • Éditeur WYSIWYG avancé : Pour une liste complète des fonctionnalités, lisez l'article sur le Advanced WYSIWYG editor.

• Vous pouvez utiliser du code HTML personnalisé dans les vues Code. Cependant, les balises non prises en charge seront nettoyées automatiquement.

• En sélectionnant l'éditeur WYSIYWG avancé, vous pouvez utiliser le menu Barre oblique dans l'éditeur d'extraits de code pour accéder à des outils de formatage tels que Titre 2, Titre 3, Titre 4, Liste numérotée, Liste à puces, Liste de contrôle, Code en ligne et Bloc de code, et vous pouvez également insérer des éléments tels que Image, Vidéo, Lien, Tableau, Séparateur, Accordéon, Légende, Onglets, FAQ, LaTeX et Emoji.

Utilisation d'Eddy AI dans le contenu Snippet

Lors de la rédaction d'un extrait, vous pouvez survoler le contenu souhaité et utiliser Eddy AI pour allonger ou raccourcir le texte, l'améliorer, changer le ton, convertir la parole, changer la voix, diviser des phrases ou générer des éléments tels que des tableaux, des diagrammes circulaires et des organigrammes.

Dans le coin inférieur droit, vous pouvez également accéder à la FAQ et au résumé du générateur d'Eddy AI (l'option de résumé n'est disponible que pour les extraits en anglais).

Insertion d'un extrait dans l'article

Vous pouvez insérer un extrait de code dans les articles de deux manières :

Méthode 1 : Utilisation de la syntaxe (éditeur Markdown)

Méthode 2 : Utilisation de la barre d'outils (Markdown et WYSIWYG)

Méthode 3 : Utilisation du menu Barre oblique (éditeur WYSIWYG avancé)

Affichage de l'utilisation des extraits (dépendance de l'article/de la catégorie)

Pour voir où un extrait est utilisé :

1. Dans la colonne Utilisé en , cliquez sur Afficher.

2. Le panneau Références de la vue s'affiche. Tu vas voir:

   • La version de l'article.

   • L'espace de travail et la langue du projet.

   • Le nom du compte d'équipe et la photo de profil qui a ajouté l'extrait.

   • L'article indique (Brouillon et Publié).

   • Les informations sur l'heure/la date lorsque l'extrait a été inséré dans la page de l'article/de la catégorie.

   • Cliquez sur l' icône pour ouvrir la même version de l'article dans un nouvel onglet.

Modifier un extrait de code

Pour modifier un extrait de code :

1. Naviguez jusqu'à Documentation () dans la barre de navigation de gauche de la .Knowledge base portal

2. Dans le volet de navigation de gauche, accédez à Content tools > Content reuse > Snippets.

   La Snippets page s'affiche. Vous pouvez trouver la liste des extraits que vous avez déjà ajoutés.

3. Passez la souris sur l'extrait de code que vous souhaitez modifier et cliquez sur l'icône Modifier ().

4. Mettez à jour le contenu si nécessaire.

5. Cliquez sur Mettre à jour.

NOTE

Lorsque vous mettez à jour un extrait, les modifications sont automatiquement répercutées dans tous les articles et pages de catégories où il est utilisé, y compris les articles publiés, sans qu'il soit nécessaire de les republier.

Suppression d'un extrait de code

Pour supprimer un extrait de code :

1. Naviguez jusqu'à Documentation () dans la barre de navigation de gauche de la .Knowledge base portal

2. Dans le volet de navigation de gauche, accédez à Content tools > Content reuse > Snippets.

   La page Extraits de code s'affiche. Vous pouvez trouver la liste des extraits que vous avez déjà ajoutés.

3. Passez la souris sur l'extrait de code souhaité et cliquez sur l'icône Supprimer ().

4. Cliquez sur Oui dans la boîte de dialogue de confirmation Supprimer .

5. Pour supprimer en bloc plusieurs extraits de code, sélectionnez-en plusieurs dans la page Extraits de code et cliquez sur l'option Supprimer () en haut de la liste.

NOTE

• Lorsque vous supprimez un extrait, il est supprimé de tous les articles où il est référencé.

• L'article conserve sa version actuelle.

• Sur le site de la base de connaissances, le contenu environnant s'ajuste de sorte qu'il ne reste plus d'espace vide à l'endroit où l'extrait a été supprimé.

• Dans le portail, un symbole de chargement apparaît dans le bloc de contenu où l'extrait de code a été supprimé. Vous pouvez sélectionner ce bloc pour insérer un autre extrait de code ou supprimer le bloc manuellement.

Traduction d'extraits

Vous pouvez créer des extraits dans plusieurs langues pour garantir la localisation dans votre base de connaissances.

NOTE

Les extraits globaux ne peuvent pas être traduits.

Traduction de nouveaux extraits

Pour traduire un nouvel extrait lors de la création :

1. Naviguez jusqu'à Documentation () dans la barre de navigation de gauche de la .Knowledge base portal

2. Dans le volet de navigation de gauche, accédez à Content tools > Content reuse > Snippets.

3. Cliquez sur Créer.

4. Dans la boîte de dialogue Créer un nouvel extrait , entrez le nom de l'extrait, sélectionnez la langue souhaitée et choisissez votre éditeur préféré.

5. Cliquez sur Créer.

6. Dans la liste déroulante Langue , sélectionnez la langue prévue pour l'extrait.

7. Entrez le contenu dans la langue de votre choix.

8. Pour traduire le contenu dans d'autres langues, cliquez sur le menu déroulant Traduire dans d'autres langues .

9. Sélectionnez les langues souhaitées dans la liste et cliquez sur Traduire.

NOTE

• La langue par défaut sera marquée comme Main.

• Les langues traduites afficheront une coche verte (✔) une fois la traduction terminée.

• Vous pouvez passer manuellement à des langues non traduites et ajouter des traductions si nécessaire.

10. Cliquez sur Enregistrer pour l'enregistrer avec toutes les traductions.

Par exemple, si vous créez un extrait pour un message de bienvenue en anglais, vous pouvez utiliser la fonction de traduction pour ajouter le même message en français, en espagnol, en néerlandais, etc.

Traduction d'extraits existants

1. Sur la page Extraits , cliquez sur l'extrait existant que vous souhaitez traduire.

2. Accédez à Traduire dans d'autres langues et sélectionnez la langue dans laquelle l'extrait doit être traduit.

3. Cliquez sur Traduire.

4. Si nécessaire, vous pouvez accéder à d'autres langues et traduire à nouveau dans ces langues.

5. Pour traduire à nouveau le contenu, cliquez à nouveau sur Traduire. Cela remplacera la traduction existante par une nouvelle.

6. Si vous devez supprimer l' extrait de code traduit pour une langue spécifique, cliquez sur l'icône Plus () et sélectionnez Supprimer la langue.

   Vous pouvez retraduire le contenu à tout moment si nécessaire.

Dépannage

Les extraits n'apparaissent pas dans le menu de l'éditeur

Ce problème se produit généralement lorsqu'un extrait est créé dans une langue, mais utilisé dans un article écrit dans une autre langue. Dans Document360, les extraits de code sont spécifiques à la langue, sauf s'ils sont créés dans le paramètre de langue globale .

Étapes à résoudre :

• Assurez-vous que l'extrait est créé dans la même langue que l'article sur lequel vous travaillez.

• Si l'extrait a été créé dans une autre langue, utilisez l'option Traduire dans d'autres langues disponible dans la section Réutilisation du contenu.

• Une fois traduit, passez à la langue souhaitée dans l'éditeur d'articles. L'extrait devrait maintenant apparaître lorsque vous essayez de l'insérer dans l'article.

NOTE

Les extraits créés dans une langue spécifique n'apparaîtront que dans les articles rédigés dans cette même langue.

Si les extraits n'apparaissent toujours pas après avoir suivi les étapes ci-dessus, veuillez contacter support@document360.com avec les coordonnées suivantes :

• Une capture d'écran de l'extrait de code dans la section Réutilisation du contenu.

• Une capture d'écran montrant que l'extrait n'apparaît pas dans l'éditeur d'article.