Creació de connectors OpenSearch per al Firefox

El Firefox 2 pot fer servir MozSearch, una forma simplificada del format OpenSearch de l'A9 d'Amazon, per a crear connectors de cerca. També s'accepten connectors OpenSearch. Vegeu el web d'OpenSearch per a més detalls.

Un connector de cerca MozSearch és un fitxer XML que descriu un motor de cerca, el seu URL, i els paràmetres que cal passar a aqueix mateix URL.

El fitxer del connector

El fitxer XML que descriu el motor de cerca és realment molt simple i segueix la plantilla bàsica que es mostra a continuació. Cal personalitzar les seccions en cursiva en funció de les necessitats específiques del connector del motor de cerca que esteu escrivint.

<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/"
                       xmlns:moz="http://www.mozilla.org/2006/browser/search/">
<ShortName>Nom del motor</ShortName>
<Description>Descripció del motor</Description>
<InputEncoding>Codificació d'entrada</InputEncoding>
<Image width="16" height="16">data:image/x-icon;base64,dades de la imatge</Image>
<Url type="text/html" method="mètode" template="URLdecerca">
  <Param name="nom del paràmetre 1" value="valor del paràmetre 1"/>
  ...
  <Param name="nom del paràmetre 1" value="valor del paràmetre N"/>
</Url>
<Url type="application/x-suggestions+json" template="URLsuggeriment"/>
<moz:SearchForm>URLformulariCerca</moz:SearchForm>
</OpenSearchDescription>
ShortName
Un nom curt per al motor de cerca.
Description
Una breu descripció del motor de cerca.
InputEncoding
La codificació que s'utilitzarà a l'entrada de dades del motor de cerca.
Url
Descriu l'URL que s'utilitzara en la consulta de cerca. L'atribut mètode indica si s'utilitzarà una sol·licitud GET o POST per a recollir el resultat. L'atribut template indica l'URL base de la consulta de cerca.
Nota: L'Internet Explorer 7 no pot fer sol·licituds del tipus POST.
Hi ha dos tipus d'URL que pot utilitzar el Firefox:
  • type="text/html" s'utilitza per a especificar l'URL per a la mateixa consulta de cerca.
  • type="application/x-suggestions+json" s'utilitza per a especificar l'URL per a recollir els suggeriments de cerca.
Per cada tipus d'URL, podeu utilitzar {searchTerms} per a substituir els termes de cerca introduïts per l'usuari a la barra de cerca. Altres paràmetres de cerca implementats es descriuen als paràmetres d'OpenSearch 1.1.
Per a consultes de suggeriments de cerca, la plantilla URL especificada s'utilitza per a recollir una llista de suggeriments en el format JavaScript Object Notation (JSON). Per a més detalls de com implementar els suggeriments de cerca des del servidor, consulteu Implementació de suggeriments en els connectors de cerca.

Image:SearchSuggestionSample.png

Image
Una icona de 16x16 codificada en Base-64 i representativa del motor de cerca. Una eina util, que podeu utilitzar per a construir les dades que han d'emplaçar-se aquí, és The Data: URI kitchen.


Param
Els paràmetres que cal passar juntament amb la consulta de cerca, en la forma de parells de clau/valor. Quan s'especifica valors, podeu utilitzar {searchTerms} per a inserir els termes de cerca introduït per l'usuari en el quadre de cerca.
Nota: L'Internet Explorer 7 no utilitza aquest element.
SearchForm
L'URL on anar a obrir la pàgina de cerca del lloc al qual el connector està dissenyat. Proporciona una forma que el Firefox permeti a l'usuari visitar el lloc web directament.
Nota: Atès que aquest element és específic del Firefox, i no part de l'especificació OpenSearch, s'utilitzarà el prefix de l'espai de noms XML «moz:« XML com en l'exemple de dalt per a assegurar que els altres agents d'usuari que no puguin fer servir aquest element, el puguin ignorar de forma segura.

Descobriment automàtic dels connectors de cerca

Un lloc web que ofereix un connector de cerca pot notificar-ho perquè així els usuaris del Firefox puguin baixar-se i instal·lar el connector fàcilment.

Per a activar el descobriment automàtic, només cal que afegiu una línea a la secció <HEAD> de la vostra pàgina web:

<link rel="search" type="application/opensearchdescription+xml" title="TítolCerca" href="URLconnector">

Substituïu els elements en cursiva com s'explica a sota:

searchTitle
El nom de la cerca que es realitza, com ara «Cerca al MDC» o «Cerca de Yahoo!».
pluginURL
L'URL del connector de cerca XML, des d'on el navegador podrà baixar-lo.

Si el vostre lloc ofereix més d'un connector de cerca, només cal que ho implementeu per a tots ells. Per exemple:

<link rel="search" type="application/opensearchdescription+xml" title="Mon lloc: per autor" href="http://www.monlloc.cat/autormonlloc.xml">
<link rel="search" type="application/opensearchdescription+xml" title="Mon lloc: per títol" href="http://www.monlloc.cat/titolmonlloc.xml">

D'aquesta manera, el vostre lloc pot oferir múltiples connectors per a cercar tant per autor com per títol des d'entitats separades.

Consells per a la resolució de problemes

Si hi ha algun equivocació en l'XML del vostre connector de cerca, podeu trobar-vos amb errors en descobrir i afegir un connector en el Firefox 2. El missatge d'error pot ser que no serveixi de massa ajuda, per això els següents consells poden servir-vos per a trobar el problema.

  • Assegureu-vos que l'XML del connector de cerca està ben format. Podeu comprovar-ho carregant el fitxer directament en el Firefox. Els símbols «&» en l'url de plantilla cal que estiguin escrits en format HTML: «&amp;». Cal també tancar les etiquetes amb una barra inclinada o una etiqueta de tancament.
  • L'atribut xmlns és important, sense ell podríeu rebre un missatge d'error indicant que «El Firefox no ha pogut baixar-se el connector de l'(URL)»
  • Tingueu en compte que heu d'incloure un URL text/html — els connectors de cerca que només incloguin URL del tipus Atom o RSS (que són vàlids, però que ara no funcionen amb el Firefox) generaran l'error «no s'ha pogut baixar el connector de cerca».

Endemés, el servei de connectors de cerca proporciona un mecanisme de registre que pot ser d'utilitat per als desenvolupadors. Feu servir about:config per a activat la preferència «browser.search.log» a «true». La informació del registre començarà a aparèixer en la consola d'errors del Firefox (Eines->Consola d'errors) quan s'afegeixin els connectors de cerca.

Material de referència

Document Tags and Contributors

Contributors to this page: Toniher, Citora, Rodrigoknascimento
Last updated by: Rodrigoknascimento,