QT Assistant, Не пойму, куда ткнуться. Ткните пожалуйста. Опции

[Shpiron]

Всем здравствуйте. Я в QT третий день, как бы это смешно не звучало.. Моя задача - научиться делать в ней доку. Есть набор html-файлов, хочу их отобразить с помощью QT Assistant'a...
Но как то сделать, не соображу совсем. Перечитала кучу материалов в нете. Прочитала пример про SimpleTextViewer. Но не поняла ничего
Не пойму, где что писать, где какие xml-ки формировать, куда что загонять для генерации.. как получить qch-файлы...
Подскажите что-нибудь.. Пожааалуйста...

[Litkevich Yuriy]

как получить qch-файлы

Это очень просто. Вот реальный пример файла проекта справки (qhp), для самого асиситента:

assistant.qhp

<?xml version="1.0" encoding="UTF-8"?>
<QtHelpProject version="1.0">
    <namespace>com.trolltech.assistant.460</namespace>
    <virtualFolder>qdoc</virtualFolder>
    <customFilter name="Qt Assistant Manual">
        <filterAttribute>qt</filterAttribute>
        <filterAttribute>tools</filterAttribute>
        <filterAttribute>assistant</filterAttribute>
    </customFilter>
    <filterSection>
        <filterAttribute>qt</filterAttribute>
        <filterAttribute>tools</filterAttribute>
        <filterAttribute>assistant</filterAttribute>
        <filterAttribute>4.6.0</filterAttribute>
        <toc>
            <section ref="assistant-manual.html" title="Qt Assistant Manual">
                <section ref="examples.html" title="Examples">
                    <section ref="help-simpletextviewer.html" title="Simple Text Viewer Example"/>
                </section>
                <section ref="assistant-manual.html" title="Manual">
                    <section ref="assistant-manual.html" title="Qt Assistant Manual"/>
                    <section ref="assistant-details.html" title="Qt Assistant in More Detail"/>
                    <section ref="assistant-custom-help-viewer.html" title="Using Qt Assistant as a Custom Help Viewer"/>
                </section>
            </section>
        </toc>
        <keywords>
            <keyword name="Qt Assistant" id="Qt Assistant" ref="assistant-manual.html#qt-assistant"/>
            <keyword name="Qt Assistant Manual" id="Qt Assistant Manual" ref="assistant-manual.html"/>
            <keyword name="Qt Assistant in More Detail" id="Qt Assistant in More Detail" ref="assistant-details.html"/>
            <keyword name="Simple Text Viewer Example" id="Simple Text Viewer Example" ref="help-simpletextviewer.html"/>
            <keyword name="Using Qt Assistant as a Custom Help Viewer" id="Using Qt Assistant as a Custom Help Viewer" ref="assistant-custom-help-viewer.html"/>
        </keywords>
        <files>
            <file>help-simpletextviewer-main-cpp.html</file>
            <file>help-simpletextviewer-textedit-h.html</file>
            <file>help-simpletextviewer-assistant-cpp.html</file>
            <file>images/assistant-docwindow.png</file>
            <file>help-simpletextviewer-mainwindow-cpp.html</file>
            <file>help-simpletextviewer-mainwindow-h.html</file>
            <file>assistant-custom-help-viewer.html</file>
            <file>images/assistant-assistant.png</file>
            <file>images/assistant-search.png</file>
            <file>images/assistant-address-toolbar.png</file>
            <file>help-simpletextviewer-assistant-h.html</file>
            <file>images/assistant-preferences-filters.png</file>
            <file>images/simpletextviewer-mainwindow.png</file>
            <file>images/assistant-preferences-options.png</file>
            <file>help-simpletextviewer-findfiledialog-cpp.html</file>
            <file>help-simpletextviewer.html</file>
            <file>help-simpletextviewer-findfiledialog-h.html</file>
            <file>images/assistant-preferences-fonts.png</file>
            <file>examples.html</file>
            <file>images/assistant-toolbar.png</file>
            <file>images/assistant-dockwidgets.png</file>
            <file>images/simpletextviewer-findfiledialog.png</file>
            <file>images/assistant-preferences-documentation.png</file>
            <file>images/assistant-filter-toolbar.png</file>
            <file>assistant-details.html</file>
            <file>help-simpletextviewer-simpletextviewer-pro.html</file>
            <file>assistant-manual.html</file>
            <file>help-simpletextviewer-textedit-cpp.html</file>
            <file>images/simpletextviewer-example.png</file>
            <file>images/assistant-toolbar.png</file>
            <file>images/simpletextviewer-findfiledialog.png</file>
            <file>images/trolltech-logo.png</file>
            <file>images/assistant-search.png</file>
            <file>images/assistant-preferences-documentation.png</file>
            <file>classic.css</file>
            <file>images/assistant-filter-toolbar.png</file>
            <file>images/simpletextviewer-example.png</file>
            <file>images/assistant-assistant.png</file>
            <file>images/qt-logo.png</file>
            <file>images/assistant-address-toolbar.png</file>
            <file>images/simpletextviewer-mainwindow.png</file>
            <file>images/assistant-dockwidgets.png</file>
            <file>images/assistant-preferences-filters.png</file>
            <file>images/assistant-docwindow.png</file>
            <file>images/assistant-preferences-fonts.png</file>
            <file>images/assistant-preferences-options.png</file>
        </files>
    </filterSection>
</QtHelpProject>

в каталоге где лежит этот файл лежат и файлы указанные в нём, картинки лежат в подкаталоге images
Чтобы получить сжатые файлы справки нужно просто скомандовать:

qhelpgenerator.exe assistant.qhp -o assistant.qch

Про содержимое qhp:
namespace - должно быть уникальным, это начало адреса, например, для файла assistant-manual.html, в адресной строке асиситента будет выглядеть так:


toc - оглавление, то что будет в нём отображаться

keywords - предметный указатель (или просто указатель), то что будет в нём отображаться

files - список файлов, которые должны быть помещены в сжатый файл справки

-----
customFilter - создаёт новый фильтр, который можно выбрать в панели фильтра асиситента:


filterSection - секция описывающая содержимое фильтра. Здесь речь идёт о неком уже существующем фильтре и выбирается он комбинацией атрибутов.
Например, в assistant.qhp создан фильтр с именем "Qt Assistant Manual", а в своём файле вы можете просто перечислить в секции filterSection, его атрибуты. При этом не создавая нового фильтра. Тогда при выборе фильтра "Qt Assistant Manual" будет доступна документация по Асистенту и ваша.

Под доступностью понимается: наличие соответствующих пунктов в Оглавлении, Указателе и при полнотекстовом поиске.