Plugins OpenSearch : Différence entre versions
De OviWiki
| Ligne 4 : | Ligne 4 : | ||
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 == | == Fichier de description OpenSearch == | ||
| Ligne 14 : | Ligne 13 : | ||
<pre> | <pre> | ||
| − | + | <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="babSkin"><OFPutVar name="babUrl"> |
| − | <Description>Search Ovidentia</Description> | + | <ShortName>Ovidentia</ShortName> |
| − | <InputEncoding>ISO-8859-15</InputEncoding> | + | <Description>Search 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/png"><OVbabUrl>skins/<OVbabSkin>/images/search.png</Image> |
| − | </Url> | + | <Url type="text/html" |
| − | <moz:SearchForm><OVbabUrl>index.php?tg=search&pat=abcdefgh</moz:SearchForm> | + | 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> | </OpenSearchDescription> | ||
</pre> | </pre> | ||
== Découverte automatique du moteur == | == Découverte automatique du moteur == | ||
| − | + | ||
| − | il | + | 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 : | ||
| + | |||
<pre> | <pre> | ||
<link rel="search" type="application/opensearchdescription+xml" title="Recherche Ovidentia" href="{ babUrl }index.php?tg=oml&file=ovisearch.xml&echo=1"> | <link rel="search" type="application/opensearchdescription+xml" title="Recherche Ovidentia" href="{ babUrl }index.php?tg=oml&file=ovisearch.xml&echo=1"> | ||
Version du 18 mai 2007 à 16:00
Les dernières générations de navigateurs (Firefox 2 et IE7) 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
Ce fichier de description au format XML permet de définir le moteur de recherche.
Pour Ovidentia nous créons un fichier OvML qui générera le fichier XML.
Placer dans le répertoire ovml du skin (skins/nom_du_skin/ovml) un fichier ovisearch.xml ayant le contenu suivant :
<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/"
xmlns:moz="http://www.mozilla.org/2006/browser/search/">
<OFPutVar name="babSkin"><OFPutVar name="babUrl">
<ShortName>Ovidentia</ShortName>
<Description>Search Ovidentia</Description>
<InputEncoding>ISO-8859-15</InputEncoding>
<Image width="16" height="16" type="image/png"><OVbabUrl>skins/<OVbabSkin>/images/search.png</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>
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">
