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.


6 comentarios

  1.   Docum dijo

    Valla !!. Creía que era algún tipo de programa que permitía mostrar en una misma interface toda la documentación que trae un linux standar de serie, digamos paginas man, paginas info, los docs que se guardan en /usr/share/doc…

    Conocéis algo por el estilo??. Gracias de antemano.

    1.    elav dijo

      KDE lo incluye 🙂

  2.   dhunter dijo

    Esto se agradece más en sistemas como Windows y Mac que no traen doc por defecto, pero por lo menos en mi Debian siempre hago un “apt-cache search paquete doc” antes de ir a buscar algo a la web y pocas veces no está en el repo.

  3.   rawBasic dijo

    Absolutamente genial, no lo conocía.. ..muchas gracias por compartir 😉

  4.   Gerson Lazaro dijo

    Tengo problemas para instalarlo en elementary os:
    “Depende: libqt5core5 (>= 5.0.2) pero no es instalable
    Depende: libqt5gui5 (>= 5.0.2) pero no es instalable”
    ¿Alguna idea? muchas gracias

  5.   eduardo amaro dijo

    Con esta recomendación adiós Sublime text……….

    Buen post

Deja un comentario

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

*

*

  1. Responsable de los datos: Miguel Ángel Gatón
  2. Finalidad de los datos: Controlar el SPAM, gestión de comentarios.
  3. Legitimación: Tu consentimiento
  4. Comunicación de los datos: No se comunicarán los datos a terceros salvo por obligación legal.
  5. Almacenamiento de los datos: Base de datos alojada en Occentus Networks (UE)
  6. Derechos: En cualquier momento puedes limitar, recuperar y borrar tu información.