En muchos lugares ya no es necesario contar con documentación offline para desarrollar software, gracias a Internet y las mejorías en las conectividad hoy en día podemos encontrar la documentación al alcance de un click. Pero todavía hay lugares en donde es imprescindible contar con la documentación de que queremos desarrollar sin conectividad.

Zeal es un proyecto libre disponible en Github y bajo licencia GNU GPL, para aquellos familiarizados con entornos de OSX existe un software nombrado Dash, del cuál se tomó la idea para realizar este software.  Zeal te permite visualizar información en formato HTML en un programa parecido al Qt Assistant de manera offline, permitiéndote realizar búsquedas en la documentación que tengas disponible.

zeal-homeLas búsquedas las realiza en todas las documentaciones descargardas, siempre mostrando un icono de la documentación al lado derecho de la entrada como se muestra en la siguiente captura.

zeal-searchDentro de las opciones, en el menú Edit >> Options se pueden encontrar ajustes de como visualizarlo a la hora de minimizarlo o cuando va a abrirse, además también se puede especificar en que directorio queremos que se guarden nuestros docsets.

zeal-options-saveEn la pestaña Network se puede configurar las opciones para uso de un poxy, y en la pestaña Docsets es donde se ven las documentaciones descargadas y las disponibles para descargar(esto requiere conectarse con el sitio oficial)

zeal-options-docsetsComo se puede apreciar en la captura anterior la barra de desplazamiento de la documentación  disponible para descargar es grande, en el sitio oficial dicen que existen más de 150 APIs disponibles.

¿Cómo lo puedo obtener?

En el sitio del programa, en la sección de descarga explican varios métodos de descarga para varias distribuciones Linux como Ubuntu, OpenSuse, Arch y Fedora, además de como compilarlo desde sus fuentes(esto lo veremos en otro artículo). También está incluida la descarga para Windows.

Para los que no podemos acceder a este método, se facilitará la descarga a través del FTP pronto.

Zeal para Ubuntu 12.04, 14.04 y 14.10 (1267 descargas)

Para OpenSuse y ArchLinux están en el repositorio. En el caso de Debian no sirven los paquetes para Ubuntu pues tienen dependencias de librerías con versiones superiores. Para resolver el mismo se puede compilar con Qt5, ya estoy preparando un post sobre el tema y también generando un empaquetado.

¿Otra documentación aparte de la del sitio oficial?

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?

Pues no, para los desarrolladores de la UCI hay un nuevo servicio que se brindará en conjunto entre la DGP(Dirección General de Producción) y la DRST(Dirección de Redes y Servicios Telemáticos), se trata de la posibilidad de acceder a toda esta documentación sin tener que acceder al sitio oficial.

Explico un poco como funciona para comprender mejor el servicio. En el apartado docsets de las opciones, podemos agregar una nueva URL para descargar alguna documentación especifica mediante le botón Add feed. Nos saldrá un cuadro pidiéndonos que se introduzca una url, la cuál es un xml que indica desde donde descargará la documentación..

zeal-options-new-feed

Las urls se podrán acceder desde el sitio de documentación de la DGP. Una vez que hayamos agregado la url, el programa comenzará a descargar la documentación.