Plugins OpenSearch : Différence entre versions
De OviWiki
(→Fichier de description OpenSearch) |
|||
| (25 révisions intermédiaires par 2 utilisateurs non affichées) | |||
| Ligne 1 : | Ligne 1 : | ||
| − | [http://opensearch.org/ OpenSearch] | + | [[Catégorie:Technologies à l'étude]] |
| + | |||
| + | Les dernières générations de navigateurs (Firefox 2 et Internet Explorer 7) disposent d'une barre de recherche intégrée qui permet à l'utilisateur d'accéder rapidement à un certain nombre de moteurs de recherche (Google, Yahoo, Wikipedia...) La liste des moteurs proposée par ces navigateurs n'est pas figée et il est possible pour l'utilisateur d'en ajouter de nouveaux. | ||
| + | [[Image:searchbar-firefox.jpg|frame|Zone de recherche dans Firefox]] | ||
| + | Pour être intégrable, un moteur de recherche doit être compatible avec certains standards. [http://opensearch.org/ OpenSearch] définit, entre autres, un format de description de moteur de recherche permettant aux navigateurs d'obtenir les informations nécessaires à leur intégration dans la barre de recherche. | ||
Il est possible de définir un plugin pour accéder au moteur d'Ovidentia. | Il est possible de définir un plugin pour accéder au moteur d'Ovidentia. | ||
| + | ==Fichier de description OpenSearch== | ||
| − | + | Afin de permettre au navigateur de savoir comment dialoguer avec notre moteur de recherche, il est nécessaire de lui fournir une description de celui-ci. | |
| + | OpenSearch définit un fichier de description au format XML contenant toutes les informations nécessaires. | ||
| − | + | Pour Ovidentia, nous nous servirons de l'OvML pour générer le fichier XML. OvML nous permettra d'insérer des éléments dépendants de l'installation d'Ovidentia sur le site (url de base, nom du skin...) et nous n'aurons donc pas besoin de modifier le fichier en cas de changement de paramétrage du site. | |
| − | + | ||
| − | + | Le fichier OvML, que nous appellerons par exemple '''ovisearch.xml''' sera placé dans le répertoire ovml du ''skin'' (skins/''nom_du_skin''/ovml). Son contenu sera le suivant : | |
| − | + | <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" | |
| − | + | ||
xmlns:moz="http://www.mozilla.org/2006/browser/search/"> | xmlns:moz="http://www.mozilla.org/2006/browser/search/"> | ||
| − | <ShortName>Ovidentia</ShortName> | + | '''<OFPutVar name="babSkinPath"><OFPutVar name="babUrl">''' |
| − | <Description> | + | <ShortName>Ovidentia</ShortName> |
| − | <InputEncoding>ISO-8859-15</InputEncoding> | + | <Description>Recherche Ovidentia</Description> |
| − | <Image width="16" height="16" | + | <InputEncoding>ISO-8859-15</InputEncoding> |
| − | <Url type="text/html" method="get" template="<OVbabUrl>index.php?tg=search&pat=abcdefgh&idx=find&what={searchTerms}"> | + | <Image width="16" height="16" type="image/vnd.microsoft.icon"> |
| − | </Url> | + | '''<OVbabSkinPath>'''images/Puces/favicon.ico |
| − | <moz:SearchForm><OVbabUrl>index.php?tg=search&pat=abcdefgh</moz:SearchForm> | + | </Image> |
| − | </OpenSearchDescription> | + | <Url type="text/html" |
| − | </ | + | method="get" |
| + | template="'''<OVbabUrl>'''index.php?tg=search&pat=abcdefgh&idx=find&what={searchTerms}"> | ||
| + | </Url> | ||
| + | <moz:SearchForm>'''<OVbabUrl>'''index.php?tg=search&pat=abcdefgh</moz:SearchForm> | ||
| + | </OpenSearchDescription> | ||
| + | Les spécifications détaillées (en anglais) du format de fichier de description sont accessibles à cette page : [http://www.opensearch.org/Specifications/OpenSearch/1.1#OpenSearch_description_document OpenSearch description document] | ||
| + | |||
| + | ==Découverte automatique du moteur== | ||
| + | |||
| + | Une fois le fichier de description en place, il est possible d'indiquer au navigateur que notre site dispose d'un moteur de recherche compatible avec le standard OpenSearch. Le navigateur avertira ainsi l'utilisateur qu'un moteur de recherche est disponible sur le site et lui permettra de l'ajouter automatiquement à la liste de sa barre de recherche. | ||
| + | Pour cela, il suffit d'ajouter dans la section <head> du template page.html du skin la ligne suivante : | ||
| + | |||
| + | <link rel="search" | ||
| + | type="application/opensearchdescription+xml" | ||
| + | title="Recherche Ovidentia" | ||
| + | href="'''{ babUrl }'''index.php?tg=oml&file='''ovisearch.xml'''&echo=1"> | ||
| − | == | + | ==Références== |
| − | + | <ul> | |
| − | + | <li>[http://opensearch.org/ Documentation OpenSearch] (en anglais)</li> | |
| − | < | + | <li>[http://developer.mozilla.org/en/docs/Creating_OpenSearch_plugins_for_Firefox Documentation sur le Mozilla Developer Center] (en anglais)</li> |
| − | < | + | </ul> |
| − | </ | + | |
Version actuelle en date du 6 mars 2009 à 11:06
Les dernières générations de navigateurs (Firefox 2 et Internet Explorer 7) disposent d'une barre de recherche intégrée qui permet à l'utilisateur d'accéder rapidement à un certain nombre de moteurs de recherche (Google, Yahoo, Wikipedia...) La liste des moteurs proposée par ces navigateurs n'est pas figée et il est possible pour l'utilisateur d'en ajouter de nouveaux.
Zone de recherche dans Firefox
Pour être intégrable, un moteur de recherche doit être compatible avec certains standards. OpenSearch définit, entre autres, un format de description de moteur de recherche permettant aux navigateurs d'obtenir les informations nécessaires à leur intégration dans la barre de recherche.
Il est possible de définir un plugin pour accéder au moteur d'Ovidentia.
Fichier de description OpenSearch
Afin de permettre au navigateur de savoir comment dialoguer avec notre moteur de recherche, il est nécessaire de lui fournir une description de celui-ci. OpenSearch définit un fichier de description au format XML contenant toutes les informations nécessaires.
Pour Ovidentia, nous nous servirons de l'OvML pour générer le fichier XML. OvML nous permettra d'insérer des éléments dépendants de l'installation d'Ovidentia sur le site (url de base, nom du skin...) et nous n'aurons donc pas besoin de modifier le fichier en cas de changement de paramétrage du site.
Le fichier OvML, que nous appellerons par exemple ovisearch.xml sera placé dans le répertoire ovml du skin (skins/nom_du_skin/ovml). Son contenu sera le suivant :
<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:moz="http://www.mozilla.org/2006/browser/search/"> <OFPutVar name="babSkinPath"><OFPutVar name="babUrl"> <ShortName>Ovidentia</ShortName> <Description>Recherche Ovidentia</Description> <InputEncoding>ISO-8859-15</InputEncoding> <Image width="16" height="16" type="image/vnd.microsoft.icon"> <OVbabSkinPath>images/Puces/favicon.ico </Image> <Url type="text/html" method="get" template="<OVbabUrl>index.php?tg=search&pat=abcdefgh&idx=find&what={searchTerms}"> </Url> <moz:SearchForm><OVbabUrl>index.php?tg=search&pat=abcdefgh</moz:SearchForm> </OpenSearchDescription>
Les spécifications détaillées (en anglais) du format de fichier de description sont accessibles à cette page : OpenSearch description document
Découverte automatique du moteur
Une fois le fichier de description en place, il est possible d'indiquer au navigateur que notre site dispose d'un moteur de recherche compatible avec le standard OpenSearch. Le navigateur avertira ainsi l'utilisateur qu'un moteur de recherche est disponible sur le site et lui permettra de l'ajouter automatiquement à la liste de sa barre de recherche. Pour cela, il suffit d'ajouter dans la section <head> du template page.html du skin la ligne suivante :
<link rel="search"
type="application/opensearchdescription+xml"
title="Recherche Ovidentia"
href="{ babUrl }index.php?tg=oml&file=ovisearch.xml&echo=1">
Références
- Documentation OpenSearch (en anglais)
- Documentation sur le Mozilla Developer Center (en anglais)
