Похоже, что Справка и Руководство будут работать в конце концов! Вот последовательность, которую мы смотрим сейчас. Пожалуйста, прокомментируйте, если вы видите какие-либо проблемы или улучшения, которые могут быть сделаны.
В справке и руководстве (протестировано с версией 5.5.1 Build 1296 профессиональная лицензия), в Project Explorer, в разделе Конфигурация:
Перейти HTML шаблоны страниц \ по умолчанию. На вкладке Исходный код HTML закомментируйте раздел.
Перейдите в Параметры публикации \ Веб-справка.
В Layout выберите Без фреймов, без сценариев.
В Navigation нам ничего не нужно проверять - хотя, если есть способ контролировать формат значения KEYWORD_INDEX, чтобы мы могли копировать и вставлять непосредственно в наш .qhp, это было бы здорово! Я не нашел способа сделать это, поэтому мы планируем поддерживать ключевые слова непосредственно в .qhp.
Точно так же оглавление также не имеет значения, если мы не сможем контролировать формат, который нам придется поддерживать, чтобы ток был непосредственно в .qhp.
В Popup Topics мы настроены на темы в кодировке HTML. Не уверен, если это необходимо.
Это все настройки, которые мы должны изменить. Создайте справочный контент в H & M как обычно, затем опубликуйте Webhelp. Это создает отдельный файл .htm для каждой темы.
В той же папке, что и файлы .htm, мы создаем наши файлы .qhp и .qhcp и запускаем qcollectiongenerator для создания нашего .qhc, который мы затем отображаем с помощью Qt Assistant. См. http://doc.qt.nokia.com/4.7/qthelp-framework.html для помощи со стороной Qt этого набора инструментов.
Опять же, было бы здорово, если бы мы могли найти способ настроить H & M для создания токена и ключевых слов в формате, необходимом для .qhp, и мы могли бы просто вставить их в .qhp (или в этом отношении, поддерживать .qhp в этом шаблоне также). Другой вариант - написать скрипт для преобразования того, что H & M создает для toc и ключевых слов, в то, что требует .qhp. Если вы делаете это и не против поделиться, пожалуйста, напишите код!
Некоторые преимущества использования H & M для решения этой проблемы:
- несколько документов могут работать одновременно, и источник хранится в виде текстовых файлов в Subversion, поэтому он является версионным, и вы можете сравнивать изменения.
- легкое WYSIWYG создание разделов справки
- может обрабатывать все виды форматирования текста и ссылок. Например, в сквозном тесте функций, чтобы увидеть, какие функции H & M будут работать в нашем конечном продукте (просмотр qqc в Qt Assistant), я был удивлен, увидев, что Qt Assistant даже обрабатывает горячие точки в изображении, связывающем с другими Тем / анкеры.
- .qhc интегрирован в Qt, поэтому вы можете контролировать свою помощь из приложения Qt.
Опять же, если у кого-то есть лучшее решение или улучшения к этому, пожалуйста, напишите!