Bloc-notes de Darathor

Après d’abord plusieurs semaines d’attente de validation, puis deux semaines pour reprendre le temps de m’en occuper, je viens de “commiter” mon premier plugin (Open Search) dans le repository officiel WordPress.

Alors en passant, quelques remarques sur la façon dont ça fonctionne :

• la récupération des informations a afficher dans la page du plugin est bizarre : certaines infos sont reprises de l’en-tête du fichier PHP principal du plugin, d’autres de fichier readme.txt… Alors qu’une partie est présente dans les deux… Pas très cohérent… J’aurais mieux vu l’ensemble pris dans le “readme” (c’est d’ailleurs ce que je pensais à l’origine).
• je serais curieux de savoir pourquoi il n’affiche pas dans la page du plugin les onglets “Installation”, “FAQ” et “Screenshots”, alors qu’ils sont bien présents dans le fichier “readme”…
• il semblerait bien que les infos affichées soient prises dans le “trunk” et non dans la dernière version stable… D’un côté c’est pas con parce que ça permet de les corriger sans “taguer” de nouvelle version exprès mais d’un autre côté ça veut dire que si on “commite” des modifications dans le trunk pour une nouvelle version, ben c’est ça qui va s’afficher alors que cette nouvelle version n’est pas celle qui est disponible en téléchargement par défaut, ce qui ne me semble pas très malin.

Bref, maintenant faut que je me motive pour finaliser la nouvelle version de Post-lister et traduire la doc pour pouvoir le publier aussi

Je viens de mettre en ligne une nouvelle version de mon petit plugin Open search. Cette nouvelle version n’apporte rien fonctionnellement mais inclus le fichier readme.txt nécessaire à l’ajout sur le repository officiel, un fichier de traduction en anglais et une page de documentation en anglais ( enfin, en anglais de développeur qui se débrouille plus ou moins, hein… je suis preneur de toute suggestion de correction qui en ferait du “vrai” anglais ).

Prochaine étape, faire de même avec Post-lister une fois qu’il sera à peu près arrivé à maturité… D’ailleurs la version 0.2 ne devrait pas tarder, maintenant que je suis en vacances, j’ai un peu de temps Au passage s’il y a un volontaire pour la traduction de la doc, il est le bienvenu (pas forcément tout de suite, vu qu’elle va pas mal bouger avec la prochaine version)

Après avoir un peu cherché et trouvé plusieurs plugins gérant Open search mais aucun ne faisait précisément ce que je voulais.

J’ai donc codé ma propre version qui me semble plus complète. Donc qu’est-ce qu’elle fait ?

• elle intègre Open search à Worpress (forcément, c’est un peu le but…).
• elle recherche automatiquement l’icône de favoris, d’abord dans le répertoire du thème courant et ensuite à la racine et à défaut prend l’icône fournie avec le plugin. L’icône recherchée est supposée s’appeler favicon.jpg, favicon.png, favicon.ico ou favicon.gif. Ce qui gère à peu près tous les cas possibles. Y compris mon cas : plusieurs sites tournant avec la même instance de Wordpress.
• le fichier XML Open search est généré à partir du template présent dans templates/open-search-xml.php. Au cas où vous voudriez le changer (c’est peu probable mais bon, à tout hasard…), ce fichier peut être surchargé en ajoutant dans votre thème un fichier open-search-xml.php. Donc pas besoin de modifier directement le plugin, ce qui facilite les mises à jour.
• le plugin est localisé (à l’heure actuelle il n’y a qu’une chaine localisée mais bon). Cf le dossier languages du plugin.

Voilà voilà, l’essentiel est dit, manque plus que le lien pour le téléchargement : Plugin Open search 1.0.

Open Search est une série de format destinés à partager des recherches. En particulier, et c’est le point dont je vais parler ici, c’est via ce format que sont définis les moteurs de recherche gérés par la barre de recherche de Firefox 2 (et également celle d’IE 7 apparemment).

On peut donc assez facilement ajouter un moteur de recherche à la liste via un simple fichier XML, du moment qu’on a l’URL et les paramètres à passer à la page de recherche.

Format du fichier xml

• {NOM} : nom du moteur de recherche. C’est ce nom qui sera affiché dans la liste de sélection du navigateur, veillez donc à ce qu’ils reste aussi concis que possible.
• {DESCRIPTION} : description du moteur.
• {ENCODAGE} : encodage du moteur et de votre fichier XML.
• {ICÔNE} : icône de 16×16 piels associée à votre moteur. Cette icône doit être encodée en base 64, par exemple via ce formulaire.
• {MÉTHODE} : méthode de passage de paramètre : POST ou GET.
• {URL_RÉSULTAT} : URL où soumettre la recherche.

D’autres paramètres optionnels existent, je n’ai détaillé là que les parties nécessaires.

Et ensuite ?

Une fois le fichier réalisé, il peut être être ajouté dans votre répertoire de Firefox, dans le dossier searchplugins (nécessite de redémarrer Firefox).

Il est également possible s’il s’agit du moteur de recherche de votre site, de faire en sorte que Firefox le détecte automatiquement (de la même manière que pour un flux RSS) en ajoutant la balise title appropriée dans la section head de la page :

Où {NOM} correspond au nom indiqué dans le fichier XML et où, vous l’aurez compris, {URL_DU_FICHIER_XML} est à remplacer par l’URL où vous aurez placé le dit fichier…

Ressources complémentaires

• Page dédié sur le Mozilla dev center
• Explications sur la base 64 (utilisée pour l’encodage de l’icône).