 |
This is a machine translation based on the English version of the article. It might or might not have already been subject to text preparation. If you find errors, please file a GitHub issue that states the paragraph that has to be improved. |
1. Introduction
Ce site web — docs.checkmk.com — utilise des pages HTML statiques créées avec Asciidoctor, qui sont mises à jour quotidiennement. Cette solution est performante et constituera le moyen le plus efficace de vous fournir le guide de l'utilisateur pendant de nombreuses années. Un autre avantage est que chaque article est disponible sous la forme d’un fichier unique. Cela signifie que l’index de recherche peut être intégré au système de fichiers sans nécessiter de passer par le réseau. Pour tirer parti de cela, la recherche est passée d’une solution de crawler au programme JavaScript Lunr.js en septembre 2022.
Lunr utilise un index qui est entièrement chargé sous forme d’objet JavaScript lors du premier chargement de la page. Cet objet occupe moins d’un mégaoctet une fois compressé et reste dans le cache du navigateur, ce qui rend la recherche très rapide. Ce n’est que lorsqu’un nouvel index est disponible — c’est-à-dire une fois par jour — qu’il est rechargé dans le cache du navigateur.
La création de l'index en même temps que les pages HTML nous permet de masquer certains éléments de la page, tels que la table des matières, afin que l'index ne contienne que les termes pertinents.
2. Utilisation du champ de recherche
En principe, la recherche fonctionne comme n'importe quel autre moteur de recherche : saisissez vos termes de recherche dans la case de recherche sur docs.checkmk.com.
Ceux-ci sont comparés à l'index et vous obtiendrez une liste de résultats classés par pertinence.
2.1. La recherche simple
Dans le cadre d'une recherche simple, saisissez les termes de recherche les uns après les autres dans la case de recherche. La liste obtenue sera classée comme suit :
En haut de la liste des résultats figurent les pages qui contiennent tous les termes de recherche et qui correspondent le mieux.
Viennent ensuite les pages qui contiennent tous les termes de recherche, mais qui saisissent moins étroitement.
Viennent ensuite les pages qui contiennent moins de termes, et enfin celles qui ne contiennent qu'un seul des termes de recherche saisis.
Une occurrence dans le titre de la page ou dans une méta-description est pondérée plus fortement qu'une occurrence dans le corps du texte.
Sous la case de recherche, la liste des 5 meilleurs résultats est affichée. Dans la ligne suivante, vous pouvez afficher tous les résultats dans une nouvelle fenêtre contextuelle.
2.2. Inclusion et exclusion de termes de recherche
Vous pouvez utiliser les opérateurs + et - pour inclure ou exclure explicitement des termes de recherche. Exemples :
|
Recherche toutes les pages contenant « |
|
Recherche les pages contenant |
|
Recherche toutes les pages qui ne contiennent ni |
2.3. Termes utilisés en combinaison
Pour rechercher des termes utilisés ensemble, vous pouvez masquer les espaces, la ponctuation ou les tirets en utilisant deux barres obliques inversées suivies d’un espace.
Ainsi, agent\\ controller trouvera toutes les pages contenant Agent Controller, même si l’orthographe avec un tiret incorrect est utilisée.
Avec +agent +controller, en revanche, les pages trouvées contiennent Agent et Controller dans n’importe quel ordre et avec n’importe quel espacement.
2.4. Caractère générique
L'astérisque * remplace n'importe quelle chaîne de caractères à n'importe quelle position d'un terme de recherche.
Au fur et à mesure que vous tapez, un astérisque est automatiquement ajouté à la fin du texte saisi pour générer l'aperçu.
Terminez votre texte de recherche par un espace pour trouver le terme de recherche exact.
2.5. Pondération
Ajoutez un nombre entier suivi d’un accent circonflexe (^) à un terme de recherche pour lui attribuer une pondération supérieure à la valeur par défaut de ce facteur :
|
La pondération |
3. Création d'un lien vers la recherche
Vous pouvez également transmettre des paramètres de recherche à docs.checkmk.com via l'URL.
Le JavaScript transfère alors le ou les termes de recherche vers le champ de recherche et lance la recherche.
Les paramètres suivants sont disponibles :
|
Au moins un terme de recherche est requis. Vous pouvez séparer plusieurs termes de recherche par |
|
N'ouvre pas l'aperçu avec cinq résultats, mais la fenêtre superposée plus grande contenant tous les résultats. |
|
Ouvre immédiatement l'article correspondant au premier résultat de recherche. |
|
Indiquez ce paramètre à l'origine si vous créez un lien depuis le forum, par exemple, ou si vous configurez la recherche dans le guide de l'utilisateur en tant que moteur de recherche.
Notre serveur web enregistre le paramètre de requête dans ses fichiers journaux.
Nous évaluons ce paramètre statistiquement, actuellement pour |
En principe, la recherche fonctionne sur n'importe quelle page.
Par exemple, vous pouvez accéder à l'article en anglais sur l'agent Linux en effectuant une recherche ouverte sur le terme «linux
» comme suit :
https://docs.checkmk.com/latest/en/agent_linux.html?find=linux&origin=bookmarks