Personal tools
Zeal: documentazione sempre disponibile per il tuo lavoro

be zealous

Oct 08, 2014

Zeal: documentazione sempre disponibile per il tuo lavoro

Come fare se nel bel mezzo di un problema, con la necessità di trovare la documentazione per risolverlo, non c'è rete e non possiamo rivolgerci a San Google?

Spesso la documentazione ufficiale di un prodotto non è la prima cosa che si va a vedere quando si cerca una soluzione a un problema specifico.

Una ricerca fatta con buone parole chiave di solito ci porta a navigare siti come stackoverflow.com molto più di quello che navighiamo altri siti come docs.python.org o www.sqlalchemy.org o altri ancora.

La possibilità di cercare documentazione in effetti è la cosa che mi manca di più quando non ho a disposizione una connessione a internet, evento raro ma non impossibile.

In questi giorni mi sono imbattuto in zeal, un "API documentation browser" linux inspirato a Dash (disponibile in ambiente osx). Si tratta di una piccola applicazione in grado di portare offline molta documentazione ufficiale di varie applicazioni o linguaggi di programmazione.

zeal1

Le caratteristiche di questa applicazione che ho trovato più comode sono la possibilità di cercare filtrando per parole chiave fra i vari set di documentazione, ovviamente la possibilità di avere tutto questo disponibile offline e infine la comodità di poter integrare la ricerca con l'editor di testo che uso per lavorare, in modo da poter avviare le ricerche direttamente dalle parole chiave evidenziate nell'editor.

L'installazione del pacchetto è molto semplice. Se si hanno sistemi operativi molto recenti, ci si può affidare a un package manager come apt, oppure compilare tutto da zero.

Avendo ancora una ubuntu 12.04 ho dovuto installare una delle versioni più vecchie, ancora perfettamente funzionante, ma il processo di installazione è stato leggermente più complesso.

A causa della dipendenza di zeal dalle Qt5 ho dovuto cercare idee alternative e mi sono imbattuto in un post che trattava un problema simile e che mi ha dato una mano con l'installazione.

  1. Download qt5 installer from https://qt-project.org/downloads and install to /opt
  2. Install required packages and clang:
    sudo apt-get install libgstreamer-plugins-base0.10-dev libxslt-dev libxml2-dev libxcb-keysyms1-dev bsdtar clang-3.3 libclang1-3.3
  3. Download zeal source code: git clone https://github.com/jkozera/zeal.git
  4. Run /opt/Qt5.2.1/5.2.1/gcc_64/bin/qmake -spec linux-clang && make && sudo make install

Anche nel mio caso avevo già le Qt4 installate nel sistema e, seguendo il procedimento proposto, non ho quasi avuto problemi. Solo cose legate alla mancanza di alcune librerie di sviluppo e risolte installando le libgtk2.0-dev e libappindicator-dev.

Una volta arrivato al termine della procedura di installazione, è necessario andare a scaricare la documentazione a cui si è interessati, come spiegato qui. Dopodiché ho potuto configurare .vimrc per l'integrazione con zeal e il gioco è fatto:


let g:investigate_command_for_python = '/usr/bin/zeal --query ^s' :nnoremap gz :!zeal --query "<cword>"&<CR><CR>
 

Ecco a voi un ottimo strumento per avere sempre sotto mano la documentazione della maggior parte dei linguaggi in auge.

immagine in testata di https://www.flickr.com/photos/cmckane/
immagine facebook di https://www.flickr.com/photos/drh/

Filed under: ,
comments powered by Disqus