Даю справку…

Дабы облегчить жизнь пользователей, разработчики программ пишут документацию. Если программа небольшая, то всю информацию можно разместить в маленьком текстовом файле, для написания которого подойдет даже Блокнот. Ну а если же необходимо сделать более серьезную справочную систему, то лучше воспользоваться специальной программой. Об одной из таких программ, именуемой Help&Manual, я расскажу в этой статье.

Знакомство
Программа Help&Manual (13 Мбайт, shareware, www.helpandmanual.com), появившаяся на свет в далеком 1997 году, в наше время считается одним из лучших продуктов для создания справочных систем и руководств. И это вполне объяснимо, ведь ее возможности гораздо шире, чем у большинства аналогов.
Во-первых, H&M умеет создавать файлы справок двух основных форматов — hlp и chm. Во-вторых, она умеет делать документацию в форматах PDF, RTF и HTML. Также она может декомпилировать существующие файлы справки, что делает ее незаменимым инструментом при русификации программ. Кроме того, возможно создание “Электронных книг” в виде единого .exe-файла. А если добавить к этому удобный интерфейс и неплохие возможности по оформлению текста1…
Ну а теперь давайте поближе познакомимся с основными возможностями H&M.

Внешний вид
В целом интерфейс H&M типичен для офисного приложения. В верхней части расположены меню и панель инструментов. Чуть ниже — основное рабочее поле, поделенное на две части. Левая часть содержит “дерево” страниц, имеющихся в редакти­руемом руководстве, а правая — либо поле редактора, либо свойства текущей страницы (для переключения между видами используются вкладки сверху). Обратите внимание, что все страницы поделены на две группы: страницы из первой (которая сверху) видны прямо из оглавления, а вторая содержит страницы-“невидимки”, которые можно открыть только по ссылкам2.

Кроме основного окна нас будет интересовать окно опций проекта. В нем можно выбрать такие параметры, как цвет окна “по умолчанию”, внешний вид окон справочной системы, функции, которые будут доступны читателям, а также некоторые другие.

Первые шаги
Создать новый проект можно несколькими способами: во-первых, вы можете создать пустой проект и установить все его свойства самостоятельно. Во-вторых, вы можете создать пустой проект, используя в качестве шаблона один из существующих (в этом случае вам не придется вручную задавать его параметры). Ну и, наконец, третий способ — декомпиляция существующего файла справки3. Правда, при декомпиляции форматирование текста сильно страдает4.
Когда проект создан, можно приступать к его редактированию. Как вы знаете, у большинства справочных систем есть содержание, оформленное, как правило, в виде “дерева”. Для примера я возьму именно такой вариант построения, хотя никто не мешает вам сделать справку и без “дерева” (так, например, построена справка Total Commander).
Для добавления и удаления “книг” и “страниц” можно использовать либо кнопки “+” и “-”, либо пункты контекстного меню. Когда страница создана, вы можете приступать к ее редактированию и правке свойств. На редактировании я останавливаться не буду — оно мало чем отличается от работы с Word’ом (или, учитывая возможности, с WordPad’ом), а вот о свойствах пару слов скажу. “Имя”: именно его нужно будет использовать, если вы захотите дать ссылку на эту страницу в каком-нибудь другом месте. “Ключевые слова” будут использоваться для поиска по разделам. Используя опцию “Тип сборки” вы можете включать в разные типы сборок разный набор страниц (например, в .hlp-файл включить все страницы, а из печатного руководства исключить “заметки” на скрытых страницах).

Сборка
После того, как руководство готово, можно приступать к сборке5. Для начала нажмите кнопку “Создать файл справки” или выберите соответствующий пункт меню “Файл”. При этом будет показано окно, в котором вам нужно будет выбрать тип создаваемого файла и место его сохранения. Определившись с выбором6нажмите кнопку “OK”. По завершении процесса сборки7будет показано окно с информацией о полученном файле справки. В этом же окне появятся сообщения об ошибках, если таковые имеются. Если процесс прошел нормально, полученный файл справки будет тут же открыт (эту опцию можно отключить).

Заключение
Help&Manual — это незаменимый инструмент для программистов, а также для тех, кто занимается русификацией документации. Работать с программой не сложнее, чем с обычным офисным приложением, а количество форматов, в которых можно сохранить результаты позволяет использовать ее практически в любых условиях.


Рекомендуем почитать: