Squelette OpenSearch 1.1, pour rechercher dans un site web SPIP, version 1.0

-  Nom de squelette : Squelette OpenSearch 1.1
-  Version du squelette : 1.0
-  Auteur : Nicolas Krebs
-  Licence : GPL
-  Compatibilité SPIP : SPIP 1.9 nécessaire
-  Principales fonctionnalités et spécificités : publication d’une déclaration de moteur de recherche, au format OpenSearch 1.1, permettant de lancer des recherches dans un site web fonctionnant avec SPIP.
-  Contributions intégrées et sources d’inspiration : la documentation de ce format (ainsi que les Squelettes Atom 1.0 (version 1.1) et dist/recherche.html de SPIP 1.9 pour le squelette atom).

Version de SPIP

Version de SPIP requise : 1.9 pour la version 1.0, 1.9.2 pour la version 1.0.1.

Installation

Décompresser le fichier ci-joint et copier les deux fichiers *.html dans le dossier des squelettes de votre site web motorisé par SPIP.

Utilisation

Le squelette recherche-opensearch.html publie, au format OpenSearch 1.1, une déclaration de moteurs de recherche, qui peut être utilisée par le client web pour ajouter à ceux installés. Voir par exemple Mozilla Firefox, Microsoft IE7, Mozilla Firefox.

Une fois le squelette installé, vous pouvez y accéder par http://site.spip.example/spip.php?page=recherche-opensearch (avec le réglage des url par défaut de SPIP 1.9).

Pour utiliser le module depuis une page web html, vous devez faire un lien html vers la déclaration, qui peut être :
-  un lien dans un article spip : « [->http://site.spip.example/spip.php?page=recherche-opensearch] »
-  un lien dans un squelette : « <a rel="search" type="application/opensearchdescription+xml" href="(#URL_PAGE{recherche-opensearch})">Cliquer ici pour installer un moteur de recherche pour ce site web</a> »
-  un lien dans la partie head du squelette (typiquement squelette sommaire.html, rubrique.html ou inc-head.html) : « [<link rel="search" type="application/opensearchdescription+xml" href="(#URL_PAGE{recherche-opensearch})" title="[(#NOM_SITE_SPIP|couper{16}|texte_backend)]" />] ».

Version du code précendant, limitant la recherche à une rubrique (et ses sous-rubriques) : « [<link rel="search" type="application/opensearchdescription+xml" href="(#URL_PAGE{recherche-opensearch}|parametre_url{id_rubrique,#ID_RUBRIQUE})" title="[(#NOM_SITE_SPIP|couper{16}|texte_backend)][ (#ID_RUBRIQUE)]" />] ».

Le squelette par défaut dist/recherche.html (dans SPIP 1.9.1) ne comporte pas de telle limitation à une rubrique. L’utiliser sans modification avec un module limitant à une rubrique produira des résultats non conformes au module. (Il faut ajouter {id_rubrique ?} dans les boucles de recherche de recherche.html et préciser la limitation ailleur dans la page.)

Le squelette recherche-atom.html, quant à lui, sert à publier les résultats de recherche au format atom 1.0 (voir l’article Squelettes Atom 1.0 (version 1.1) dont dérive le squelette), de la même façon que recherche.html publie au format html. Cependant ce squelette n’utilise pas de pagination, ce qui limite fortement le nombre de réponses qu’il publie pour une recherche (seule la première page de résultats étant indiquée).

Note : si recherche-atom.html indique recherche.html comme une alternative, l’inverse n’est pas vrai. Si vous souhaitez le faire, vous pouvez ajouter dans la partie head « [<link rel="alternate" type="application/atom+xml" href="(#URL_PAGE{recherche-atom}|parametre_url{id_rubrique,#ID_RUBRIQUE}|parametre_url{recherche,#RECHERCHE})"/>] ».

Exemple

spip-contrib.net opensearch 1.1.xml

Utiliser ce fichier opensearch 1.1 pour rechercher dans spip-contrib.net.

donne accès à un module de recherche pour http://www.spip-contrib.net/. Si le téléchargement direct du fichier ne permet pas de l’ajouter comme moteur de recherche (comme c’est le cas avec Mozilla Firefox 2.0), utiliser le formulaire html ci-joint. Afin d’épargner les ressources de la machine hébergeant http://www.spip-contrib.net/, on pourra utiliser un moteur de recherche tiers, par exemple http://www.google.fr/search?as_sitesearch=spip-contrib.net&q={searchTerms} (plaçable dans l’élément Url d’une copie de spip-contrib.net opensearch 1.1.xml).

Licence

Ces deux squelettes sont fournis sous licence GPL.

Conformité et test

-  Le squelette Atom est soumis aux mêmes limitations que Squelettes Atom 1.0 (version 1.1).
-  La version définitive du format OpenSearch 1.1 n’est pas encore publiée à la date de rédaction de cet article, pour lequel la version de mi-2006 (quelle date ?) a été utilisée.

Section à compléter.