Cette page présente les concepts de base des fichiers de configuration Programmable Search Engine.
- Présentation
- Que contient un Programmable Search Engine ?
- Fonctionnement conjoint des composants
- Créer un moteur de recherche
- Modifier les fichiers Programmable Search Engine
- Choisir le bon format
Présentation
Si le panneau de configuration ne vous offre pas le niveau de personnalisation dont vous avez besoin, envisagez d'utiliser le format XML de la recherche programmable. Il vous offre davantage de contrôle, de flexibilité et d'accès à des fonctionnalités plus performantes.
Pour utiliser les fichiers de configuration de Programmable Search Engine, commencez par créer un moteur de recherche basique à l'aide du panneau de configuration Programmable Search Engine. Une fois votre moteur de recherche créé, vous pouvez télécharger vos annotations et les fichiers XML de contexte depuis la page Présentation du panneau de configuration.
Principes de base du format XML
XML est un langage de balisage à usage général. Il s'agit d'un texte avec des tags lisibles. Par exemple, le format XML de la recherche programmable comprend les balises suivantes: <Context> </Context> et <LookAndFeel> </LookAndFeel>.
Comme pour tout fichier XML, les spécifications de Programmable Search Engine doivent respecter la syntaxe XML (<element attribute="value">content</element>) et être correctement mises en forme. Le format XML est soumis aux règles suivantes:
- Le format XML vous oblige à faire précéder vos balises de niveau supérieur d'une déclaration XML (
<?xml version="1.0"?>), mais pas le fichier de configuration Programmable Search Engine. - Tous vos éléments doivent comporter une balise d'ouverture (
<tag>) et une balise de fermeture (</tag>). - Tous vos tags doivent être correctement imbriqués. Un code XML ne peut pas ressembler à ceci:
<sandwich><filling> peanut butter</sandwich></filling>. Il devrait ressembler à ceci:<sandwich><filling> peanut butter</filling></sandwich>. - Le format XML est sensible à la casse. Vous devez donc suivre scrupuleusement la casse et l'orthographe des balises dans les instructions.
- Toutes les valeurs d'attribut doivent être placées entre guillemets (
<element attribute="value">). - Tous les attributs doivent être définis dans la balise d'ouverture (
<element attribute="value">), et non dans la balise de fermeture (</element>).
Vous pouvez rédiger des notes pour vous-même à l'aide de tags de commentaire (<!-- your comment here -->). Programmable Search Engine n'analyse pas cette ligne de texte sous forme de code XML. Outre la rédaction de rappels ou de descriptions, vous pouvez utiliser des commentaires pour mettre temporairement hors service du code XML (par exemple, pour tester certains effets ou résoudre des problèmes). Toutefois, ces commentaires ne sont pas conservés dans les fichiers téléchargés depuis le panneau de configuration. Si vous souhaitez conserver les commentaires, vous devez conserver une copie des fichiers XML commentés, même après leur importation dans le panneau de configuration.
Vous pouvez utiliser un éditeur de texte simple pour créer et modifier des fichiers XML. Il vous suffit d'enregistrer le fichier texte avec l'extension .xml (par exemple, cse_badminton.xml).
Contenu d'un moteur de recherche programmable
Un Programmable Search Engine comporte deux composants principaux, chacun contrôlé par un fichier XML:
- Contexte: le fichier XML de contexte décrit les fonctionnalités de base d'un moteur de recherche. Il définit les paramètres généraux du moteur de recherche (par exemple, si la recherche d'images ou les résultats mis en avant sont activés). Chaque moteur de recherche a son propre fichier de contexte. En savoir plus sur le fichier XML de contexte Pour plus d'informations sur la sélection du format de fichier le plus approprié pour votre moteur de recherche, consultez la page Choisir le format approprié pour votre moteur de recherche.
- Annotations: le fichier XML d'annotations répertorie les pages Web ou les sites Web que votre moteur de recherche doit couvrir et indique vos préférences quant au classement de ces sites dans les résultats de recherche. Chaque site et les informations qui lui sont associées sont appelés annotation. En savoir plus sur le fichier XML d'annotations
Nous vous déconseillons de créer ces fichiers à partir de zéro. À la place, téléchargez-les sur la page Présentation du panneau de configuration.
En plus de ces composants principaux, un moteur de recherche peut également disposer des fichiers auxiliaires suivants:
- Promotions: le fichier XML des promotions répertorie une série de résultats personnalisés qui sont déclenchés par un ensemble prédéfini de termes de requête. Lorsqu'un utilisateur effectue une recherche qui correspond exactement à l'un de vos termes de requête, le résultat mis en avant s'affiche en haut de la page. Les promotions vous permettent de répondre directement aux requêtes de vos utilisateurs, de les diriger vers des informations importantes ou de les diriger vers des pages Web qui ne figurent pas en haut de la page de résultats, mais qui sont particulièrement pertinentes. Dans le panneau de configuration, les promotions sont définies dans l'onglet Promotions. En savoir plus sur les promotions
- Synonymes: le fichier XML de synonymes permet d'étendre les requêtes de vos utilisateurs à d'autres variantes du terme recherché. Par exemple, si un utilisateur recherche le terme "simien", le moteur de recherche recherche aussi le mot "singe" et "singe". Dans le panneau de configuration, les synonymes sont définis dans l'onglet Synonymes. En savoir plus sur les synonymes
Comment les composants fonctionnent ensemble
Le fichier XML de contexte ne spécifie pas le fichier d'annotations à utiliser, et le fichier XML d'annotations ne fait pas référence au fichier de contexte. Programmable Search Engine utilise des libellés pour associer du contexte et des annotations. Le fichier XML de contexte contient des libellés qui identifient le moteur de recherche. Chaque annotation répertoriée dans le fichier XML d'annotations comporte un ou plusieurs libellés identifiant le ou les moteurs de recherche auxquels il appartient. Si vous modifiez le nom du libellé dans le fichier de contexte, vous devez modifier toutes les annotations associées à ce libellé.
Même si vous pouvez importer plusieurs fichiers d'annotations, lorsque vous les téléchargez via le panneau de configuration, Programmable Search Engine les fusionne en un seul fichier d'annotations. Les fichiers d'annotations permettent de personnaliser un même site pour différents moteurs de recherche. Par exemple, un moteur de recherche peut limiter sa recherche à certains sites, un autre peut éliminer ces sites et un autre peut assurer la promotion de ces sites.
context.xml
Voici un exemple de fichier context.xml contenant des libellés identifiant le moteur de recherche auquel il s'applique:
<BackgroundLabels> <Label name="_include_" mode="FILTER"/> <Label name="_exclude_" mode="ELIMINATE"/> <BackgroundLabels>
annotations.xml
Voici un exemple de fichier d'annotations qui montre comment chaque site (annotation) est associé à un libellé:
<Annotation about="code.google.com/*" score="1"> <Label name="_include_"/> </Annotation>
Créer des moteurs de recherche programmables avancés
Pour créer des moteurs avancés, procédez comme suit:
- Déterminez le format qui convient à vos besoins.
- Définissez les spécifications de votre moteur de recherche.
- Indiquez à Programmable Search Engine les sites à rechercher.
- Indiquez à Programmable Search Engine comment classer les résultats de recherche.
Modifier les fichiers Programmable Search Engine
Pour travailler sur un fichier XML, téléchargez les spécifications XML sur la page Présentation du panneau de configuration. Ne partez pas de zéro pour créer un fichier. Procédez comme suit :
- Téléchargez le fichier de contexte ou le fichier d'annotations à partir de la page Présentation du panneau de configuration. Cliquez sur le bouton Télécharger dans la section Fonctionnalités de recherche.
- Utilisez un éditeur de texte capable de gérer les fins de ligne de style UNIX (WordPad, Emacs et TextMate fonctionnent, mais pas NotePad). Peu importe le nom que vous donnez au fichier, du moment que vous l'enregistrez avec l'extension
.xml(par exemple,cx_global.xml). - Créez une copie de sauvegarde du fichier téléchargé au cas où la version modifiée ne fonctionnerait pas comme prévu et que vous devriez revenir à la version précédente.
Si vous ne créez pas de copie et que la version que vous avez modifiée ne fonctionne pas correctement, vous devez déboguer votre fichier ou recréer entièrement votre moteur de recherche. Ce n'est pas amusant.
- Modifiez le fichier XML, puis enregistrez-le. Vérifiez que votre éditeur de texte enregistre le fichier au format texte Unicode et non sous un autre format.
- Importez le fichier dans la section Search Features (Fonctionnalités de recherche) de la page Overview (Aperçu).
Choisir le bon format
Avant de commencer à créer votre Programmable Search Engine, identifiez le format qui répond le mieux à vos besoins. Il est préférable de ne pas choisir un format plus puissant et complexe que ce dont vous avez besoin, ni d'en utiliser un que vous risqueriez de contourner rapidement.
Utilisez le tableau suivant pour choisir le format approprié.
| Pour créer | Utiliser | En effet, | Limites | En savoir plus |
|---|---|---|---|---|
| Un ou quelques moteurs de recherche avec un petit nombre de sites | Panneau de configuration | Vous pouvez créer rapidement votre Programmable Search Engine en remplissant des zones de texte au lieu de créer des fichiers avec un éditeur de texte et de les importer. | Le panneau de configuration est surtout utile pour vous familiariser avec Programmable Search Engine et créer des moteurs de recherche avec peu de sites. | Premiers pas |
| Moteurs de recherche complexes qui utilisent de nombreux sites et utilisent des flux | Fichier de contexte et fichiers d'annotations | Les fichiers Programmable Search Engine vous offrent un meilleur niveau de contrôle sur vos moteurs de recherche, et facilitent grandement les tâches de définition et de gestion des sites. Même si vous envisagez de créer votre moteur de recherche à l'aide de fichiers de contexte et d'annotations, nous vous recommandons de vous familiariser avec le panneau de configuration. |
Plus vous personnalisez votre moteur de recherche, plus il devient complexe. Vous devez apprendre à maîtriser Programmable Search Elements et ses attributs, qui ne sont pas difficiles à maîtriser, mais nécessitent un certain temps d'utilisation.
Vous devrez lire le reste du guide du développeur, qui n'est malheureusement pas le support de lecture le plus passionnant. |
Contexte: Définition des spécifications d'un moteur de recherche et Annotations: sélection de sites |