Zeal: Documentació offline a la mà

Estava llegint a humans un article relacionat amb Entusiasme, una aplicació que ens permet tenir documentació sobre diverses aplicacions, marcs i els seus API de manera fora de línia, i volia compartir amb vosaltres com és que s'instal·la i s'afegeix la documentació disponible.

Què és Zeal?

Zeal és una alternativa a Guió, el seu homòleg a OS X ja Velocitat, el seu homòleg a Windows. De fet, utilitza el mateix llistat de docset, que és com truquen a la documentació disponible.

Com instal·lem Zeal?

A la seva pàgina de descàrrega podem trobar diverses maneres d'instal·lar Entusiasme depenent de la distribució. En el cas de Ubuntu:

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

Per a la ArchLinux s'instal·la des d'AUR:

yaourt -S zeal-git

Hi ha paquets per Gentoo y openSUSE, Però per Fedora cal compilar-ho des de la font de Zeal. Un cop instal·lat només l'hem d'executar des del menú d'inici, o des d'un terminal.

Com importem els Docset a Zeal?

Un cop oberta l'aplicació anem a Dossier (Arxiu) » opcions (Opcions) » Docsets. Zeal carregarà el llistat amb la documentació disponible i només haurem de seleccionar el que vulguem i descarregar-lo des de la mateixa finestra.

Podem tancar la finestra d'opcions mentre es descarrega la documentació, ia la finestra principal aniran apareixent a la part esquerra les entrades que vam anar marcant un cop es descarreguen.

Ara podem navegar per cada secció de la documentació descarregada o inserir algun criteri de cerca (de forma general o usant un prefix) perquè ens mostri els resultats per cada Docset descarregat:

A tot això hi afegim que Zeal es pot integrar amb alguns dels editors de textos més populars com Sublim Text, Suports, VI o Emacs.

Com bé ens diuen els nois de humans, es pot crear documentació pròpia i posar-la dins de la carpeta on són els nostres docsets per poder visualitzar-la. Molts programes que utilitzem per generar documentació permeten crear docset, tal és el cas de Javadoc, AppleDoc, Esfinx o PyDoctor, RDoc o pati, Oxigen, entre altres. També es pot portar documentació HTML a docset, seguint la guia que s'exposa aquí.

I això és tot.