No voy a entrar en detalles sobre la relevancia o no de los buscadores, todos sabemos que para una persona que pasa la mayor parte de su tiempo en internet, los buscadores son la aplicación por excelencia.
Si existe algo mas fácil de hacer, que un plugin de busqueda (search plugin) para firefox, debe ser escribir un tutorial de como hacer uno. Sin embargo, bromas aparte, creo que un buen tutorial sobre el tema, puede ser útil para muchos que por falta de tiempo o falta de astucia desconocen la simpleza de la tarea.
Como hacer un search plugin para Firefox 2:
A diferencia de su hermano menor (Firefox 1.5), Firefox 2.0.* soporta tres formatos distintos para su search bar.
- Sherlock: estandar desarrollado por Apple.
- MozSearch: forma simplificada del formato OpenSearch de Amazon A9.
- OpenSearch: estandar desarrollado por Amazon A9.
En este post solamente voy a tratar el 3º, OpenSearch un estándar que según sus creadores, pretende ser para la búsqueda lo que el RSS es para la sindicación de noticias. Para el primero (Sherlock) existen un par de tutoriales muy buenos, Como hacer un plugin de… (Microsiervos) y Make your first plugin (en ingles - MozDev) y para el segundo (MozSearch) esta el tuto, se podria decir oficial, Creación de plugins MozSearch (mozilla developer center) que por suerte para muchos esta en castellano………
Plugin de busqueda para Firefox 2 con OpenSearch.
Primero el modelo a seguir:
<?xml version=”1.0″ encoding=”UTF-8″?>
<OpenSearchDescription xmlns=”http://a9.com/-/spec/opensearch/1.1/”>
<ShortName>Nombre Corto de tu Buscador</ShortName>
<Description>Descripcion de la busqueda</Description>
<Contact>tuemail@tuemail.com</Contact>
<Url type=”text/html”
method=”get”
template=”http://www.tudominio.com/?s={searchTerms}”>
</Url>
<LongName>Nombre un poco mas largo de tu buscador</LongName>
<Image height=”16″ width=”16″ type=”image/vnd.microsoft.icon”>http://www.tudominio.com/favicon.ico</Image>
<Query role=”example” searchTerms=”Busca en MI Blog” />
<Developer>Tu Nombre</Developer>
<Attribution>
Copyleft Andres “Artux” Scheffer, Algunos derechos Reservados. CC by-nc 2.5.
</Attribution>
<SyndicationRight>open</SyndicationRight>
<AdultContent>false</AdultContent>
<Language>es-ar</Language>
<OutputEncoding>UTF-8</OutputEncoding>
<InputEncoding>UTF-8</InputEncoding>
</OpenSearchDescription>
Manos a la Obra:
- Abrimos un .txt, en win por ejemplo con Notepad o en linux con Gedit o similar, y copiamos el codigo anterior.
- Ahora solo resta remplazar algunos campos, los demas podemos dejarlos como estan:
=>Buscamos la linea: <ShortName> y remplazamos por el nombre de nuestro buscador.
=>En la linea que empieza con: <Description> va la descripcion del buscador.
=>Donde dice: <Contact> podes poner tu e-mail o uno falso si no tenes interes de estar respondiendo.
=>Atento con esta linea: <Url type=”text/html” …… </Url>, este punto es el que decide si tu plugin funciona o no, donde dice method=”get” puede ser que tu buscador utilice el método post para procesar la busqueda, en ese caso debes remplazar “get” por “post”, de lo contrario dejalo como esta; donde dice template=”http://… tienes que remplazar por la url exacta a tu buscador (si usas wordpress seria algo asi: template=”http://tudominio.com/?s={searchTerms}), tenes que tener en cuenta que {searchTerms} es el comodín, es decir, tenes que poner la url de tu buscador y justo al final agregarle {searchTerms}.
=>Seguimos remplazando: <LongName> el nombre extendido del buscador; en <Image height=”16″ width=”16″… tenes que poner la url exacta a tu favicon.ico; en <Developer> podes poner tu nombre; en <Attribution> el tipo de licencia; en <Language> podes poner es-es; ya con esto el plugin queda funcional.
- Importante: Una vez que hallamos remplazado lo necesario, guardamos el archivo en formato .xml, el archivo tiene que quedar nombrearchivo.xml.
- Subimos a nuestro servidor el archivo, ej: tudominio.com/nombrearchivo.xml, y ya podemos empezar a ofrecerles a nuestros usuarios el searchplugin
Detección automática del plugin de búsqueda por el Navegador:
Para que el navegador detecte tu search plugin tenes que agregar la siguiente linea en el header de tu sitio:
<link rel=”search” type=”application/opensearchdescription+xml” title=”Mi Busacador” href=”http://tudominio/nombrearchivo.xml”/>
Para ofrecer un enlace que instale el plugin:
<a href="javascript:window.external.AddSearchProvider('http://tudominio.com/nombrearchivo.xml')">Instalar</a>
Podes probarlo en funcionamiento:
Recursos:
Generador de favicon online (enlace).
Generador online de search plugin OpenSearch (enlace).
Creo que me extendi demasiado, pero quedo bastante completo. Espero que les sea de alguna Utilidad, Saludos!!
3 comments.