Créer un moteur Programmable Search Engine avec des fichiers de configuration

Cette page présente les concepts de base des fichiers de configuration Programmable Search Engine.

  1. Présentation
  2. Qu'est-ce qu'un Programmable Search Engine ?
  3. Fonctionnement ensemble des composants
  4. Créer un moteur de recherche
  5. Modifier les fichiers Programmable Search Engine
  6. Choisir le bon format

Présentation

Si le panneau de configuration ne vous donne pas le niveau de personnalisation dont vous avez besoin, envisagez d'utiliser le format XML Programmable Search. Celui-ci offre davantage de contrôle et de flexibilité, et permet d'accéder à des fonctionnalités plus performantes.

Pour utiliser les fichiers de configuration de Programmable Search Engine, commencez par créer un moteur de recherche de base à l'aide du panneau de configuration de Programmable Search Engine. Une fois votre moteur de recherche créé, vous pouvez télécharger vos annotations et vos fichiers XML de contexte depuis la page Présentation du panneau de configuration.

Principes de base du format XML

Extensible Markup Language (langage de balisage extensible XML) est un langage de balisage à usage général. C'est du texte avec des balises que vous pouvez lire. Par exemple, le format XML Programmable Search inclut les balises suivantes: <Context> </Context> et <LookAndFeel> </LookAndFeel>.

Comme pour tout fichier XML, vos spécifications Programmable Search Engine doivent respecter la syntaxe XML (<element attribute="value">content</element>) et être correctement formatées. Le format XML comporte les règles suivantes:

  • Le format XML nécessite que vos balises de niveau supérieur soient précédées d'une déclaration XML (<?xml version="1.0"?>), ce qui n'est pas obligatoire avec 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. Vous ne pouvez pas utiliser de code XML de ce type: <sandwich><filling> peanut butter</sandwich></filling>. Il devrait se présenter comme suit: <sandwich><filling> peanut butter</filling></sandwich>.
  • Le format XML étant sensible à la casse, veillez à respecter scrupuleusement les majuscules 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 vous-même à l'aide de balises de commentaire (<!-- your comment here -->). Programmable Search Engine n'analysera pas cette ligne de texte sous forme de code XML. En plus de rédiger des rappels ou des descriptions, vous pouvez utiliser les 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 de vos fichiers XML commentés, même après les avoir importés dans le panneau de configuration.

Vous pouvez utiliser un éditeur de texte simple pour créer et modifier des fichiers XML. Enregistrez simplement le fichier texte avec l'extension .xml (par exemple, cse_badminton.xml).

Haut de page

Qu'est-ce qu'un Programmable Search Engine ?

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. Elle permet de définir les paramètres généraux du moteur de recherche, par exemple l'activation de la recherche dans des images ou des résultats mis en avant. Chaque moteur de recherche possède 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 adapté à 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 concernant le classement de ces sites dans les résultats de recherche. Chaque site et les informations qui lui sont associées sont appelés une annotation. En savoir plus sur le fichier XML d'annotations

Nous vous déconseillons de créer l'un ou l'autre de ces fichiers en partant de zéro. Téléchargez-les plutôt depuis la page Présentation du panneau de configuration.

Outre ces composants principaux, un moteur de recherche peut également contenir les fichiers auxiliaires suivants:

  • Promotions: le fichier XML des promotions répertorie une série de résultats personnalisés 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 des termes de recherche, la promotion s'affiche en haut de la page. Vous pouvez utiliser ces promotions pour répondre directement aux requêtes de vos utilisateurs, les orienter vers des informations importantes ou 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 élargit les requêtes de vos utilisateurs pour inclure des variantes du terme de recherche. Par exemple, si un utilisateur recherche le mot "simian", le moteur de recherche recherche également "singe" et "singe". Dans le panneau de configuration, les synonymes sont définis dans l'onglet Synonymes. En savoir plus sur les synonymes

Fonctionnement ensemble des composants

Le fichier XML d'annotations ne spécifie pas le fichier d'annotations à utiliser, et le fichier XML d'annotations ne fait aucune 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 inclut des libellés qui identifient le moteur de recherche, et chaque annotation figurant dans le fichier XML des annotations est balisée avec une ou plusieurs étiquettes identifiant le ou les moteurs de recherche auxquels elle appartient.Si vous modifiez le nom du libellé dans le fichier de contexte, vous devez modifier toutes les annotations associées à ce libellé.

Bien que vous puissiez importer plusieurs fichiers d'annotations, si vous les téléchargez via le panneau de configuration, Programmable Search Engine fusionne tous vos fichiers d'annotations en un seul. Les fichiers d'annotations permettent de personnaliser le même site pour différents moteurs de recherche. Par exemple, un moteur de recherche peut limiter ses recherches à certains sites, un autre les éliminer, et un autre pourrait promouvoir 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 montrant comment chaque site (annotation) est associé à un libellé:

<Annotation about="code.google.com/*" score="1">
  <Label name="_include_"/>
</Annotation>

Haut de page

Créer des moteurs de recherche programmables avancés

Pour créer des moteurs avancés, procédez comme suit:

  1. Déterminez le format qui correspond à vos besoins.
  2. Définissez les spécifications de votre moteur de recherche.
  3. Indiquer à Programmable Search Engine les sites sur lesquels effectuer des recherches
  4. 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 depuis la page Présentation du panneau de configuration. Ne créez pas un fichier à partir de zéro. Procédez comme suit :

  1. Téléchargez le fichier de contexte ou le fichier d'annotations depuis la page Présentation du panneau de configuration. Cliquez sur le bouton Download (Télécharger) dans la section Search Features (Fonctionnalités de recherche).
  2. Utilisez un éditeur de texte compatible avec les terminaisons de ligne de style UNIX (WordPad, Emacs et TextMate fonctionnent, mais pas NotePad). Peu importe le nom du fichier, tant que vous l'enregistrez avec l'extension .xml (par exemple, cx_global.xml)
  3. 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 deviez 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 devrez déboguer votre fichier ou recréer entièrement votre moteur de recherche. Pas amusant.

  4. Modifiez le fichier XML et enregistrez-le. Assurez-vous que votre éditeur de texte enregistre le fichier au format texte Unicode et non dans un autre format.
  5. Importez le fichier dans la section Fonctionnalités de recherche de la page Vue d'ensemble.

Choisir le bon format

Avant de commencer à créer votre Programmable Search Engine, déterminez le format qui répond le mieux à vos besoins. Vous ne devez pas choisir un format plus puissant et complexe que ce dont vous avez besoin, ni en utiliser un que vous risquez de manquer rapidement.

Utilisez le tableau suivant pour choisir le format approprié.

Pour créer Utilisation Parce que Limites Plus d'informations
Un ou quelques moteurs de recherche associés à 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. Il 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 utilisant de nombreux sites, ayant recours aux flux Fichier de contexte et fichiers d'annotations

Les fichiers Programmable Search Engine vous offrent davantage de contrôle sur vos moteurs de recherche et facilitent considérablement la définition et la gestion des sites.

Même si vous envisagez de créer votre moteur de recherche à l'aide de fichiers de contexte et d'annotations, il est judicieux de vous familiariser avec le panneau de configuration.

 Plus vous personnalisez votre moteur de recherche, plus il devient complexe. Vous devez apprendre les éléments et les attributs Programmable Search. Ils ne sont pas difficiles à maîtriser, mais ils nécessitent un peu de temps.

Vous devrez lire le reste du guide du développeur, qui n'est malheureusement pas un support de lecture très intéressant.

 Contexte: Définir les spécifications d'un moteur de recherche et Annotations: sélectionner des sites

Haut de page