Opensearch pour ajouter le moteur de recherche à votre navigateur

OpenSearch est une technique permettant d'intégrer un moteur de recherche présent sur un site, directement dans un navigateur.

Vous pouvez par exemple ajouter le moteur de recherche d'Alsacreations.com à votre navigateur si celui-ci est équipé d'une zone adaptée. Il vous suffit de cliquer sur la liste déroulante des moteurs intégrés et de choisir "Ajouter". Vous pourrez le retirer par la suite si vous le souhaitez dans les paramètres (sous Firefox "gérer les moteurs de recherche").

Les navigateurs compatibles avec Opensearch sont :

• Mozilla Firefox 2+
• Google Chrome 3+ (voir Chromium)
• Internet Explorer 7 et 8
• Arora et divers autres logiciels

OpenSearch a initialement été proposé par A9 (Amazon). Chrome suggère même via la barre de navigation de lancer une recherche directement sur le site destination lorsqu'il détecte un site référencé comme supportant OpenSearch. C'est le cas d'Alsacreations.com

Comment cela fonctionne-t-il en pratique ?

Pour ajouter une telle fonctionnalité sur votre site, il vous suffira d'éditer deux fichiers.

La description XML

Premièrement il faut créer un fichier XML tel que opensearch.xml, placé par exemple à la racine de votre site :

<?xml version="1.0" encoding="UTF-8" ?>
<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
  <ShortName>Alsacreations</ShortName>
  <Description>Recherche dans les ressources</Description>
  <Image>favicon.png</Image>
  <Language>fr</Language>
  <InputEncoding>UTF-8</InputEncoding>
  <Url type="text/html" template="http://www.alsacreations.com/search/tag/{searchTerms}"/>
</OpenSearchDescription>

Celui-ci est relativement simple à comprendre. Des exemples plus complets avec d'autres balises sont disponibles sur le site Opensearch.org Specifications.

OpenSearchDescription

Il s'agit de l'élément racine, de namespace http://a9.com/-/spec/opensearch/1.1/

ShortName

Le titre de votre moteur/site de recherche

Description

La description un peu plus longue.

Url

L'adresse à interroger, dont l'attribut template définit le masque, notamment via {searchTerms} qui sera remplacé par les mots entrés dans le champ d de recherche (et échappés, de la même façon que urlencode en PHP).

Image

L'url vers l'image favicon du site.

Language

La langue d'après la spécification XML.

InputEncoding

Pour spécifier l'encodage des valeurs à utiliser, par exemple UTF-8.

Le lien avec link

Deuxièmement, y faire référence dans le code source du site, section head, grâce à l'élément link avec les attributs (rel, type, title) appropriés et surtout l'URL vers le fichier XML dans l'attribut href :

<link rel="search" type="application/opensearchdescription+xml" title="Alsacreations" href="http://www.alsacreations.com/opensearch.xml" />

Note : Le titre indiqué dans la balise link doit correspondre au contenu de la balise ShortName du fichier XML.

Bien entendu cette spécification va au-delà du simple ajout au moteur et définit d'autres fonctionnalités d'interrogation et de réponses, avec une présentation des résultats et des agrégateurs.