{"id":152,"date":"2006-12-03T18:05:30","date_gmt":"2006-12-03T17:05:30","guid":{"rendered":"http:\/\/www.gatellier.be\/blog\/?p=152"},"modified":"2008-03-25T12:43:08","modified_gmt":"2008-03-25T11:43:08","slug":"plugin-recherche-opensearch-firefox2","status":"publish","type":"post","link":"https:\/\/gatellier.be\/blog\/plugin-recherche-opensearch-firefox2\/","title":{"rendered":"Plugin de recherche OpenSearch pour Firefox 2"},"content":{"rendered":"

Firefox version 2 supporte le standard de formatage de donn\u00e9es de recherche OpenSearch<\/a>. Gr\u00e2ce \u00e0 cela, on peut cr\u00e9er des petits plugins de recherche tr\u00e8s utiles pour son navigateur pr\u00e9f\u00e9r\u00e9.<\/p>\n

Format XML OpenSearch<\/h3>\n

Les d\u00e9finitions des diff\u00e9rents \u00e9l\u00e9ments composant un XML OpenSearch<\/a> nous aident \u00e0 composer notre propre plugin de recherche.
\nPour une installation standard de Firefox, vous trouverez les plugins d\u00e9j\u00e0 install\u00e9s dans le r\u00e9pertoire C:\\Program Files\\Mozilla Firefox\\searchplugins<\/code>. Normalement ce r\u00e9pertoire ne contient que des fichiers .xml qui sont les d\u00e9finitions des plugins. Prenons-en un, le fichier amazon.xml<\/p>\n

\r\n<SearchPlugin xmlns="\/\/www.mozilla.org\/2006\/browser\/search\/">\r\n<ShortName>Amazon.com<\/ShortName>\r\n<Description>Amazon.com Search<\/Description>\r\n<InputEncoding>ISO-8859-1<\/InputEncoding>\r\n<Image width="16" height="16">data:image\/x-icon;base64,iVBORw0KGgoA...=<\/Image>\r\n<Url type="text\/html" method="GET" template="\/\/www.amazon.com\/exec\/obidos\/external-search\/">\r\n\t<Param name="field-keywords" value="{searchTerms}"\/>\r\n\t<Param name="mode" value="blended"\/>\r\n\t<Param name="tag" value="mozilla-20"\/>\r\n\t<Param name="sourceid" value="Mozilla-search"\/>\r\n<\/Url>\r\n<SearchForm>\/\/www.amazon.com\/<\/SearchForm>\r\n<\/SearchPlugin>\r\n<\/pre>\n
\n
SearchPlugin<\/code><\/dt>\n
D\u00e9finition du namespace des diff\u00e9rents nodes du fichier xml (dans ce cas-ci, on parle de la d\u00e9finition de Firefox)<\/dd>\n
ShortName<\/code><\/dt>\n
Nom du plugin de recherche<\/dd>\n
Description<\/code><\/dt>\n
Description du plugin de recherche<\/dd>\n
InputEncoding<\/code><\/dt>\n
Encodage des caract\u00e8res du formulaire<\/dd>\n
Image<\/code><\/dt>\n
D\u00e9finition de l’ic\u00f4ne qui sera ajout\u00e9e dans l’interface de recherche encod\u00e9e en Base64<\/dd>\n
Url<\/code><\/dt>\n
Contient les diff\u00e9rents attributs du formulaire de recherche<\/p>\n
\n
type<\/code><\/dt>\n
Format dans lequel les donn\u00e9es sont envoy\u00e9es au serveur<\/dd>\n
method<\/code><\/dt>\n
GET ou POST<\/strong> m\u00e9thode d’envoi des donn\u00e9es au serveur<\/dd>\n
template<\/code><\/dt>\n
C’est l’ACTION<\/strong> du formulaire de recherche<\/dd>\n<\/dl>\n<\/dd>\n
Param<\/code><\/dt>\n
Les diff\u00e9rents champs qui sont pass\u00e9es au formulaire. Le champ sur lequel se fait la requ\u00eate doit avoir la value=\"{searchTerms}\"<\/strong><\/code>. C’est les termes qui seront entr\u00e9s dans le formulaire de recherche de Firefox<\/dd>\n
SearchForm<\/code><\/dt>\n
C’est le lien vers les soumissions de formulaires vides iront.<\/dd>\n<\/dl>\n
Analyse d’un formulaire \u00e0 convertir en plugin.<\/h3>\n
Pour un premier exemple, je me suis bas\u00e9 sur la page d’accueil de Tutmaks.com<\/a> (excellente ressource de tutoriels). Le moteur de recherche du site ne fonctionnant pour l’instant que sur des pages \/index.php et pas sur les pages de d\u00e9tail \/story.php.<\/p>\n
\"Ecran<\/a><\/p>\n
A l’aide de l’Inspector de Firebug, j’ai facilement rep\u00e9r\u00e9 que le nom du champ du formulaire \u00e9tait “search” l’action est vide (d’o\u00f9 l’erreur ci-dessus).<\/p>\n
\r\n<InputEncoding>ISO-8859-1<\/InputEncoding>\r\n<Url type="text\/html" method="GET" template="\/\/tutmarks.com\/index.php">\r\n\t<Param name="search" value="{searchTerms}"\/>\r\n<\/Url>\r\n<\/pre>\n
Pour un second exemple, j’ai pris la recherche invers\u00e9e de num\u00e9ros de t\u00e9l\u00e9phone sur 1307.be<\/a>.<\/p>\n
\"Ecran<\/a><\/p>\n
Il y a plusieurs champs cach\u00e9s dans ce formulaire-ci. J’ai repris les nom et valeurs de ces champs en tant que Param de mon XML<\/p>\n
\r\n<InputEncoding>ISO-8859-1<\/InputEncoding>\r\n<Url type="text\/html" method="POST" template="\/\/1307.be\/fr\/servlets\/ReverseServlet">\r\n\t<Param name="number" value="{searchTerms}"\/>\r\n\t<Param name="iso_language" value="fr"\/>\r\n\t<Param name="template" value="1x07be"\/>\r\n<\/Url>\r\n<\/pre>\n
Ajout de l’ic\u00f4ne du plugin de recherche.<\/h3>\n
J’ai repris les favic\u00f4nes des sites<\/a> repectifs<\/a>. Je les ai enregistr\u00e9es sur mon ordinateur et je les ai converties en base64 avec cet outil<\/a>. De ce fait, les images sont transform\u00e9es en code et sont plus facilement transportable d’un environnement \u00e0 un autre (les images sont incluses dans le fichier XML sous forme de code).<\/p>\n
La documentation OpenSearch pr\u00e9cise qu’on peut aussi mettre une url<\/acronym> vers une ic\u00f4ne de favori ou autre image.<\/p>\n
\r\n<Image height="16" width="16" type="image\/x-icon"><br \/>\r\n\/\/example.com\/favicon.ico<br \/>\r\n<\/Image><br \/>\r\n<\/pre>\n
Code \u00e0 rajouter dans les pages html.<\/h3>\n
Pour que le plugin soit \u00e0 la disposition de tout le monde, il faut l’ins\u00e9rer dans les pages de votre site.<\/p>\n
Cela se fait ais\u00e9ment en ajoutant une balise link real=\"search\"<\/strong><\/code> dans le header de la page html.<\/p>\n
\r\n<link rel="search" type="application\/opensearchdescription+xml" title="Tutmarks.com" href="\/chemin-vers\/d\u00e9finition.xml">\r\n<\/pre>\n
Ajouter les plugins cr\u00e9\u00e9s \u00e0 Firefox 2.<\/h3>\n
Quand un plugin de recherche a \u00e9t\u00e9 trouv\u00e9 par Firefox, l’ic\u00f4ne de la liste des moteurs de recherche prend un fond bleut\u00e9.<\/p>\n
\"Un<\/a><\/p>\n
En cliquant sur cette ic\u00f4ne, on peut voir la liste des plugins de recherche. Dans le bas du menu, on peut rajouter les diff\u00e9rents plugins de recherches.<\/p>\n
\"Ajout<\/a><\/p>\n
L’ordre des moteurs de recherche peut \u00eatre modifi\u00e9 et on peut aussi en supprimer via l’interface de gestion des plugins de recherche<\/p>\n
\"\u00e9cran<\/a><\/p>\n
Le plugin de recherche Tutmarks pour Firefox 2 pr\u00eat \u00e0 l’usage.<\/p>\n
\"Le<\/a><\/p>\n
Liens relatifs<\/h4>\n