Как просматривать и искать документацию API в автономном режиме в Linux
Для программиста хорошая документация по API стоит больше, чем библиотека учебников по программированию. Если вы заядлый разработчик, вы, вероятно, захотите облегчить себе жизнь, держа всю необходимую документацию по API прямо у себя под рукой. Большинство IDE предоставляют краткие всплывающие подсказки или специфичные для IDE способы включения документации по API. Однако в основном они относятся к IDE, а доступность и объем документации зависят от языка.
Это когда Zeal может помочь вам. Zeal — это автономный браузер документации по API. Идея Zeal исходит от Dash, браузера документации MacOS X, который поставляется с более чем 130 тщательно подобранными наборами документов (docsets) популярных языков программирования, скриптов и фреймворков. Zeal может получить доступ к тем же наборам документации, что и Dash. Каждый набор документации содержит подробное определение API, фрагменты кода и примечания, внесенные пользователями.
В этом руководстве я опишу, как настроить Zeal для просмотра и поиска документации по API в автономном режиме на платформах Linux.
Установите рвение на Ubuntu
В Ubuntu 14.04 или более ранней версии:
Установка Zeal на Ubuntu LTS очень проста благодаря репозиторию PPA.
$ sudo add-apt-repository ppa:jerzy-kozera/zeal-ppa
$ sudo apt-get update
$ sudo apt-get install zeal
В Ubuntu 14.10 или новее:
На данный момент официальный PPA не обновлен для последней версии Ubuntu 14.10. Таким образом, установите Zeal, собрав его из исходников:
$ sudo apt-get install git qt5-default libgtk2.0-dev libqt5webkit5-dev libappindicator-dev qtbase5-private-dev libxcb-keysyms1-dev
$ git clone https://github.com/jkozera/zeal.git
$ cd zeal/zeal
$ qmake
$ make
$ sudo make install
Установите Zeal на Debian
Сначала установите QT5 в Debian с помощью официального установщика QT.
Затем установите другие необходимые компоненты перед сборкой Zeal из исходного кода.
$ sudo apt-get install g++ libxcb-keysyms1-dev zlib1g-dev libx11-dev libxslt1-dev libgstreamer0.10-dev libgstreamer-plugins-base0.10-dev libgl1-mesa-dev
Наконец, загрузите исходный код и соберите/установите Zeal из исходного кода следующим образом.
$ git clone https://github.com/jkozera/zeal.git
$ cd zeal/zeal
$ qmake
$ make
$ sudo make install
Установите Zeal на Fedora
Установите необходимые компоненты для сборки Zeal с Qt5.
$ sudo yum install qt5-qtwebkit-devel qt5-qtbase-devel xcb-util-keysyms-devel bsdtar
Скопируйте исходный код из официального репозитория и соберите Zeal из исходного кода.
$ git clone https://github.com/jkozera/zeal.git
$ cd zeal/zeal
$ qmake-qt5
$ make
$ sudo make install
Установите Zeal на Arch Linux
Установка в Arch Linux проста с помощью AUR.
Запустите Zeal в Linux
Чтобы запустить Zeal, просто запустите:
$ zeal
При первом запуске вы можете получить предупреждающее сообщение о конфликтах привязки горячих клавиш. Чтобы обойти это предупреждение, вы можете отключить горячую клавишу Zeal по умолчанию (например, Alt+Пробел). Для этого перейдите в раздел Редактировать → Параметры и выберите Очистить в разделе «Горячая клавиша». Если вы хотите, вы можете настроить собственный ярлык для Zeal.
Единовременная настройка для Zeal заключается в загрузке наборов документации API, которые будут использоваться для поиска определений API в автономном режиме. Как упоминалось ранее, эти наборы документации предоставляются в рамках проекта MacOS X Dash. Zeal может получить доступ к тем же документам API.
Перейдите в раздел Редактировать → Параметры, выберите вкладку Наборы документов и нажмите кнопку Загрузить.
Затем вы увидите список доступных наборов документов, как показано ниже.
Выберите наборы документов, к которым вы хотите получить доступ в автономном режиме, и снова нажмите кнопку Загрузить. После успешной загрузки выбранных наборов документов вы увидите их в списке в разделе Наборы документов следующим образом. По умолчанию выбранные наборы документов будут храниться в ~/.local/share/zeal/docsets.
Теперь вы готовы получить доступ к документации по API. Просто начните вводить API, который вы хотите найти, в левой строке поиска. Определение API мгновенно появится на правой боковой панели.
