codeur & geek

Ces petits plugins compatible avec Firefox et Internet Explorer (7 et 8 ) sont vraiment très pratique pour trouver une information pertinente en quelques clics.

OpenSearch, c'est quoi?

OpenSearch est une collection de technologies permettant à des sites web et des moteurs de recherche de publier des résultats de recherche dans un format standardisé.

source: wikipedia

Pour créer son moteur en quelques clics, rien de plus facile: Il suffit de créer un fichier XML correpsondant au standard OpenSearch 1.1 et de le completer avec les paramètres voulu. Pour exemple, nous allons prendre celui que je viens de créer: Livedocs AS3 Search.

Objectif: créer un plugin qui utilise le moteur de recherche sur d'adobe.com pour trouver des informations sur la documentation officielle de l’actionscript 3.

Etape 1: Identifier la structurte du moteur.

En inspactant le code source du moteur, on remarque l'input correpsondant à notre champ de recherche:

Etape 2: Préparer la requete.

En faisant une recherche sur livedocs, on se rend compte que le site execute la requete suivante:

"site:livedocs.adobe.com/flash/9.0" +{searchTerm}

Il s'agit dans ce cas d'un google custom search et les resultats affichés dépendent de l'index de google.

Etape 3: Créer le fichier XML du plugin.

Commencez par créer un nouveau ficher XML dans ce répertroire: C:\Program files\Mozilla Firefox\searchplugins.

Etant donné que les spécfifications de l'opensearch ont évolué, le plus simple reste encore de se rendre sur le site et de créer la base de son plugin à partir de l'exemple donné:

 
 <?xml version="1.0" encoding="UTF-8"?>
 <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
   <ShortName>Web Search</ShortName>
   <Description>Use Example.com to search the Web.</Description>
   <Tags>example web</Tags>
   <Contact>admin@example.com</Contact>
   <Url type="application/rss+xml"
        template="http://example.com/?q={searchTerms}&amp;pw={startPage?}&amp;format=rss"/>
 </OpenSearchDescription>
 

D'autres exemples plus détaillés ainsi que les spécifications osnt disponible ici: http://www.opensearch.org/Specifications/OpenSearch/1.1

Etape 4: Configurer et tester le fichier XML.

Pour les champs suivants, je pense qu'aucune explication ne s'impose!

<ShortName>Livedocs AS3</ShortName>
<Tags>Adobe Actionscript 3 livedocs</Tags>
<Description>Search in adobe.com AS3 livedocs</Description>
<Contact>admin@example.com</Contact>
<InputEncoding>UTF-8</InputEncoding>
<SyndicationRight>limited</SyndicationRight>

Pour associer une icone à votre plugins, 2 solutions s'offrent a vous:
- Préciser l'url de l'icone:

<img alt="" width="16" height="16" />http://wwwimages.adobe.com/www.adobe.com/favicon.ico

- Convertir l'icone en base64:

<img alt="" width="16" height="16" />data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAABMLAAATCwAAAAAAAAAAAAAvLy//n5+f/39/f/8/Pz//Hx8f/19fX/8vLy//j4+P/z8/P/9vb2//X19f/39/f//f39//AAAAAAAAAAAAAAAAT09P/z8/P/9/f3//f39//z8/P/8/Pz//r6+v/z8/P/9/f3//Pz8//z8/P/9vb2//z8/P/wAAAAAAAAAAAAAAAH9/f/9PT0//39/f/39/f/8fHx//f39//19fX/+Pj4//Pz8//39/f/9/f3//X19f/8/Pz/8AAAAAAAAAAAAAAACvr6//Ly8v////////////Pz8/////////////v7+//39/f///////////////////////AAAAAAAAAAAAAAAA/////////////////////////////////////////////////////////////////////wAAAAAAAAAAAAAAAMjG+v////////////////////////////////8xKu7/MSru//Hw/f//////8fD9//Hw/f8AAAAAAAAAAAAAAAB2cfP///////////////////////////+6uPn/JBzt/4N/9P///////////6yp+P/x8P3/AAAAAAAAAAAAAAAAJBzt/+Pi/P///////////5+b9/9aVPH/Pzjv/yQc7f/j4vz///////////8/OO//8fD9/wAAAAAAAAAAAAAAACQc7f+Rjfb////////////j4vz/JBzt/yQc7f9oYvL////////////Ixvr/JBzt//Hw/f8AAAAAAAAAAAAAAAAkHO3/Pzjv/////////////////1pU8f8kHO3/yMb6////////////dnHz/yQc7f/x8P3/AAAAAAAAAAAAAAAAJBzt/yQc7f+6uPn///////////+sqfj/Pzjv////////////8fD9/yQc7f8kHO3/8fD9/wAAAAAAAAAAAAAAACQc7f8kHO3/aGLy/////////////////8jG+v///////////5+b9/8kHO3/JBzt//Hw/f8AAAAAAAAAAAAAAAAkHO3/JBzt/yQc7f/j4vz///////////////////////////8/OO//JBzt/yQc7f/x8P3/AAAAAAAAAAAAAAAAJBzt/yQc7f8kHO3/g3/0//////////////////////+6uPn/JBzt/yQc7f8kHO3/8fD9/wAAAAAAAAAAAAAAACQc7f8kHO3/JBzt/zEq7v//////////////////////aGLy/yQc7f8kHO3/JBzt//Hw/f+fn5//r6+v/6ysq/8kHO3/JBzt/yQc7f8kHO3/rKn4////////////4+L8/yQc7f8kHO3/JBzt/yQc7f/x8P3/X19f/5+fn/+fn57/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD//w%3D%3D

Le noeud suivant va permettre de configurer les paramètres de la recherche (cf Etape 2):

 
<Url type="text/html" method="GET" template="http://livedocs.adobe.com/cfusion/search/index.cfm">
	  <Param name="loc" value="en_US"/>
	  <Param name="termPrefix" value="=site%3Alivedocs.adobe.com%2Fflash%2F9.0++"/>
	  <Param name="term" value="site%3Alivedocs.adobe.com%2Fflash%2F9.0++%22{searchTerms}%22"/>
	  <Param name="search_text" value="{searchTerms}"/>
	  <Param name="action" value="Search"/>
	</Url>
 

Lorsque le fichier est pret, vous pouvez le testez après avoir redémarré Firefox.

Etape 5: Publier le plugin.

Créez un compte de développeur sur le site de mozilla, renseignez encore quelques informations sur le plugin et publiez le!
Mozilla est assez rigoureux en ce qui concerne le respect de ses utilisateur et la qualité des plugins, il se peut donc que le plugin soit refusé s'il ne respecte pas certaines règles!

Ressources:

• Panneau de contrôle du développeur
• Page d'aide sur firefox
• Spécifications OpenSearch 1.1
  
• Convertir une icone en base64