Mit Zeal schnell auf API-Dokumentationen zugreifen

Zeal erlaubt es schnell auf verschiedene API-Dokumentationen zu zugreifen. Inspiriert von Dash für OS X steht es für Linux und Windows bereit.

Allgemein

Zeal ist ein Tool welches den schnellen Zugriff auf und das offline Lesen von API-Dokumentationen ermöglicht. Inspiriert wurde die Entwicklung von Dash, welches jedoch nur als OS X Anwendung zur Verfügung steht. Da es auch auf den Datenbestand von Dash zurückgreifen kann stehen bereits über 150 Dokumentationen zum Beispiel für Python 2/3, CSS, PHP, Django, Bash, Arduino und viele weitere Programmier-/Beschreibungssprachen, Frameworks und Anwendungen zur Verfügung.

Über verschiedene Tools ist es auch möglich die eigene API-Dokumentation schnell in ein Dash/Zeal lesbares Format zu überführen.

Über die Webseite kann Zeal zum Beispiel direkt als ZIP-Archiv für Windows heruntergeladen werden. Aber auch für bekannte Linux-Distributionen wie Ubuntu, Arch Linux, Fedora, Gentoo und openSUSE stehen fertige Pakete bereit. So sollte eine Installation bei den meisten Systemen ohne größere Probleme möglich sein.

Einsatz

Nach der Installation und dem ersten Start müssen zunächst die gewünschten Dokumentationspakete heruntergeladen werden. Dazu muss das "Options" Fenster über das Menü unter "Edit->Options" geöffnet werden. Anschließend befindet sich im "Docsets"-Tab eine Liste der bereits global verfügbaren Dokumentationen. Die gewünschten Dokumentationen müssen ausgewählt und heruntergeladen werden. Danach stehen sie über das Hauptfenster zum Durchsuchen und Lesen zur Verfügung.

Standardmäßig werden alle Dokumentationen durchsucht. Jedoch kann die Suchanfrage relativ leicht so erweitert werden, dass zum Beispiel nur die Python-Dokumentation durchsucht wird. Hierfür muss der Suchanfrage py: oder python: vorangestellt werden.

Integration

Seine volle Leistung entfaltet das Tool erst, wenn es in die gewünschte IDE oder den Editor integriert wird. Wie die Integration erfolgt ist auf der Webseite beschrieben. Momentan stehen bereits Erweiterungen für die IntelliJ IDEA Integratio(PHPStorm, pyCharm etc.), vim, Sublime Text und Emacs zur Verfügung.

Screenshots

Fazit

Der erste Eindruck ist sehr positiv. Natürlich stehen alle Dokumentationen und Informationen auch online zur Verfügung, jedoch vereinfacht und verkürzt die schnelle Suche und die Integration in die verschiedenen IDEs und Editoren den Zugriff erheblich. Weiterhin funktioniert die Suche auch offline, was besonders in Gebieten nützlich ist, in denen das mobile Internet gar nicht oder nur sehr eingeschränkt zur Verfügung steht.

Verwandte Artikel