Qu'est ce que OpenSearch ?

Définition par Wikipédia

Le standard OpenSearch utilise le XML comme principal technologie. Un plugin OpenSearch se compose donc d’un fichier XML et éventuellement d’un favicon pour identifier visuellement le service.
Le standard OpenSearch est maintenant implanté dans Internet Explorer 7 et Firefox 2.

Comment exploiter un plugin OpenSearch à partir du navigateur

Sous Firefox, il vous suffit d’introduire le texte recherche en haut à droite, de sélectionner éventuellement quel plugin utiliser puis taper sur enter ou cliquer sur le petit bouton de droite.


Sous Internet Explorer 7, c’est pareil, vous introduisez le texte recherché puis choisissez quel plugin utiliser ensuite taper enter.

Créer un Plugin OpenSearch

Comme je l’ai dit un plugin OpenSearch est un simple fichier XML donc il faut créer un nouveau fichier texte et lui donner l’extension .xml, Comme tous les fichiers XML le contenu doit se trouver dans une balise principal qui doit être nommé OpenSearchDescription :

<OpenSearchDescription xmlns=http://a9.com/-/spec/opensearch/1.1/
xmlns:moz="http://www.mozilla.org/2006/browser/search/">

Attention ! Il est impératif que la balise OpenSearchDescription contienne l’attribut xmlns sans quoi Firefox vous indiquera qu’il n’a pas pu charger le plugin

Viennent ensuite plusieurs balises servant à décrire le plugin :

<ShortName>Iow4.net</ShortName>
<Description>Recherchez vos articles favoris sur iow4.net</Description>
<Image height="16" width="16" type="image/gif">
http://www.favicon.fr/favicon/sciences-technique/medical-scientifique/loupe01.gif
</Image>
<LongName>Iow4.net Plugin de recherche</LongName>

<Developer>Thomas K (iow457@gmail.com) </Developer>
<SyndicationRight>open</SyndicationRight>
<AdultContent>false</AdultContent>
<Language>fr</Language>
<OutputEncoding>ISO-8859-1</OutputEncoding>
<InputEncoding>ISO-8859-1</InputEncoding>

Voici la signification des différentes balises :

• ShortName : Un nom court pour votre plugin OpenSearch
• Description : Description de votre plugin
• Image : Une image qui accompagnera votre plugin, pour le reconnaître visuellement, cette balise prend comme parametres le mime-type de l’image, sa largeur et sa hauteur ( attributs type,height,width ) et comme contenu l’url de l’image souhaité
• LongName : Un nom plus long pour votre plugin
• Developer : Informations sur le développeur du plugin
• Language : Définit le langage dans lequel les résultats sont disponibles
• OutputEncoding : Définit l’encodage de sortit
• InputEncoding : Définit l’encodage d’entrée

Il ne reste plus qu’a spécifier maintenant ou seront renvoyé les requêtes transmises grâce au navigateur :

<Url type="text/html" method="get" template="http://iow4.net/?q={searchTerms}"></Url>

Nous ne nous attarderons pas sur l’attribut type, les navigateurs n’en gère que deux pour le moment ni sur l’attribut method, IE ne supportant que la method GET.
C’est donc l’attribut template qui va nous permettre de rediriger les requêtes vers la page de recherche. {searchTerms} représente la saisit de l’utilisateur, ici après que le visiteur est validé sa recherche dans le navigateur il sera redirigé vers la page : http://iow4.net/ le navigateur enverra comme paramètre q qui sera égal à la saisie de l’utilisateur.

Exemple de plugin OpenSearch

Nous allons prendre par exemple celui de ce site qui nous a servit d’exemple tout le long de cet article :

<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/"
xmlns:moz="http://www.mozilla.org/2006/browser/search/">
<ShortName>Iow4.net</ShortName>
<Description>Recherchez vos articles favoris sur iow4.net</Description>
<Url type="text/html" method="get" template="http://iow4.net/?q={searchTerms}"></Url>
<Image height="16" width="16" type="image/gif">
http://www.favicon.fr/favicon/sciences-technique/medical-scientifique/loupe01.gif
</Image>
<LongName>Iow4.net Plugin de recherche</LongName>

<Developer>Thomas K (iow457@gmail.com) </Developer>
<SyndicationRight>open</SyndicationRight>
<AdultContent>false</AdultContent>
<Language>fr</Language>
<OutputEncoding>ISO-8859-1</OutputEncoding>
<InputEncoding>ISO-8859-1</InputEncoding>

</OpenSearchDescription>

Déployer le plugin OpenSearch

Maintenant que nous avons un plugin qui est opérationnel le but est de pouvoir le proposer aux visiteurs pour qu’ils l’intègrent dans leur navigateur, nous allons voir deux méthodes d’intégration de plugin OpenSearch, toutes les deux valables dans les navigateurs Internet Explorer 7 et Firefox.

Méthode Manuelle

Cette méthode consiste à placer une balise link dans le head d’une page Web pour que le navigateur reconnaisse le plugin et fasse un signal lumineux à l’utilisateur.
Voici le code à inclure :

<link rel="search" type="application/opensearchdescription+xml" title="Iow4.net Plugin de recherche" href="http://www.iow4.net/OpenSearch.xml" />

title étant le titre de votre plugin OpenSearch et href le lien vers ce dernier.
Quand Firefox détectera ce code la partie de sélection de plugin en haut à droite va devenir bleu et après clique dessus un choit nous permettra d’ajouter le plugin.



Sous Internet Explorer la procédure est la même.

Cette méthode est assez simple, elle ne nécessite pas d’autres technologies que du (X)HTML de base mais elle doit être connu du visiteur car pas très flagrante.

Méthode Automatique

Cette méthode requiert JavaScript ( désactivé chez certaines personnes ) et à travers un simple lien permet d’installer très rapidement un plugin. Exemple :

<a href="#" onClick="window.external.AddSearchProvider('http://iow4.net/OpenSearch.xml');" >Installer mon Plugin OpenSearch</a>


L’installation se fait simplement à partir de la fonction AddSearchProvider qui prend en paramètre l’url du plugin OpenSearch.
Cette méthode est la plus simple pour les utilisateurs les moins avertis.

Conclusion

Vous savez maintenant comment créer un plugin OpenSearch pour votre site Web, vous savez aussi comment le déployer avec deux méthodes.