Zeal: Buscador de documentación offline. Instalación y configuración del plugin en Sublime Text

En esta ocasión voy a centrarme en una de las grandes necesidades de los desarrolladores de software. Aquellos que hayan probado este maravilloso mundo de la programación sabrán que conocer todas y cada una de las funciones de un lenguaje de programación es prácticamente imposible.

Por todo esto, una conexión a internet y “San Google” son nuestros más preciados aliados. Crear o debugear una aplicación sin alguna de estas herramientas se convierte en un verdadero quebradero de cabeza. Sin embargo, a pesar de contar con estas utilidades, buscar información sobre una característica del lenguaje siempre nos lleva a realizar las mismas tareas: abrir un navegador o abrir una nueva pestaña, acceder a nuestro buscador preferido, escribir lo que necesitamos y entrar al enlace de la documentación oficial. Todas estas tareas son repetitivas y a veces engorrosas.

¿Qué os parece si pudiésemos contar con una utilidad que nos permitiera unificar toda la documentación de nuestros lenguajes más utilizados y realizar las búsquedas en una única ubicación y además fuera de línea?

Ésta herramienta existe y se llama ZEAL.

¿Qué es Zeal?

Zeal es un buscador de código abierto que permite realizar búsquedas simultáneas en varios conjuntos de documentación aún estando desconectado de internet. Se encuentra disponible para Linux y Windows.

Zeal está inspirado en su homónimo Dash, versión sólo disponible para Mac. De hecho, comparten los mismos repositorios y filosofía.

Un aspecto muy importante es que existen plugins para su interacción con varios editores de texto muy populares entre los programadores como: Brackets, Emacs, Sublime Text, Intellij IDEA, entre otros.

Instalación

Línux

Existen paquetes propios y de terceros para varias distribuciones de Linux, tal y como se detalla en la sección de descargas de la página oficial.

Para los usuarios de ubuntu se resume en la ejecución de 3 comandos:

$ sudo add-apt-repository ppa:zeal-developers/ppa
$ sudo apt-get update
$ sudo apt-get install zeal

Windows

La instalación en Windows se realiza como la de cualquier aplicación: descargar el archivo de instalación, aceptar los términos de licencia e instalar.

Términos de licencia

Si deseamos modificar el entorno de instalación (sólo para el usuario actual o todos los usuarios del equipo), la carpeta de instalación o elegir otras características, podemos hacerlo desde el botón “Advanced“.

Instalación en Windows 01
Instalación en Windows 02
Instalación en Windows 03
Instalación en Windows 04

Uso

La interfaz de Zeal es muy sencilla, muy limpia, con dos zonas bien diferenciadas. A la izquierda encontramos la zona de navegación y a la derecha la sección de resultados.

Interfaz de Zeal

El siguiente paso es configurar nuestro entorno y añadir los conjuntos de documentación de los lenguajes que nos interesen.

En las opciones de Zeal (File -> Options) se puede configurar el arranque de la aplicación, iconos, comandos de acceso rápido, lugar de almacenamiento, apariencia, propiedades de conexión y agregar la documentación.

En la pestaña Docsets encontramos la sección más importante: en ella podemos descargar y actualizar todos los lenguajes que nos interesen. Actualmente existen una gran variedad de lenguajes disponibles como Android, Swift, Java, PHP, JQuery, Angular, React, Express, Node, Wordpres

Pestaña Docsets

Una vez finalizado el proceso anterior, podemos navegar en cada lenguaje o buscar lo que necesitemos.

Ventanas navegación y búsqueda 01

Ventanas navegación y búsqueda 02

Si queremos acotar las búsquedas podemos añadir el lenguaje por delante, por ejemplo: “php:mb_substr“.

Acotar búsquedas

Como podemos observar, ésta herramienta es muy fácil de utilizar, no requiere casi esfuerzo para poder sacarle mucho partido.

La posibilidad de poder integrarlo con nuestros editores preferidos le entrega un mayor valor funcional si cabe. De hecho, y por último, voy a explicar cómo se puede conectar Zeal con uno de mis editores de desarrollo favoritos, Sublime Text.

Instalar Plugin en Sublime Text

El plugin creado para la integración de Zeal en Sublime Text ha sido un gran acierto. Poder realizar búsquedas directamente desde nuestro editor, mediante teclas abreviadas, le da un valor añadido a Zeal.

Existen 3 métodos de instalación:

  1. La forma más rápida y sencilla es mediante el Control de Paquetes.
    1. Accedemos a la línea de comandos mediante ctrl+shift+p
    2. Buscamos el instalador de paquetes
      Instalador de paquetes
    3. Buscamos el plugin de Zeal
      Plugin de Zeal

Y listo!

  1. A través de Git, ó
  2. Manualmente

Una vez instalado, procedemos a configurar el plugin en Preferences->Package Settings->Zeal->Settings – User

En esta sección, debemos añadir la ruta del archivo ejecutable (zeal.exe), si deseamos que los resultados salgan ordenados y aparezcan los lenguajes que vamos a utilizar. La estructura que este fichero debe tener es  la siguiente:

Estructura archivo zeal.exe

En caso de no definir el archivo de ajustes de usuario, se emplearán los ajustes por defecto (Preferences->Package Settings->Zeal->Settings – Default). Podéis copiar la estructura de éste archivo para definir tu propia configuración.

Teclas abreviadas

F1 – Busca el texto sobre el que se encuentra el cursor o sobre el seleccionado. Si existen varios conjuntos de documentación del mismo lenguaje, te permite seleccionar uno de ellos. A continuación abre el interfaz de Zeal.

Búsqueda de texto seleccionado

Shift + F1 – Abre la barra de búsqueda de Zeal

Barra de búsqueda de Zeal

En definitiva…

Con ésta herramienta podemos hacer uso de una gran cantidad de información para desarrollar, debugear o mantener una aplicación. Poder tener la información centralizada y realizar búsquedas desde un único sitio supone una gran ventaja en cada proyecto.

La productividad es un aspecto muy a tener en cuenta hoy en día y, con herramientas como Zeal, podemos mejorarla centrando nuestros esfuerzos en otras tareas como las buenas prácticas, patrones de diseño o simplemente aprendiendo nuevas tecnologías para poder obtener software de calidad.

The following two tabs change content below.

Fausto López

Soy una persona alegre, positiva, en formación continua, responsable e implicado en todo lo que hago. En lo personal soy muy familiar, me encanta bailar, ir al cine y viajar.
Compartir: