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

Mappage d’URL

  • Mis à jour le Dec 6, 2024
  • 6 Minute(s) lue(s)
  • Pradeep Srinivasan
  • Manoharan Soundarraj
 Prev Next

Plans prenant en charge le widget de base de connaissances

Professional
Business
Enterprise



La fonctionnalité de mappage d’URL du widget de la base de connaissances vous permet de personnaliser l’affichage d’articles et de catégories spécifiques en fonction des pages visitées par vos utilisateurs finaux. Cette fonctionnalité améliore non seulement l’expérience utilisateur en dirigeant les utilisateurs vers du contenu pertinent, mais vous permet également de masquer le widget de base de connaissances sur certaines URL ou de fournir une barre de recherche avec des espaces réservés personnalisés, guidant les utilisateurs sur les éléments de recherche.

Utilisation du mappage d’URL

Pour configurer le mappage d’URL, vous devez effectuer des actions spécifiques dans le widget de la base de connaissances pour les URL désignées.

Actions

Il y a quatre actions que vous pouvez exécuter avec le mappage d’URL :

  1. Afficher l’article : Affiche un seul article sur l’URL spécifiée.

  2. Afficher la liste des articles : Répertorie les articles sélectionnés dans la section Recommandé du widget Base de connaissances sur l’URL spécifiée.

  3. Afficher les résultats de la recherche : Vous permet de définir un terme de recherche spécifique pour interroger votre base de connaissances, en renvoyant des résultats de recherche pertinents sur l’URL spécifiée.

  4. Masquer le widget : Empêche l’icône du widget Base de connaissances d’apparaître sur l’URL spécifiée.

Vous pouvez trouver ces actions sous l’onglet Mappage d’URL ou lors de la modification d’un mappage existant.

NOTE

Pour que le mappage d’URL fonctionne, le widget Base de connaissances doit être installé dans votre site ou votre application. Pour plus d’informations, consultez l’article sur Installing the Knowledge base widget.

Paramètres d’URL

Lors de la configuration de l’URL du widget de la base de connaissances, vous pouvez inclure trois types de paramètres :

  1. Inclure le chemin d’accès : /thisis/a/path

  2. Inclure la requête : ?animal=bear

  3. Inclure le hachage : #inbox

Vous pouvez également activer le bouton bascule Is Regex pour incorporer des expressions régulières dans vos configurations d’URL.

Ajouter le mappage d’URL à votre widget

Pour intégrer le widget souhaité dans votre site de base de connaissances, procédez comme suit :

  1. Accédez à l’onglet Mappage d’URL dans le widget () de l' Knowledge base portal.

  2. Cliquez sur Nouveau mappage d’URL et spécifiez les éléments suivants :

    • Nom - Le nom du mappage d’URL ne sera affiché que sur l’enregistrement de mappage d’URL dans Document360.

    • Structure de l’URL : sélectionnez le type de paramètre d’URL souhaité (Inclure le chemin d’accès/Inclure la requête/Inclure le hachage). Vous devez activer au moins un paramètre d’URL

    • Saisissez l’URL sur laquelle vous souhaitez que l’article/la catégorie s’affiche ou que l’action se produise.

      NOTE

      Votre nom de domaine n’est pas inclus dans le chemin d’accès à l’URL. Par exemple, https://document360.com/ebook/rapid-guide-to-launch-your-knowledge-base/, le chemin d’URL de votre URL sera /ebook/rapid-guide-to-launch-your-knowledge-base/

    • Action - Sélectionnez l’action souhaitée.

    • Sélectionner l’espace de travail : sélectionnez la version souhaitée (si vous avez plusieurs versions).

    • Langue à : sélectionnez la langue souhaitée (si vous avez plusieurs langues).

    • Article à afficher - Dans la barre de recherche, sélectionnez les articles/catégories que vous souhaitez afficher dans la documentation de votre base de connaissances.

    NOTE

    Les catégories de dossiers ne peuvent pas être sélectionnées. Seuls les types de pages et de catégories d’index peuvent être sélectionnés.

  3. Cliquez sur Créer.

1_URLmapping.gifUne fois qu’un utilisateur final accède au chemin d’URL que vous avez spécifié et ouvre le widget de la base de connaissances, il voit l’article/la catégorie mappé. Ces informations restent cohérentes lorsqu’ils naviguent entre les onglets du widget Base de connaissances dans la même version et la même langue.

Modifier le mappage d’URL

Pour modifier un mappage d’URL existant :

  1. Accédez à Widget () dans le Knowledge base portal.

  2. Passez la souris sur le widget de la base de connaissances souhaité et cliquez sur l’icône Modifier ().

    Dans l’onglet Mappage d’URL , vous pouvez trouver la liste des mappages d’URL disponibles.

  3. Passez la souris sur le mappage d’URL souhaité et cliquez sur l’icône Modifier ().

    La lame de mappage Mettre à jour l’URL s’affiche.

  4. Mettez à jour les informations souhaitées et cliquez sur Mettre à jour.

2_urlmapping_edit.gif

Suppression du mappage d’URL

Vous pouvez supprimer un mappage d’URL défini.

3_urlmapping_delete.png

  1. Accédez à Widget () dans l' Knowledge base portal.

  2. Passez la souris sur le widget de la base de connaissances souhaité et cliquez sur l’icône Modifier ().

  3. Dans l’onglet Mappage d’URL , vous pouvez trouver la liste des mappages d’URL disponibles.

  4. Passez la souris sur le mappage d’URL souhaité et cliquez sur l’icône Supprimer ().

  5. Cliquez sur Oui dans l’invite de confirmation Supprimer .

Paramètres de mappage d’URL

Vous pouvez définir le comportement du widget Base de connaissances pour les URL qui n’ont pas de mappage configuré. La définition de ce comportement peut améliorer l’expérience utilisateur et l’accessibilité à la documentation.

4_urlmapping_settings.png

  1. Accédez à Widget () dans l' Knowledge base portal > Configurer et connecter.

  2. Sous Définir les contrôles , développez la section Paramètres de mappage d’URL .

  3. Sélectionnez l’option souhaitée :

    • Accéder à l’aide/base de connaissances de la page : sélectionnez cette option pour afficher l’article/la catégorie dans l’aide de la page ou l’onglet Base de connaissances du widget.

    • Ne pas modifier la configuration existante : sélectionnez cette option pour afficher le dernier article/catégorie ouvert dans le widget.

  4. Cliquez sur Enregistrer.

Correspondance d’URL de base

Comprendre la correspondance d’URL est crucial pour un mappage d’URL efficace. Une expression régulière à usage général pour faire correspondre des URL typiques ressemble à ceci :

^https?://?[a-zA-Z0-9.-]+/[a-zA-Z0-9/._-]*??[a-zA-Z0-9=&._-]*?#[a-zA-Z0-9_-]*?$

Explication des composants

  • ^https?://?: Correspond au protocole (par exemple, http:// ou https://). Cela ? rend le protocole facultatif.

    NOTE

    Assurez-vous d’ajouter une barre oblique inverse (\) avant chaque barre oblique (/) lorsque vous testez votre URL sur https://regex101.com.

  • [a-zA-Z0-9.-]+: correspond au nom de domaine, y compris les lettres, les chiffres, les points (.) et les traits d’union (-).

  • /[a-zA-Z0-9/._-]*?: Correspond au chemin d’accès après le domaine, autorisant les barres obliques, les caractères alphanumériques, les points, les traits de soulignement et les traits d’union.

  • ?[a-zA-Z0-9=&._-]*?: Correspond aux paramètres de requête facultatifs (par exemple, ?key=value), ce qui rend cette partie facultative.

  • #[a-zA-Z0-9_-]*?: Correspond au fragment (par exemple, #section), qui est également facultatif.

Exemples de mappage d’URL à l’aide de Regex

Mappage d’URL avec des chemins d’accès spécifiques

Pour mapper un modèle d’URL tel que /users/{id}, utilisez :

^/users/[0-9]+$

Cela capture un ID utilisateur de manière dynamique.

Exemples de correspondances

  • /users/123

  • /users/456

Mappage d’URL avec des paramètres de requête

Pour les URL comme /search?q={query}, l’expression régulière serait :

^/search?q=[a-zA-Z0-9]+$

Exemples de correspondances

  • /search?q=apple

  • /search?q=123abc

Mappage d’URL avec des paramètres facultatifs

Pour un modèle d’URL tel que /products/{category}/{id}, où category est facultatif :

^/products/[a-zA-Z]+?/[0-9]+$

Exemples de correspondances

  • /products/123

  • /products/electronics/123

Mappage d’URL avec des caractères génériques ou plusieurs chemins d’accès

Pour /blog/*:

^/blog/.*?$

Exemples de correspondances

  • /blog

  • /blog/how-to-code

  • /blog/2021/10

Mappage d’URL avec des sous-domaines
Pour les URL de sous-domaine :

^https?://?[a-zA-Z0-9-]+.example.com$

Exemples de correspondances

  • http://blog.example.com

  • https://shop.example.com

Combinaison de plusieurs composants

Pour gérer des mappages d’URL plus complexes, vous pouvez combiner les différents composants selon vos besoins. L’expression régulière complète qui correspond à une URL avec un protocole, un domaine, un chemin, des paramètres de requête et un fragment facultatifs ressemble à ceci :

^https?://?[a-zA-Z0-9.-]+/[a-zA-Z0-9/._-]*??[a-zA-Z0-9=&._-]*?#[a-zA-Z0-9_-]*?$

Foire aux questions

Comment puis-je supprimer l’aide de la page et la barre de recherche du widget lorsque le mappage d’URL d’un seul article est configuré ?

Pour supprimer l’aide de la page et la barre de recherche du widget lorsque le mappage d’URL d’un seul article est configuré :

  1. Accédez au widget () dans le portail de la base de connaissances.

  2. Passez la souris sur le widget souhaité et cliquez sur l’icône Modifier ().

  3. Collez le code fourni dans l’onglet CSS personnalisé :

    li#page-help-tab {
    display: none;
}

.article-header .article-back-icon {
    display: none;
}

.search-container {
    display: none !Important;
}

  4. Collez le code fourni dans l’onglet JavaScript personnalisé :

    setTimeout(function() { $('.search-container').hide();}, 2000);
setTimeout(function() { $("#knowledge-base-tab").click();}, 2000);

  5. Cliquez sur Enregistrer.

Cela masquera l’onglet d’aide de la page et la barre de recherche dans le widget sur le site de la base de connaissances lorsque le mappage d’URL d’un seul article est configuré.

Comment puis-je voir les mises à jour immédiatement dans le widget de la base de connaissances après l’ajout ou la mise à jour d’une carte d’URL ?

Les mises à jour sont mises en cache sur le serveur pour des raisons de performances et sont automatiquement actualisées toutes les 15 minutes. Toutefois, si vous avez besoin de voir les modifications immédiatement, vous pouvez vider le cache de l’application.

Articles Liés