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

Question

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

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

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

• Позвольте нам управлять всем содержанием справки (текст, таблица содержания, изображения и т.д.) в одном месте.
• Вывод на родные форматы справки. (CHM для Windows - или, по крайней мере, что-то, что мы могли бы подавать непосредственно в API справки HTML, не знаете, какие форматы поддержки для других платформ есть.)
• Достойная поддержка WYSIWYG: обработка общей записи текста, ссылки и т. д., но мы можем редактировать HTML, когда нам нужно.
• Текстовый формат файла справки (XML и т. Д.), Чтобы он мог быть версией в Subversion.
• Любые крючки, которые помогут сохранить синхронизацию с реальной базой кода, были бы замечательными. (Возможно, каким-то образом тема справки связана с файлом кода и может проверять Subversion, чтобы увидеть, были ли внесены какие-либо изменения, и пометить тему как «возможно устаревшую» ... я вижу сны?)
• Содержание справки может быть локализованным.
• Не против коммерческого продукта, но бесплатный вариант будет приятным.

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

Answer 1

Я только что обнаружил Sphinx; Я думаю, я влюбился.

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

Answer 2

Robohelp

Answer 3

Help & Manual

Answer 4

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

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

Этот архив имеет кучу CHMs таким образом (в частности, прог, реф и пользовательские части, остальное (РТЛ, FCL, LCL) порождаются нашим собственным 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/~marcov/buildfaq/

Answer 5

Я использовал RoboHelp в течение многих лет.

Это прекрасно, но основная технология очень старая. Также способ блокировки версий Word - это общий PITA (и заставил меня избегать обновлений MS Office несколько раз).

Мы переходим к сумасбродной вспыхивают http://www.madcapsoftware.com/products/flare/robohelp.aspx

Answer 6

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

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

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

Относительно хороший introduction to Docbook можно найти here.

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

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