А как и в каком формате делается документация к плагину (то есть, чтобы как обычно по F1 была возможность вызвать справку для класса)делается ? Где об этом почитать можно ?

о, кое на что наткнулся, буду изучать )
http://www.forum.crossplatform.ru/index.ph...ic=5119&hl=

Почитай так же The Qt Help Framework

хорошо

очепятка
"Однако, наличие фалов коллекции "


недопереведено




вот мой вариант перевода

Проект справки Qt (Qt Help Project)
.qhp
Исходный файл генератора справки, состоящий из таблицы оглавления, индексов и ссылок на реальные файлы документации (*.html); также этот файл определяет уникальное пространство имён для документации, на которую он ссылается.

Сжатая справка Qt (Qt Compressed Help)
.qch
[Выходной файл генератора справки]. Это двоичный файл, содержащий всю информацию, расположенную в файле проекта-справки, вместе со сжатыми файлами документации.

Проект коллекции справки Qt (Qt Help Collection Project)
.qhcp
Исходный файл для генератора коллекции справки. Содержит ссылки на сжатые файлы справки, которые нужно включить в коллекцию; также может содержать информацию о пользовательских настройках (customizing) программы Qt Assistant.

Коллекция справки Qt (Qt Help Collection)
.qhc
[Выходной файл генератора коллекции.] Это файл, с которым взаимодействует класс QHelpEngine. Содержит ссылки на любое количество сжатых файлов справки и дополнительную информацию, например пользовательские фильтры.

Алексей1153, дай, на всякий случай, ссылку на этот пост в подфоруме "переводы"

ну, в общих чертах то понятно.

Осталось узнать , как делать html-документы )

А где пример можно глянуть ?

Я нашёл в папке креатора файлы QCH (бишь сжатая справка), а чем она сжатая - как расжать ?

а они ещё не существуют. Мне их надо написать. Нужен пример ))

поясню - понятия не имею, какие элементы HTML должны присутствовать, никогда не сталкивался с ним

Загляни на этот ресурс http://htmlbook.ru/
Там и справочник тегов есть, и самоучитель неплохой

ага, то, что надо )

приятный такой дизайн сайта, кстати

Сама документация компилируется при помощи doxygen. Посмотрите исходники Qt, документация в них встроена. Вот например — http://qt.gitorious.org/qt/qt/blobs/4.7/sr...rnel/qtimer.cpp.
Я в своих проектах тоже пишу doxygen-совместимые комментарии. Это вообще хорошая практика.

Obey-Kun, а возможно сделать установщик для плагина, который вместе с копированием файлов плагина установит и файлы справки ?

Установщик? По-моему, это только в винде есть такое понятие .

Obey-Kun, установщик - это программа, которая копирует файлы дистрибутива и вносит настройки в систему для правильной работы пакета. При чём тут винда ?

А под виндой мне тоже нужно мделать, кстати

Собственно, уже создал коллекцию из 3 файлов справки, встроил вручную в ассистент (через настройки-документы). И вопрос - а как автоматически это сделать ? Именно саму встройку

а, собственно, чтобы из самого креатора справка по классу (F1) умела отображаться - это что надо сделать ?

Под линуксом, например, понятия установщика нету. Если я хочу что-то поставить, просто пишу что-то типа aptitude install firefox и оно это скачивает их интернета и ставит. Незачем делать установщик, юзеры не криворучки и сами подключат плагин и хелп.

просто ты его не видишь, он есть, конечно же. Ты его скачиваешь либо скачивающая программа сама знает, куда скачиваемое рассовать. В винде же принято делать дистрибутив. Но если хочется всё как в каменном веке - вручную - то никто не запрещает же

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

Obey-Kun, а по этому вопросу что линукс говорит ?

Просто надо добавить документацию в настройках qt creator.

Obey-Kun, ага, вижу спасибо. Но только есть одно "но" - в ассистенте всё по аналогии "заработало" сразу, а в креаторе поиск не находит классы

или ещё что-то нужно сделать ? Индексы какие-то перестроить ?