Разработка технической документации и технические писатели Технические писатели и разработка технической документации технические писатели в Телеграм 

 obmen_soobsheniyami.png Чат для технических писателей 
 Зарегистрируйтесь
Страницы: 1
Ответить
RSS
Общий вопрос по программам для разработки документации
 
Коллеги, у меня появился вопрос для тех, кто пользуется программами для разработки документации, в частности - встроенной справки.
А каким образом в таком редакторе страница справки может быть привязана к форме в программе?
Нужно, чтобы написанная страница открывалась по нажатии F1 или кнопки "Справка".

Предоставляют ли существующие программы такую возможность?
Как это обычно реализуется?  
 
Цитата
Elanor написал:
Коллеги, у меня появился вопрос для тех, кто пользуется программами для разработки документации, в частности - встроенной справки.
А каким образом в таком редакторе страница справки может быть привязана к форме в программе?
Нужно, чтобы написанная страница открывалась по нажатии F1 или кнопки "Справка".

Предоставляют ли существующие программы такую возможность?
Как это обычно реализуется?

Да, все ведущие программы для создания документации поддерживают такую возможность. Общая идеология такая, что топику или конкретному месту в нем присваивается некий TopicID (обычно число), и программа обращается к справке используя этот Topic ID, используя вызов по URL, через JavaScript или с помощью специального API для обращения к справке. Формат справки который может вызываться из программы - WebHekp, HTML5 Help, Mobile Help, Dotnet Help и др. Обычно поддерживается возможность создания hesder-файлов, содержащих сопоставления названия топиков и их номеров.

Madcap Flare:
http://webhelp.madcapsoftware.com/flare11/Content/CSH/About_Context_Sensitive_Help.htm

Robohelp:
http://help.adobe.com/en_US/robohelp/robohtml/WS5b3ccc516d4fbf351e63e3d11aff59­c571-8000.html

H&M
http://www.helpandmanual.com/help/hm_ref_contextpop_implement.htm
 
Виктор, огромное спасибо за ответ и ссылки
 
Добрый день,

В дополнение к посту Виктора.
Здесь вы сможете найти ссылки на примеры интеграции файла справки в формате CHM с приложениями, написанными на различных языках программирования:
http://techwriters.ru/forum/forum635/topic19975/

В качестве редактора файла справки в примерах используется программа Dr.Explain, но это не влияет на то, как справка интегрируется с приложением. Поэтому именно примеры интеграции и приведенные фрагменты кода можно считать универсальными.
 
Денис, благодарю за ответ. Нужный раздел в инструкции нашла без проблем.
 
Цитата
''Dr.Explain'' написал:
Добрый день,

примеры интеграции и приведенные фрагменты кода можно считать универсальными.

Примеры и фрагменты очень ясные и подробные.
 
Но использование формата встроенной справки CHM я бы крайне не рекомендовал.

От формата CHM его разработчик (Microsoft) отказался еще в 2002 году, этот формат имеет массу проблем и ограничений.
Страницы: 1
Ответить
Читают тему
Форма ответов
 
Текст сообщения*
Загрузить файл или картинкуПеретащить с помощью Drag'n'drop
Перетащите файлы
Ничего не найдено
Загрузить файлы
Отправить Отменить