Кросс-платформенные средства разработки для конечных пользователей

Каковы некоторые хорошие инструменты разработки для создания кросс-платформенных файлов справки для конечных пользователей? (Наше приложение использует фреймворк Qt, если это имеет какое-либо значение.)

Примечание: меня не интересует внутренняя документация API-для этого мы используем doxygen.

В идеале решение будет:

  • позволяет нам управлять всем содержимым справки (текст, оглавление, изображения и т. д.) в одном месте.
  • вывод в собственные форматы справки. (МП по Windows-или, по крайней мере, что-то, что мы могли бы передать непосредственно в API справки HTML; не уверен, что "стандартные" форматы справки других платформ являются.)
  • достойная поддержка WYSIWYG: обработка общего ввода текста, изображений, перекрестных ссылок и т. д. легко, но мы можем редактировать HTML, когда нам нужно.
  • текстовый файловый формат для проекта справки (XML и др.) так что он может быть версирован в Subversion.
  • любые крючки, которые помогают синхронизировать его с фактической базой кода, были бы великолепны. (Возможно, каким-то образом раздел справки связан с файлом кода и может проверять Subversion, чтобы увидеть, были ли внесены какие-либо изменения, и помечать тему как "возможно устаревшую" ... может, я сплю?)
  • содержимое справки можно локализовать.
  • не против коммерческого продукта, но бесплатный вариант был бы хорош.

Я пойду дальше и сделаю это Вики и начну с нескольких примеров. Голосуйте за них вверх или вниз, если у вас есть опыт работы с ними, и оставьте некоторые комментарии. Добавьте дополнительные инструменты как хорошо.

6 8
cross-platform qt chm

6 ответов:

Я только что открыл Сфинкса; я думаю, что я влюблен.

  • лучше, чем WYSIWYG над HTML: reStructuredText
  • выходы на QtHelp (среди прочего), поэтому будет легко распространять (и интегрировать) в нашем приложении.
  • пока не уверен насчет локализации, но мы пересечем этот мост, когда нам это понадобится.
  • было легко настроить и "просто работает"; выглядит профессионально.
4

Я использую robohelp в течение многих лет.

Это прекрасно, но основная технология сейчас очень старая. Кроме того, то, как они привязываются к версиям Word, - это полная Пита (и заставило меня несколько раз избегать обновлений MS office).

Мы движемся к безумной вспышке http://www.madcapsoftware.com/products/flare/robohelp.aspx

2

Я думаю, чтоDocBook удовлетворяет всем вашим требованиям, за исключением, возможно, крючков синхронизации, о которых я подумаю немного дальше. Это, по сути, подмножество XML, предназначенное для создания документации, и является свободным и открытым исходным кодом. Это просто формат плюс набор выходных преобразований XSL, которые преобразуют Docbook в более полезные форматы (HTML и, таким образом, CHM, JavaHelp, PDF через XML-FO или Tex).

Это означает, что вам все еще нужно выбрать средство разработки XML, чтобы фактически отредактировать его таким образом. такие вещи, как WYSIWYG, будут зависеть от особенностей вашего программного обеспечения для разработки XML. Мы используем Syntext Serna, так как он имеет хорошую поддержку WYSIWYG и встроенное редактирование XML #includes (кажется, никто больше не поддерживает последнее). Вы можете найти другие инструменты разработки XML, которые лучше подходят для ваших нужд-Serna является достаточно дорогим коммерческим предложением.

Docbook обеспечивает большую гибкость с помощью профилирования, которое позволяет включать/исключать xml-элементы на основе их атрибутов. Примеры использования будут такими: иметь несколько иной вывод справки для OS=Windows, чем для OS=Linux. Локализация также поддерживается с помощью профилирования и других механизмов.

Довольно хорошее введение в Docbook можно найти здесь.

Мы используем Docbook для нашего формата справки и компилируем его в файлы CHM, которые содержат справку только для функций, относящихся к конкретному продукту (т. е. Enterprise edition имеет функции, отсутствующие в стандартной или демо-версии). Соответствующие шаги являются:

  1. запустите профилирующие шаблоны XSL на XML-источнике (например, с помощью XSLTproc).
  2. запустите HTML-Help xsl шаблоны на выходе 1.
  3. скомпилируйте выходные HTML-файлы с помощью компилятора справки HTML (HHC) от Microsoft.
2

Справка И Руководство

1

Robohelp

0

Единственное, что я знаю, - это Latex, один из конвертеров latex2html, а затем несколько адаптаций, чтобы сделать полученный html готовым для архиватора CHM.

  • текст, html, chm, pdf, ps нет проблем.
  • преобразование в Word через RTF раньше было катастрофой, не знаю текущего состояния.
  • latex 2 html конвертеры, в то время как несколько, все имеют свои собственные проблемы.
    • PDF-файлы выглядят просто великолепно.
  • WYSIWYM (через lyx) возможно.

В этом архиве есть куча ЧМС этак (в частности, прог,арт и части пользователей, остальные (РТЛ,перевозки FCL,сборных) создаются в нашей собственной помощи Doxygen эквивалент, fpdoc)

Http://www.stack.nl/~marcov/doc-chm.zip

Обратите внимание, что вышеупомянутые CHM сделаны с нашим собственным (портативным) компилятором CHM. Да, больше никакой мастерской.

Документ Lyx в формате PDF и html:

Pdf: http://www.stack.nl/~marcov / buildfaq. pdf

Html: http://www.stack.nl/~Марков / buildfaq /

0