Creando un Buscador para Mozilla Firefox con OpenSearch

Normalmente cuando queremos realizar una búsqueda en alguna página para esto lo que hacemos es que primero introducimos la dirección de dicha pagina a nuestro navegador y posteriormente que cargue realizamos nuestra búsqueda y por ultimo nos esperamos a que nos devuelva el resultado, en cambio este proceso se reduce a la mitad si en cambio realizamos nuestra búsqueda desde los motores de búsqueda incluidos en el Firefox.

En general existen multiples buscadores creados por las compañias de busquedas p.e. google, yahoo, amazon, etc.. en la siguient liga podras agregar algunos a tu firefox.

https://addons.mozilla.org/en-US/firefox/browse/type:4/cat:all?sort=name

Sin embargo falta el nuestro hace apenas algunos días que hemos estado desarrollando la página de mundosica.com me puse a desarrollar un buscador para el Firefox.

Aquí en esta entrada expongo mi experiencia en el desarrollo de esta simple pero potente herramienta que nos ayuda mucho a reducir el tráfico.

buscador OpenSearch

buscador OpenSearch mundosica.com

Indice:

1. Generar nuestro archivo con especificación OpenSearch

2. Insertando el vinculo de instalación.

3.- Poniendo refenrencia de nuestro buscador en la cabecera del sitio.

Paso 1.- Generar nuestro archivo con especificación OpenSearch:

OpenSearch expecificación

OpenSearch expecificación

OpenSearch es un conjunto de formatos simples para el intercambio de resultados de búsqueda.

El documento de descripción OpenSearch formato se puede utilizar para describir un motor de búsqueda a fin de que pueda ser utilizada por las aplicaciones cliente de búsqueda (en nuestro Caso El firefox).

La respuesta OpenSearch elementos se pueden utilizar para ampliar los formatos de sindicación, como RSS y Atom, con el extra de metadatos necesarios para devolver los resultados de la búsqueda.

Para realizar esto nos basamos en el ejemplo de la siguente liga:

http://www.opensearch.org/Specifications/OpenSearch/1.1#Examples

Regresar al Indice

De este ejemplo gener el siguiente archivo: http://mundosica.com/openSearchSICA.xml



 	 Buscador para Mozilla-Firefox code basado en la doc. de .opensearch.or

Buscador para Mozilla-Firefox code basado en la doc. de .opensearch.or

Como podemos ver existen algunos camops importantes tales como:

Los parámetros simples son:

ShortName  : Nombre abreviado de nuestro buscador
LongName   : Nombre de nuestro buscador.
Description: una descripción breve de nuestro buscador.
Contact    : Nuestro contacto como desarrollador.
Developer  : Nuestro contacto como desarrolladores
Attribution: Licencia
Language   : idioma es-mx para México
OutPutEncoding: Codificación de texto que genera como resultado nuestro sitio.
IntPutEncoding: Codificación de texto que recibe como entrada nuestro sitio.

Para los campos de URL
Para type=”text/html” aquí ponemos la dirección que responde cuando le enviamos una consulta en nuestro caso.

http://mundosica.com/09/index.php?searchword={searchTerms}&ordering=&searchphrase=all&option=com_search

Nota: {searchTerms} es la consulta que le estamos enviando a nuestro sitio.
Por ejemplo si queremos hacer un openSearch para google solo pondriamos:
http://www.google.com.mx/search?q={searchTerms}
Pues si queremos buscar por ejemplo fitorec en google basta con acceder a la url:
http://www.google.com.mx/search?q=fitorec

Para los campos Image
Son las imágenes de 64 y 16 pixeles y llevan la ruta absoluta(URL) de las imagenes respectivamente (estas pueden ser png, gif, jpg,etc..).

si quieres tener la imagen como datos en el archivo xml esta herramienta te ayudara mucho.

http://software.hixie.ch/utilities/cgi/data/data

Al cual le mandamos una imagen de 16×16 (de nuestra maquina o una URL) la cual queremos que sea nuestro icono y nos devuelve los datos en la barra URL del navegador.

Para mayor referencia ir al sitio oficial (esta en ingles):

http://www.opensearch.org

Regresar al Indice

Paso 2 .- Insertando el vinculo de instalación.

Para esto nos basamos en una funcion en JavaScript la cual permite agregar un openSearch la documentación adecuada esta en el sitio oficial de firefox pongo la liga.

https://developer.mozilla.org/en/Adding_search_engines_from_web_pages

Este script debera ir en nuestra pagina web les recomiendo que se ponga entre las etiquetas head para que cargue la funcion antes que del boton la manda a llamar.

veamos el script.

IInstalador del openwebSearch en javascript

Instalador del openwebSearch en javascript

Nota: las URL que se le ponga a la funcion addSearchEngine deberan ser absolutas p.e. http://misitio.com/ruta-absoluta/file.xml

Ahora solo es necesario poner la llamada en la funcion a algun evento del usuario p.e. cuando le da click a una imagen, veamos como seria esto:


imagen con accion al instalador

codigo imagen con accion al instalador

Regresar al Indice

Paso 3.- Poniendo refenrencia de nuestro buscador en la cabecera del sitio.

Aunque en este momento ya es complemente funcional nuestro buscador, y desde un boton el usurio instalar en ocaciones no queremos poner mas botones en nuestro sitio o si lo que queremos es que el firefox se de cuenta que en nuestro sitio si es que existe una aplicacion para instalar como se puedeen el la siguiente imagen.

Instalacion desde el administrador de buscadores Firefox

Instalacion desde el administrador de buscadores Firefox

Para que el FireFox identifique los elementos instalables en nuestro sitio tenemos que incruir dicha informacion en nuestra página esto lo realizamos poniendo el siguiente codigo en la cabecera (<head> </head>) de nuestro sitio.


Codigo para que el navegador detecte el buscador

Codigo para que el navegador detecte el buscador

Nota: el parametro href lo debemos cambiar de igual forma por la ruta absoluta en donde se encuentra nuestro archivo xml al igual que el title por el titulo de nuestro buscador.

Realmente espero que esto le sirva a alguien, es por esto que subi el codigo en un archivo comprimido para la descarga directa desde la pagina de mundosica.com.

Deseo mejorar el mundo pero todavia no tengo su codigo fuente!.
Regresar al Indice

Anuncios