Clause de non-responsabilité: Cet article a été généré par traduction automatique.

Snippet

Plans supporting content reuse

Professional
Business
Enterprise






Snippets 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 pendant 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.


Création d’un extrait de code

Pour créer un extrait de code, procédez comme suit :

  1. Accédez à Documentation () > Content tools > Content reuse > Snippets dans le portail de la base de connaissances.

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

  2. Cliquez sur Créer des extraits en haut de la page pour sélectionner des extraits spécifiques à une langue (Global, anglais, français, etc.) ajoutés à votre projet.

  3. Entrez le nom de votre extrait.

    NOTE

    Le nom de l’extrait peut inclure des lettres, des chiffres, des traits d’union et des traits de soulignement, avec une longueur maximale de 30 caractères.

  4. La valeur du code de fusion sera le nom de l’extrait qui apparaît avec la balise d’extrait dans votre éditeur.

    Par exemple, si le nom de votre extrait est Clause de non-responsabilité, la valeur de votre code de fusion sera {{snippet. Avis de non-responsabilité}}.

  5. Dans la liste déroulante Sélection de la langue , la sélection par défaut est Globale (disponible dans toutes les langues). Toutefois, si nécessaire, vous pouvez choisir la langue disponible souhaitée pour créer un extrait de code spécifique à une langue.

  6. Dans le champ Contenu , saisissez le contenu de l’extrait de code.

    Par défaut, l’éditeur d’extraits de code sera WYSIWYG (HTML). Cependant, vous pouvez passer à l’éditeur Markdown si nécessaire.

NOTE

Passer à Markdown :

  1. Cliquez sur Passer à Markdown.

  2. Cliquez sur Continuer dans l’invite de confirmation de modification .

Vous perdrez le contenu WYSIWYG lorsque vous passerez à Markdown.

  1. Une fois cela fait, cliquez sur Créer un extrait.

Adding a new snippet in the Knowledge base portal

Options de formatage

WYSIWYG

Les options de formatage ci-dessous sont disponibles pour le contenu d’extrait de code en WYSIWYG :

1_Screenshot-Formatting_options_available _in_snippet

  • Des options de formatage de texte de base telles que gras, italique, barré et souligné sont disponibles.

  • Les options de formatage supplémentaires incluent la taille de la police, la famille de polices, la couleur du texte, la couleur d’arrière-plan, l’indice, l’exposant et la mise en forme claire.

  • Vous pouvez créer des listes ordonnées et non ordonnées pour répertorier les articles.

  • L’option Insérer une image vous permet d’insérer une image à partir d’une URL, d’un stockage local ou d’un Drive.

  • L’option Insérer un lien vous permet d’ajouter un lien hypertexte à partir d’une URL fournie ou un lien vers un article de la base de connaissances.

  • Vous pouvez utiliser des légendes d’insertion telles que Info, Avertissement, Erreur et Réussite.

  • Insert latex vous permet d’ajouter des expressions et des équations :

    • Cliquez sur l’option Insérer latex et un panneau d’expression Insérer latex apparaîtra.

    • Tapez la syntaxe Latex de votre choix et cliquez sur Insérer.

    • Lisez cet article pour connaître les commandes Latex de base utilisées dans la syntaxe Latex.

  • L’option Insérer une table vous permet de créer une table en sélectionnant le nombre requis de lignes et de colonnes.

  • Insert codeblock vous permet d’ajouter des codeblocks.

    • Cliquez sur Insérer un bloc de code et sélectionnez la langue du code souhaité dans la liste déroulante.

    • Ajoutez du code dans le champ Insérez votre code et cliquez sur Insérer.

  • Vous pouvez prévisualiser l’extrait de code en mode Code (HTML). Cliquez sur Mode Code pour afficher l’aperçu. Si vous souhaitez revenir à la vue de l’éditeur, cliquez à nouveau sur la vue Code .


Markdown

Markdown est pratique lorsque du texte important et des médias minimaux sont impliqués dans le Snippet. Vous pouvez utiliser la syntaxe Markdown manuellement lors de l’écriture ou de la mise en forme du texte à l’aide de la barre d’outils Markdown.

Par exemple, vous pouvez mettre un texte en gras en écrivant la syntaxe correspondante ou en utilisant l’icône Gras () dans la barre d’outils Markdown.

13_Screenshot-Makdown_options_available _in_snippet

  • Des options de formatage de texte de base telles que gras, italique, barré sont disponibles.

  • Block quote vous permet d’ajouter des blocs de guillemets.

  • Ligne vous permet d’insérer une ligne horizontale.

  • Les options Liste ordonnée et Liste non ordonnée sont disponibles pour la mise en vente des articles.

  • L’option Insérer un tableau vous permet de créer un tableau en sélectionnant le nombre requis de lignes et de colonnes.

  • L’option Insérer une image vous permet d’insérer une image à partir d’une URL, d’un stockage local ou d’un Drive.

  • Insert Codeblock vous permet d’ajouter des blocs de code :

    • Cliquez sur Insérer un bloc de code et tapez le code souhaité à l’intérieur du bloc de code.

    • Exemple : `code`.

  • Vous pouvez utiliser des légendes d’insertion telles que Info, Avertissement, Erreur et Réussite.

  • Insert latex vous permet d’ajouter des expressions et des équations.

    • Cliquez sur l’option Insérer latex et un exemple de syntaxe latex () apparaîtra.

    • Tapez la syntaxe souhaitée.

    • La syntaxe doit commencer et se terminer par $.

NOTE

Lors de l’ajout de latex, n’incluez pas d’espace entre $ la syntaxe et . Pour plus d’informations, consultez cet article pour les commandes latex de base.

  • Insérer un lien vous permet d’ajouter un lien hypertexte à partir d’une URL fournie ou un lien vers un article de la base de connaissances.

  • Le glossaire vous permet d’ajouter des termes de glossaire à votre extrait.


Utilisation de l’extrait dans l’article

Il existe deux méthodes par lesquelles vous pouvez ajouter un extrait à votre article.

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

Dans l’éditeur Markdown, tapez un extrait de code. MergeCodeValue entre accolades doubles fermées.

Exemple : {{snippet. Avis de non-responsabilité}}

Vous devez connaître la valeur exacte du code de fusion pour ajouter l’extrait de code souhaité. L’extrait ne fonctionnera pas même si une seule lettre change.

NOTE

Taper dans l’extrait. Merge_Code_Value ne fonctionnera que dans l’éditeur Markdown. Si vous utilisez Advanced WYSIWYG editor, vous pouvez insérer un extrait de code à l’aide de la barre d’outils.

Méthode 2 : à partir de la barre d’outils (Markdown, WYSIWYG et WYSIWYG avancé)

  1. Cliquez sur Réutilisation du contenu () pour l’éditeur Markdown et WYSIWYG.
    Pour l’éditeur WYSIWYG avancé, cliquez sur Insérer > Snippets, ou à l’aide de la commande oblique « / », vous pouvez accéder aux extraits.

  2. Sélectionnez l’extrait de code ou utilisez la barre de recherche d’extraits de code pour affiner le nom de l’extrait.

Dans l’éditeur WYSIWYG avancé, le volet Snippets s’affiche à droite pour la sélection d’extraits de code. Placez le pointeur sur le nom de l’extrait de code pour prévisualiser son contenu.

  1. Sélectionnez l’extrait de code à insérer.

NOTE

Si l’option Insérer en tant que copie locale est activée, le contenu de l’extrait ajouté à l’article restera inchangé. L’extrait de l’article ne sera pas affecté si le contenu de l’extrait sélectionné est modifié ou supprimé à l’avenir.

Inserting snippets in the article in the Knowledge base portal.


Page de présentation de l’extrait

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

  1. Accédez à Documentation () > Content tools > Content reuse > Snippets dans le portail de la base de connaissances.

    La page Snippets apparaît où vous pouvez trouver la liste des extraits que vous avez déjà ajoutés.

Explaining the Snippet overview page

  1. Langues : pour filtrer l’extrait de code dans Global ou dans une langue spécifique.

  2. Rechercher des extraits : recherchez dans la liste des extraits en fonction de leur nom.

  3. Utilisé dans : Si un extrait n’est pas ajouté à une page d’article/catégorie, le statut sera -. Si un extrait est ajouté à une page d’article/catégorie, vous pouvez cliquer sur le bouton Afficher pour afficher la liste des articles/pages de catégorie contenant l’extrait.  

  4. Langue : langue souhaitée pour chaque extrait.

  5. Dernière modification : la dernière fois que le contenu de l’extrait a été mis à jour.

  6. Aperçu : cliquez sur le nom de l’extrait de code pour afficher son contenu.

  7. Progression : cliquez sur l’icône en forme de globe pour afficher la progression de l’extrait de code dans plusieurs langues.

  8. Icône Modifier () : pour modifier le contenu de l’extrait.

  9. Icône Supprimer () : pour supprimer l’extrait de code.


Afficher la dépendance de la page article/catégorie

Dans la pageSnippets, vous trouverez la colonne Utilisé dans.

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

    Le panneau Afficher les références apparaîtra, où vous pourrez afficher la liste des articles/pages de catégories auxquels l’extrait a été ajouté.

  2. Cliquez sur l’article pour agrandir la section.

  3. Vous pouvez trouver les informations suivantes :

    • 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 de la personne qui a ajouté l’extrait.

    • L’article indique (Publié, Brouillon, Nouvel article).

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

Viewing the dependencies of snippets


Modifier un extrait existant

  1. Accédez à Documentation () > Content tools > Content reuse > Snippets dans le portail de la base de connaissances.

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

  2. Passez la souris sur l’extrait de code souhaité et cliquez sur l’icône Modifier ().

  3. Une fois que vous avez terminé la modification du contenu, cliquez sur le bouton Mettre à jour .

NOTE

Lorsque vous mettez à jour un extrait de code dans la bibliothèque, les modifications sont automatiquement répercutées dans tous les articles et pages de catégorie qui l’utilisent. Cela inclut les articles publiés, qui seront mis à jour sans qu’il soit nécessaire de les republier.

Editing the existing snippets


Suppression d’un extrait de code

  1. Accédez à Documentation () > Content tools > Content reuse > Snippets dans le portail de la base de connaissances.

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

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

  3. Cliquez sur Oui dans l’invite de confirmation.

Pour supprimer en bloc plusieurs extraits de code

Sélectionnez plusieurs extraits de code prévus dans la page Snippets et cliquez sur l’option Supprimer en haut de la liste.

Deleting the snippets in the Knowledge base portal


Traduction d’extraits

Vous pouvez créer et gérer des extraits de code dans plusieurs langues. Ainsi, lorsque vos articles sont traduits, les extraits correspondent à la langue de l’article, offrant ainsi une expérience utilisateur cohérente et localisée.  

NOTE

Les extraits globaux ne peuvent pas être traduits.

Traduction de nouveaux extraits

  1. Accédez à l'> Content tools > Content reuse > Snippets Documentation () dans le portail de la base de connaissances.

  2. Cliquez sur Créer un extrait de code.

  3. Dans la liste déroulante Langue , sélectionnez la langue souhaitée.

  4. Entrez le nom de l’extrait et le contenu de l’extrait en anglais (ou dans votre langue par défaut).

  5. Cliquez sur Passer à Markdown pour passer de l’éditeur de contenu WYSIWYG à l’éditeur Markdown.

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

  7. Sélectionnez la ou les langues souhaitées dans le menu déroulant et cliquez sur Traduire.

NOTE

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

  • Les langues traduites seront indiquées par une coche verte pour indiquer que la traduction est terminée. Si nécessaire, vous pouvez accéder aux langues non traduites et terminer leur traduction.

  1. Une fois les traductions terminées, cliquez sur Créer un extrait pour enregistrer l’extrait avec ses 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, espagnol, allemand, etc.

Translating the snippets in the Knowledge base portal

Traduction d’extraits existants

  1. 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 traduit pour une langue spécifique, cliquez sur Supprimer la langue.

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

Translating the existing snippets


Foire aux questions

Combien d’extraits peut-on créer dans un projet ?

Vous pouvez créer jusqu’à 200 extraits de code dans un seul projet. Si vous avez besoin de plus, des extraits supplémentaires peuvent être achetés en tant que module complémentaire.

Puis-je modifier le nom d’un extrait après sa création ?

Bien que vous puissiez modifier le contenu d’un extrait de code, son nom ne peut pas être modifié après sa création.

Pourquoi un extrait est-il inséré dans une nouvelle ligne ?

Les extraits sont conçus comme de nouveaux blocs de contenu, permettant d’ajouter plusieurs lignes à l’intérieur. En tant que tels, ils partiront toujours d’une nouvelle ligne pour maintenir la structure et la clarté.