Help— и точка или .hlp Владимир Мазепа

Как вы оцениваете программу без справочной системы? Пользоваться, конечно, можно, но как бы без страховки, не так ли? Страховка эта так и называется — помощь, и наличие ее у созданной вами программы обязательно. Приняв это как непреложный факт, сразу перейдем к процессу создания справочной системы.

Вначале о том, что потребуется. Помощь создается в текстовом редакторе с поддержкой rtf, например, в MS Word. Для любителей альтернатив замечу, что редактор должен быть именно уровня Word — примитивы вроде WordPad не подойдут. Далее нужна программа, с помощью которой ваш rtf-файл при некоторых усилиях с вашей стороны превратится в готовенький hlp. Тут уж выбирать не приходится — Microsoft Help Workshop и никаких альтернатив. Его файлы hcw.exe или hcrtf.exe входят в состав большинства современных средств разработки программ, например Delphi, Visual Studio, и пр., так что вам будет легко их найти у себя простым поиском. 

Заметьте также, что сейчас есть программы, позволяющие создавать справки визуально, как говорится, WYSIWYG. Пользоваться ими или нет? Вопрос этот похож на известный вопрос о том, использовать ли FrontPage для создания веб-сайтов или не использовать. Так как в дискуссии о FrontPage все соглашаются, что HTML таки знать надо, то и в нашем вопросе решим, что полностью использовать возможности Windows Help можно, лишь зная все о создании справки в rtf. Да и захочется ли вам изучать эти программы, зная все это? Мне нет. 

Этап первый. Планирование и создание оглавления

Этот этап очень важен. Вы решаете, какой будет ваша справочная система, из каких разделов («книга»), подразделов («книга» ниже и правее) и статей она будет состоять. О чем писать — дело ваше, но лучше поместить в справку максимум информации: описание интерфейса, описание функций программы, системные требования, пошаговое руководство и т. п. Предугадайте вопросы пользователя — и ответьте на них. 

Именно на этом этапе можно будет создать файл оглавления вашей справки. Для этого запустите hcw (или hcrtf), выберите File > New > Help Contents, нажмите Add Below и введите название первой статьи в поле Title. В следующем поле задайте уникальный идентификатор статьи (Topic ID), который будет потом использоваться для переходов от одной статьи к другой в справочной системе (можно просто скопировать туда название статьи). 

Теперь, допустим, вы хотите добавить раздел («книгу»). Опять жмите Add Below, установите выделение вместо Topic на Heading и введите название раздела в поле Title. 

Если нужно добавить подраздел, проделайте то же самое, выделите в окне программы название подраздела и нажмите Move Right (захотите вернуть назад — Move Left). 

В полях Default Filename и Default Title нужно задать имя будущего файла справки и заголовок окна с содержанием. 

Этап второй. Написание статей справочной системы

Как вы уже знаете, на этом этапе поможет Word и ваш литературный талант. Напишите все статьи, оформив заглавия одним из стилей «Заголовок». Между статьями ставьте разрыв страницы (Вставка > Разрыв > Новую страницу). 

В дальнейшем вы сделаете переходы от одной статьи к другой прямо в тексте (подчеркнутый зеленый текст), а также объяснения терминов (зеленый текст, подчеркнутый пунктиром, при нажатии высвечивается комментарий), так что учтите эти возможности при написании статей. А вот как они реализуются, вы узнаете из следующего раздела. Впрочем, уже сейчас можно написать комментарии: отделите их от статей и друг от друга разрывами страницы и не устанавливайте заголовки. 

Вы можете вставлять рисунки bmp или wmf, как напрямую прямо в текст средствами Word, так и с помощью инструкций {bmc имя_файла}, {bml имя_файла}, {bmr имя_файла}. Первая просто вставит рисунок в текст, вторая отформатирует его по левому краю окна, третья — по правого краю. Если рисунок используется несколько раз, вставляйте его только с помощью этих команд, иначе рисунок будет несколько раз скомпилирован в готовый hlp, что увеличит его размер. 

Оформляйте текст как вам нравится — меняйте шрифты, переопределяйте стандартные стили и добавляйте новые, изменяйте отступы и интервалы. Однако использовать нужно широко распространенные шрифты: Arial, Verdana, MS Sans Serif, Times New Roman, Courier New — тогда есть гарантия, что на компьютере пользователя справка отобразится правильно. Если потребуется вставить таблицу, уберите ее рамку — Windows Help не поддерживает рамки таблиц, а Help Workshop, обнаружив рамку, разразится warning'ом. Не забудьте сохранить готовый документ в формате rtf. 

Этап третий. Разметка статей и расстановка переходов

Этот этап богат рутинными операциями. Если ваша справочная система получилась довольно большой, то вам доставит немало хлопот одна только разметка статей по идентификаторам (тем самым Topic ID, которые вы вводили при создании оглавления). Без разметки никак нельзя, так что читайте повнимательней о том, как она делается. 

Сначала устанавливаете курсор на начало заголовка статьи. Из меню Вставка выбираете Сноска, во фрейме Нумерация отмечаете Другая, затем вводите символ #. После нажатия на ОК курсор попадает в текстовое поле сноски, чем и воспользуйтесь — введите идентификатор статьи. То же самое проведите для всех заголовков. Как говорится, процедуру повторить, процедуру повторить, процедуру повторить... 

Размечайте пояснения терминов таким же образом — установив курсор в начало текста, вставьте ту же сноску и в качестве текста сноски придумайте идентификатор. 

Но это еще не вся рутина, хотя разметку вы уже провели. Теперь нужно распределить по тексту задуманные переходы и пояснения терминов. Процедура эта тоже довольно хлопотная, в ней опять понадобятся идентификаторы статей. 

Допустим, вы хотите, чтобы в одной из статей при нажатии на текст «системные требования» можно было перейти к одноименной статье. Дописываете к этому тексту идентификатор статьи (без пробела, например, «системные требованиясистемные_требования»). Текст «системные требования» оформляете двойным подчеркиванием (выделяете, вызываете Формат > Правка и выбираете двойную линию), текст системные_требования (т. е. идентификатор статьи) делаете скрытым (выделяете, в Формат > Правка ставите галочку Скрытый) и подчеркнутым пунктиром. Вот и все. Ваша мышь хорошо поработала. 

Сделать ссылку на комментарий к термину можно с помощью такой же процедуры — только подчеркивание текста будет не двойное, а пунктирное.