Zeal: Documentación offline a la mano

Estaba leyendo en HumanOS un artículo relacionado con Zeal, una aplicación que nos permite tener documentación sobre diversas aplicaciones, frameworks y sus APIs de forma offline, y quería compartir con ustedes como es que se instala y se añade la documentación disponible.

¿Qué es Zeal?

Zeal es una alternativa a Dash, su homólogo en OS X y a Velocity, su homólogo en Windows. De hecho, usa el mismo listado de docset, que es como llaman a la documentación disponible.

¿Cómo instalamos Zeal?

En su página de descarga podemos encontrar varias formas de instalar Zeal dependiendo de la distribución. En el caso de Ubuntu:

add-apt-repository ppa:jerzy-kozera/zeal-ppa
apt-get update
apt-get install zeal

Para ArchLinux se instala desde AUR:

yaourt -S zeal-git

Hay paquetes para Gentoo y openSUSE, pero para Fedora hay que compilarlo desde la fuente de Zeal. Una vez instalado solo tenemos que ejecutarlo desde el menú de inicio, o desde un terminal.

¿Cómo importamos los Docset a Zeal?

Una vez abierta la aplicación vamos a File (Archivo) » Options (Opciones) » Docsets. Zeal cargará el listado con la documentación disponible y solo tendremos que seleccionar el que queramos y descargarlo desde la misma ventana.

Podemos cerrar la ventana de opciones mientras que se descarga la documentación, y en la ventana principal irán apareciendo en la parte izquierda las entradas que fuimos marcando una vez que se descarguen.

Ahora podemos navegar por cada sección de la documentación descargada o insertar algún criterio de búsqueda (de forma general o usando un prefijo) para que nos muestre los resultados por cada Docset descargado:

A todo esto le añadimos que Zeal se puede integrar con algunos de los editores de textos más populares como Sublime Text, Brackets, VIM o Emacs.

Como bien nos dicen los chicos de HumanOS, se puede crear documentación propia y ponerla dentro de la carpeta donde están nuestros docsets para poder visualizarla. Muchos programas que utilizamos para generar documentación permiten crear docset, tal es el caso de Javadoc, AppleDoc, Sphinx o PyDoctor, RDoc o Yard, Doxygen, entre otros. También se puede llevar documentación HTML a docset, siguiendo la guía que se expone aquí.

Y eso es todo.