- •Этап первый. Планирование и создание оглавления
- •Этап второй. Написание статей справочной системы
- •Этап третий. Разметка статей и расстановка переходов
- •Этап четвертый. Создание файла проекта
- •Предметный указатель
- •Переход по ключевым словам
- •Последовательность просмотра
- •Дополнительные окна
- •Некоторые возможности
- •Тестирование и отладка
- •Что поставлять
- •Заключение
- •Программы, документы, гиперссылки
Программы, документы, гиперссылки
Иногда в справочной системе нелишними бывают кнопки или ссылки, при нажатии на которые запускается программа или открывается документ.
Вводите текст ссылки (вроде «Запуск Notepad») и сразу после него записываете !EF(notepad.exe). Текст ссылки оформляете двойным подчеркиванием, остальное — скрытый текст с подчеркиванием пунктиром.
Вот как делается кнопка:
{button Запустить notepad, EF(notepad.exe)}
Таким же способом можно открыть документ в его родной программе. Вот пример кнопки:
{button Открыть readme.doc, EF(readme.doc)}
Так как адреса сайтов или e-mail — тоже как бы документы, то открыть их можно аналогично:
{button Переход на yahoo.com,
EF(http://www.yahoo.com)}
Не забывайте указывать http://, в e-mail не забывайте mailto:
Некоторые возможности
Вы можете установить свой текст, который будет отображаться при выборе пункта Версия меню Помощь главного окна вашей справки. Для этого в Help Workshop нажмите Options, на вкладке General появившегося окна заполните нужным текстом поле Display this text in the Version dialog box.
Кроме того, на той же вкладке можно установить текст, который будет выдаваться пользователю, если он захочет скопировать или распечатать статью или ее часть. Этот текст будет помещен после фрагмента справки и может служить напоминанием пользователю об источнике информации или авторских правах. Если вы захотите сделать такой текст, заполните поле If users paste or print Help text, display.
Тестирование и отладка
Отладка... Это страшное слово прокралось и сюда. Хотя отладка здесь не так уж болезненна — нужно просто исправить все ошибки, выданные Help Workshop и состоящие в основном из ваших опечаток. Исправив, переходите к тестированию — просмотрите, туда ли выполняются переходы, те ли пояснения высвечиваются, правильный ли порядок просмотра. Придется просмотреть все статьи, вызывая их из оглавления, а также все ключевые слова из Предметного указателя.
Что поставлять
У вас уже накопилось несколько файлов, относящихся к справочной системе. Какие из них будут результатом вашей работы, так необходимым пользователю?
Пользователю нужен сам файл hlp и файл оглавления cnt, больше ничего. Иногда программисты вместе со справкой поставляют временный файл gid, чем немало удивляют опытных пользователей. Не вздумайте также со справкой поставлять базы поиска fts — когда пользователю понадобится поиск, он и сам их сделает.
Заключение
Теперь вы знаете, как создать справочную систему. Некоторые возможности, конечно, остались неописанными, но если захотите их использовать — всегда к вашим услугам справочная система по Help Workshop, которая, кстати, представляет собой пример хорошо сделанной, продуманной справки. Надеюсь, и ваша система помощи станет надежной страховкой пользователям в использовании вашей программы.
