wysiwyg пользовательская помощь, авторский инструмент для работы с qthelp?
Нам нужно скомпилировать в QtHelp (.qch и.qhc). Мне интересно, какой инструмент / набор инструментов будет проще всего для этого? Мы бы хотели, чтобы в качестве отправной точки использовался инструмент разработки справки WYSIWYG, а затем пропустили вывод из него через все, что нам нужно для получения QtHelp.
Мы использовали Help & Manual в прошлом, и именно такой интерфейс WYSIWYG мы ищем в инструменте создания справки. Но нам нужен набор инструментов для создания простых HTML-страниц (по одной на раздел справки), которые мы можем использовать с qhelpgenerator или же qcollectiongenerator, а также создайте.qhp (по крайней мере, оглавление и разделы ключевых слов) и.qhcp для генерации.qch и.qhc. Я не вижу, как Help & Manual может вписаться в это.
Мы кратко рассмотрели Sphynx, но, похоже, у него крайне ограниченные возможности для форматирования текста. Например, не похоже, что есть какой-либо способ изменить шрифт, размер шрифта, цвет шрифта и т. Д. Для части текста. Кажется, что на самом деле невозможно иметь текст, выделенный жирным шрифтом и курсивом. Отлично смотрится для документации для разработчиков, но, похоже, не хватает базовых вещей для создания файла справки пользователя. Пожалуйста, поправьте меня, если я как-то пропустил основные функции форматирования текста!
Итак, какой инструмент разработки справки WYSIWYG вы порекомендуете, и каков путь от этого инструмента до.qch и.qhc?
3 ответа
Похоже, справка и руководство будет работать в конце концов! Вот последовательность, которую мы смотрим сейчас. Пожалуйста, прокомментируйте, если вы видите какие-либо проблемы или улучшения, которые могут быть сделаны.
В справке и руководстве (протестировано с версией 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.
Опять же, если у кого-то есть лучшее решение или улучшения к этому, пожалуйста, напишите!
Используйте Helpinator 3 Professional, он генерирует chm qt javahelp word pdf файлы легко..
Вы могли бы рассмотреть инструмент разработки справки HelpNDoc, который имеет редактор WYSIWYG и может генерировать файлы справки Qt из коробки. Созданные исходные файлы при желании можно сохранить для ручного редактирования и ручной компиляции.