Кроссплатформенные инструменты авторизации конечного пользователя
https://stackoverflow.com/questions/2977398
-
24-10-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianВопрос
Каковы хорошие инструменты для создания кроссплатформенных файлов справки для конечных пользователей? (Наше приложение использует структуру QT, если это имеет какое -либо значение.)
Примечание: меня не интересует внутренняя документация по API-мы используем Доксиген для этого.
В идеале решение будет:
- Позвольте нам управлять всем контентом справки (текст, содержимое, изображения и т. Д.) В одном месте.
- Вывод в собственные форматы помощи. (CHM для Windows-или, по крайней мере, что-то, что мы могли бы подавать непосредственно в HTML Help API; не уверен, какие форматы справки других платформ являются.)
- Приличная поддержка wysiwyg: обрабатывать общий текстовый вход, изображения, перекрестные ссылки и т. Д. Легко, но мы можем редактировать HTML, когда нам нужно.
- Текстовый файл-формат для помощи Проект (XML и т. Д.), Чтобы его можно было версировать в подрывной деятельности.
- Любые крючки, которые помогают сохранить его синхронизировать с фактической кодовой базой, были бы великолепны. (Возможно, каким -то образом тема справки связана с файлом кода и может проверить подрывную деятельность, чтобы увидеть, были ли внесены какие -либо изменения, и помечать тему как «возможно устаревшей» ... я мечтаю?)
- Помощь контента может быть локализовано.
- Не против коммерческого продукта, но бесплатный вариант был бы хорош.
Я пойду вперед и сделаю это вики и начну с нескольких примеров. Проголосуйте за них вверх или вниз, если у вас есть опыт с ними, и оставьте несколько комментариев. Добавьте и дополнительные инструменты.
Решение
Я только что обнаружил Сфинкс; Я думаю, я влюбился.
- Лучше, чем wysiwyg над HTML: реструктурированный текст
- Выходы в QTHELP (среди прочего), поэтому будут легко распространять (и интегрировать) в нашем приложении.
- Пока не уверен насчет локализации, но мы пересекаем этот мост, когда нам нужно.
- Было легко настроить и «просто работает»; выглядит профессионально.
Другие советы
Я использовал Robohelp в течение многих лет.
Это нормально, но основная технология сейчас очень старая. Также то, как они блокируют версии Word, является полным PITA (и заставило меня избежать обновлений MS Office несколько раз).
Мы переезжаем в Madcap Flare http://www.madcapsoftware.com/products/flare/robohelp.aspx
Я думаю Докбук Решает все ваши требования, кроме, возможно, крючками синхронизации, на которые я думаю немного дальше. По сути, это подмножество XML, предназначенное для создания документации, и является бесплатным и открытым исходным кодом. Это просто формат плюс набор выходных преобразований XSL, которые преобразуют документ в более полезные форматы (HTML и, следовательно, CHM, JavaHelp, PDF через XML-FO или TEX).
Это означает, что вам все еще нужно выбрать инструмент авторизации XML, чтобы фактически редактировать его, чтобы такие вещи, как Wysiwyg, будут зависеть от функций вашего программного обеспечения для авторизации XML. Мы используем Syntext Serna, поскольку она имеет хорошую поддержку Wysiwyg и встроенное редактирование XML #includes (никто другой, кажется, не поддерживает последнее). Вы можете найти другие инструменты для авторизации XML, лучше соответствовать вашим потребностям - Серна - это достаточно дорогое коммерческое предложение.
Docbook обеспечивает большую гибкость посредством профилирования, что позволяет включать/исключать XML -элементы на основе их атрибутов. Примером использования вариантов будет иметь немного другой вывод справки для OS = Windows, чем OS = Linux. Локализация также поддерживается через профилирование и другие механизмы.
Довольно хорошо Введение в Docbook можно найти здесь.
Мы используем Docbook для нашего формата справки и составляем его в файлы CHM, которые содержат помощь только для функций, относящихся к конкретному продукту (т.е. Enterprise Edition имеют функции, которые не в стандартных или демонстрационных версиях). Соответствующие шаги:
- Запустите шаблоны профилирования XSL на источнике XML (EG XSLTPROC).
- Запустите шаблоны XSL HTML-HELP на выходе 1.
- Скомпилируйте выходные файлы HTML с использованием компилятора HTML Microsoft HTML (HHC).
Единственный, который я знаю, - это латекс, один из преобразователей LateX2HTML, а затем несколько адаптаций, чтобы подготовить полученный HTML для архивера CHM.
- Текст, HTML, CHM, PDF, PS Нет проблем.
- Преобразование в Word через RTF была катастрофой, не знаю текущего состояния.
- Latex 2 HTML -преобразователи, в то время как несколько, у всех есть свои проблемы.
- PDF -файлы выглядят абсолютно великолепно.
- Wysiwym (через Lyx) возможно.
Этот архив имеет кучу CHMS таким образом (в частности, Prog, REF и пользовательских частей, остальные (RTL, FCL, LCL) генерируются нашим собственным эквивалентом Doxygen, FPDOC)
http://www.stack.nl/~marcov/doc-chm.zip
Обратите внимание, что приведенные выше CHM изготовлены с нашим собственным (портативным) компилятором CHM. Да, больше нет мастерской.
Документ Lyx как PDF и HTML:
