Инструменты пользователя

Инструменты сайта


// Unix man pages в Qt Assistant

В продолжении темы, поднятой мною тут: 906984, таки решил озадачится, результатом озадачивания стало два скрипта.

  • gen-man2html.sh - пробегает по указанным секциям man-страниц (где они лежат и какие секции - внутри файла, лениво было опциями делать), и конвертирует их в HTML, заодно, по некоторым патернам создаёт ссылки (типа printf(3) или ссылкки в секцию 0, для <header.h>)
  • gen-html2assistant.sh - собственно уже пробегает по этим, сгенерированным, страницам, делает файл проекта справки Qt Assistan и, по завершении, вызывает qhelpgenerator для создания файла справки (на самом деле это SQLite база). После чего этот файл можно подключить в Qt Assistant:

Для того, что бы к работал поиск в «Указателе», нужно указывать ключевые слова, в данный момент, в качестве оных, используется имя самой страницы. Полнотекстовый поиск будет доступен в соответствуем месте в Qt Assistant после окончания генерации индекса. В «Содержании» добавится новый пункт «Unix man pages».

Вот так вот примерно это дело выглядит:

Сразу вопрос: подскажите инструмент для генерации ключевых слов для документа, интересует, на данный момент, только английский язык.

Бонусом нам это добавляет контекстную справку по всем функциям glibc и установленных библиотек (для которых есть man-page) в Qt Creator.

Сгенерированный мною файл справки можно взять тут: http://hatred.homelinux.net/~hatred/unixman.qch.gz

UPD:
буквально сегодня в списке рассылки Qt Creator проскользнула статья: Linux Man Pages integration with Qt Creator со схожим механизмом получения справочного файла. Отличие в том, что он брал готовые man-страницы в html с http://www.kernel.org/doc/man-pages/online_pages.html

UPD2:
Там же в рассылке всплыла ссылка на галерею документации для Qt Creator: https://developer.qt.nokia.com/wiki/Qt_Creator_Documentation_Gallery
В текущем состоянии не густо, но есть C++ Reference и убогенькая, сгенерированная doxygen документация по STL, а так же рекомендацию, как при помощи Doxygen генерировать документацию для Assistant.

Комментарии