Choix de l’éditeur dans Document360

Plans de soutien à l’utilisation des éditeurs

L’utilisation de l’éditeur de texte dans Document360 est essentielle pour créer et gérer efficacement les articles de la base de connaissances.

Document360 vous permet de rédiger des articles dans trois options d’édition polyvalentes :

1. Le Markdown editor permet aux rédacteurs d’utiliser la syntaxe et le HTML pour personnaliser les articles.

2. L’éditeur WYSIWYG (What You See Is What You Get) utilise la mise en forme du texte enrichi et inclut une barre d’outils de mise en forme étendue ; Toutefois, vous ne pouvez pas utiliser de code personnalisé dans les articles.

3. Le Advanced WYSIWYG editor est le dernier ajout aux options de l’éditeur dans Document360 et agit comme un hybride entre les éditeurs Markdown et WYSIWYG.

Document360 garantit une expérience conviviale qui améliore la clarté, la cohérence et l’engagement du contenu.

Éditeur Markdown

L’éditeur Markdown dispose d’un espace de travail en écran partagé et de fonctionnalités pour vous aider à gérer un article au fur et à mesure que vous l’écrivez.

1. C’est sur le côté gauche de l’écran que vous tapez et appliquez la syntaxe Markdown.

2. L’écran d’aperçu sur le côté droit vous permet de voir à quoi ressemblera votre article avant de le publier.

3. Le défilement activé indique que les deux sections défilent simultanément. Cliquez sur Faire défiler pour désactiver le défilement automatique.

4. Cliquez sur Aperçu pour voir comment votre article apparaîtra sur le site de la base de connaissances.

5. Après la publication, vous pouvez trouver l’icône Copier le lien () près de l’icône Afficher dans la base de connaissances ().

Utilisez les flèches sur le séparateur pour réduire l’une ou l’autre des fenêtres de l’éditeur.

Scénarios dans lesquels l’éditeur Markdown est recommandé

L’éditeur Markdown offre une flexibilité guidée pour la création et la personnalisation d’articles et applique un style d’écriture et un formatage cohérents dans toute la documentation. Cette cohérence est cruciale pour maintenir une apparence professionnelle dans la documentation du produit.

Par exemple, vous pouvez insérer des images à l’aide de la barre d’outils, qui injecte le Markdown suivant :

![Image Alt Text] (Image URL){height="" width=""}.

Vous pouvez ajuster la taille de l’image en ajoutant les valeurs souhaitées (par exemple, height="600px », width="400px »). Une mise en forme avancée, telle que les ombres et les bordures, peut être réalisée à l’aide d’extraits de personnalisation HTML.

Editeur WYSIWYG

Le WYSIWYG, qui signifie What You See Is What You Get, est un éditeur HTML qui diffère de l’éditeur Markdown. Il vous permet d’afficher la mise en forme réelle de l’article au fur et à mesure que vous tapez ou insérez du contenu.

Scénarios dans lesquels l’éditeur WYSIWYG est recommandé

Si les membres de l’équipe qui contribuent aux articles sont familiers avec les éditeurs basés sur HTML comme WordPress, cet éditeur est relativement facile à utiliser. De plus, si vos articles de documentation contiennent beaucoup de code et de médias, l’éditeur WYSIWYG offre des options de formatage étendues pour le texte, les images, les vidéos, etc.

NOTE

Pour plus d’informations, consultez l’article sur WYSIWYG editor.

Éditeur WYSIWYG avancé

Léger et puissant, l’éditeur WYSIWYG avancé offre des capacités d’édition de texte riches et prend en charge la syntaxe Markdown, offrant une expérience plus visuelle et intuitive par rapport à l’éditeur Markdown tout en conservant une flexibilité similaire à celle de l’éditeur WYSIWYG.

Tapez / dans l’éditeur et une liste d’options s’affiche. Vous pouvez rechercher les options en tapant des noms de commande. Cliquez sur la commande souhaitée ou appuyez sur la touche Entrée pour sélectionner la commande.

Scénarios dans lesquels l’éditeur WYSIWYG avancé est recommandé

Supposons que vous ayez des articles de la base de connaissances avec des articles centrés sur le texte, lourds en code et riches en médias. Dans ce cas, l’éditeur WYSIWYG avancé est une alternative flexible à Markdown et WYSIWYG. Cela permet une édition rapide basée sur la syntaxe similaire à Markdown et des options de formatage de texte et d’image larges comme l’éditeur WYSIWYG.

NOTE

Pour plus d’informations, reportez-vous à l’article d’aide de Document360 sur Advanced WYSIWYG editor.

Modification de l’éditeur par défaut au niveau du projet

Pour faire de l’éditeur WYSIWYG/WYSIWYG avancé l’éditeur par défaut :

1. Accédez à Paramètres () > Portail de la base de connaissances > Général dans le portail de la base de connaissances.

2. Dans la section Éditeur , choisissez l’éditeur de votre choix.

3. Cliquez sur Enregistrer.

NOTE

Si vous modifiez l’éditeur par défaut de votre projet, tous les nouveaux articles que vous créez seront dans votre choix d’éditeur respectif.

Basculement entre Markdown - WYSIWYG - Éditeur WYSIWYG avancé

L’éditeur Markdown est l’éditeur par défaut pour tous les nouveaux projets et articles dans Document360. Si vous souhaitez utiliser l’éditeur WYSIWYG ou WYSIWYG avancé, vous pouvez y basculer au niveau du projet ou de l’article.

Changement d’éditeur au niveau de l’article

Pour changer d’éditeur dans une page /category individuelle, suivez les étapes ci-dessous

1. Sur la page de l’article/de la catégorie, cliquez sur l’icône Plus (•••), puis sélectionnez Plus d’options d’article.

   Le panneau des paramètres de l’article apparaîtra.

2. Dans l’onglet Éditeur , sélectionnez l’éditeur de votre choix.

3. Cochez la case Voulez-vous vraiment continuer ? .

4. Cliquez sur Enregistrer.

   Les mêmes étapes s’appliquent à la documentation de l’API.

   5_Screenshot-Switching_editors

   

NOTE

Une fois que vous avez basculé vers l’éditeur WYSIWYG avancé au niveau de l’article, vous ne pouvez pas rétablir le type d’éditeur pour cet article particulier. Toutefois, pour les articles futurs, l’utilisateur disposant de l’autorisation Paramètres du projet - Mise à jour peut définir l’éditeur par défaut à partir des paramètres > du portail de la base de connaissances > de l’éditeur de > général.

Gestion des balises et attributs HTML non pris en charge dans l’éditeur WYSIWYG avancé

L’éditeur WYSIWYG avancé de Document360 garantit la sécurité du contenu en gérant les balises et attributs HTML non pris en charge. Au lieu de les supprimer, l’éditeur signale et conserve ces éléments pour que les utilisateurs puissent les examiner et les corriger.

Quand cela se produit-il ?

1. Migration de WYSIWYG vers l’éditeur WYSIWYG avancé

   Lorsque vous passez d’un éditeur à l’autre, le contenu non pris en charge est automatiquement identifié et signalé aux utilisateurs afin de résoudre les problèmes potentiels.

2. Modification du contenu dans l’éditeur WYSIWYG avancé

   Lorsque des balises ou des attributs non pris en charge sont ajoutés dans le mode Code, l’éditeur les détecte, les signale et les marque visuellement pour correction.

Que se passe-t-il lorsque des éléments non pris en charge sont détectés ?

• L’éditeur détecte les balises HTML non prises en charge (par exemple, <marquee>, <blink>) et les attributs (par exemple, onmouseover, style="text-decoration:blink") lors de l’analyse.

• Ces éléments sont signalés visuellement dans le contenu à l’aide d’indicateurs personnalisés, tels que des info-bulles et des surbrillances de bloc, sans perturber la structure du contenu.

• Dans l’éditeur, vous ne pouvez pas modifier le bloc de l’élément non pris en charge souhaité. Toutefois, les utilisateurs peuvent interagir avec les éléments marqués et recevoir des options pour les modifier, les supprimer ou les corriger dans la vue Code.