Как подключить встроенную справочную систему Flare в веб-приложение?
Я загрузил некоторые файлы онлайн-справки MadCap Flare в мой SVN-репозиторий. Какой код использует веб-разработчик для добавления этих страниц справки в онлайн-справку веб-приложения?
2 ответа
На своем веб-сайте MadCap Software предоставляет контекстно-зависимую справочную систему Flare. Он должен показать вам, что должен делать технический писатель и что должен сделать разработчик, чтобы связать справочную систему с приложением, в зависимости от того, какой тип справочной информации вы создаете. Вы можете найти его здесь: http://docs.madcapsoftware.com/flare2018/FlareCSHGuide.pdf.
Справедливое предупреждение, пока у меня нет опыта работы с информацией, представленной в руководстве, так как наша справочная система CHM уже работала, когда я начал работать над нашим проектом Flare, поэтому я никогда не связывал проект Flare с приложением, только что обновил существующий проект (поэтому "должен показать вам").
Если у вас есть дополнительные вопросы о Flare, форум поддержки peer-to-peer ( https://forums.madcapsoftware.com/) обычно является действительно хорошим ресурсом. Там есть пара очень активных пользователей, которые действительно знают все тонкости Flare. Возможно, стоило бы обратиться туда за конкретной информацией о Flare, так как Flare - нишевый инструмент, который, возможно, известен здесь лишь немногим по stackru, но это хлеб с маслом для парней и девушек на форумах MadCap.
Я использую Electron, чтобы обернуть собственное окно браузера вокруг вывода Flare... работает просто великолепно! Я также создал компонент React, который помещает в него выходные данные Flare. Следовательно, любое приложение React может использовать созданный мной «компонент справки».
Если вы хотите увидеть пример, дайте мне знать.