Implementació de suggeriments en el connector de cerca
Per a utilitzar suggeriments de cerca, un connector de cerca cal que defineixi un element addicional <Url> amb el seu atribut type definit com "application/x-suggestions+json". (Això vol dir que el connector d'un motor que implementi els suggeriments tindrà dos elements <Url>, essent l'altre l'URL de cerca text/html principal.)
Per exemple, el connector de cerca de Yahoo té aquesta entrada <Url>:
<Url type="application/x-suggestions+json" template="https://ff.search.yahoo.com/gossip?output=fxjson&command={searchTerms}"/>
Si l'usuari tecleja «fir» a la barra de cerca, i llavors s'atura, el Firefox inserirà «fir» en comptes de {searchTerms} i ho trametrà a aqueix URL:
<Url type="application/x-suggestions+json" template="https://ff.search.yahoo.com/gossip?output=fxjson&command=fir"/>
Els resultats s'utilitzaran per a construir el diàleg de la llista de suggeriments.
Vegeu Creació de connectors MozSearch per a aprendre més sobre com implementar connectors de cerca.
Implementació de suggeriments de cerca en el servidor
Gran bona part de la feina de gestionar els suggeriments de cerca s'implementa en el servidor. Si sou dissenyador d'un lloc web i voleu incorporar-hi suggeriments de cerca, cal que hi implementeu la possibilitat que es retornin els suggeriments en Notació d'objectes de JavaScript (JSON) havent-hi donat un terme de cerca.
Quan el navegador vulgui recollir les possibles coincidències d'un terme de cerca, s'envia una sol·licitud HTTP GET a l'URL especificat per l'element <Url>.
El vostre servidor haurà llavors de decidir quins suggeriments oferirà amb els mitjans que més s'escaiguin, i construir un JSON que consisteixi com a mínim de dos, i fins a quatre, elements:
- cadena de consulta
- El primer element en el JSON és la cadena de consulta original. Això permet al Firefox verificar que els suggeriments coincedeixen amb el terme de cerca actual.
- llista de compleció
- Una matriu de termes de cerca suggerits. Ha de tancar-se la matriu en claudàtors. Per exemple: <tt>["terme 1", "terme 2", "terme 3", "terme 4"]</tt>
- descripcions
- Aquest element opcional és una matriu de descripcions per a cada un dels suggeriments a la llista de compleció. Pot ser qualsevol informació que el motor de cerca pugui voler retornar quan es mostri en el navegador, com ara el nombre de resultats disponibles per a la cerca.
- URL de consulta
- Aquest element opcional és una matriu d'URL alternatius per a cada suggeriment de la llista de compleció. Per exemple, si voleu oferir un enllaç a un mapa en comptes de simplement una pàgina de resultats de cerca per a un suggeriment, podeu retornar un URL al mapa en aquesta matriu.
- Si no especifiqueu un URL de consulta, la consulta per defecte que s'utilitza es basa en la cerca descrita per l'element
<Url>en la descripció XML del connector de cerca.
Per exemple, si el terme de cerca és «fir», i no us cal que es retorni descripcions d'URL alternatius, podeu retorneu el següent JSON:
["fir", ["firefox", "first choice", "mozilla firefox"]]
Tingueu en compte que en aquest exemple només s'especifica la cadena de consulta i la matriu de compleció, excloent-ne els elements opcionals.
La vostra llista de compleció pot incloure tants suggeriments com vulgueu, encara que és recomanable que sigui de fàcil gestió, atès que la mostra de suggeriments s'actualitzarà mentre l'usuari estigui escrivint la seua cadena de cerca. Endemés, el mètode que utilitzeu per a seleccionar els suggeriments és plenament al vostre guts.