«Документальный» плюс

Денис Колисниченко

Спецвыпуск: Хакер, номер #053, стр. 053-048-6

Возможности по работе с форматами в Help Workshop ограничиваются только конвертированием из старого (.HLP) формата в новый (.CHM).

Где же взять компиляторы файлов справки? Можно стянуть с сайта Help Scribble: www.helpscribble.com/helpcompiler.html.

А можно поискать у себя дома на компактах – я уверен, что все они у тебя есть. Посмотри на окно опций Help Scribble: 16-разрядный компилятор нашелся в составе Borland C, 32-разрядный поставлялся вместе с Delphi, а компилятор для CHM-файлов – это HTML Help Workshop, который тоже можно найти на компакте с Delphi, хотя он не устанавливается по умолчанию. Если последнего у тебя нет, можно скачать его с сайта Microsoft (www.microsoft.com/workshop).

Компилирование CHM-файлов

Теперь перейдем к практике. Перед компилированием CHM-файла нужно будет создать документацию в формате HTML. После того как набор HTML-файлов будет приготовлен, просмотри его в Internet Explorer. В других обозревателях просматривать файлы справки надобности нет, поскольку для просмотра компилированных CHM-файлов используется именно Internet Explorer. Если нужно, исправь допущенные ошибки: для компилирования CHM-файлов нужно использовать уже чистовой вариант документации, поскольку исправить откомпилированный файл не получится.

Не нужно размещать HTML-файлы, относящиеся к разным разделам, в отдельных подкаталогах. То же касается картинок, которые ты будешь использовать в своем проекте, - не нужно по привычке создавать для них каталог images. При создании web-сайтов плоская модель считается плохим тоном, однако это не относится к созданию справочной системы. Пользователю от этого ни лучше ни хуже не станет, а тебе дополнительные подкаталоги могут добавить проблем при компилировании CHM-файла. Запусти Help Workshop и выполни команду меню File, New. Из появившегося меню выбери Project. С помощью Workshop можно создавать не только проекты, но и HTML-файлы, текстовые файлы, файлы указателей, которые впоследствии могут быть добавлены в проект. Однако я предпочитаю готовить все вручную (в "Блокноте"), а потом только компилировать все вместе.

После выбора операции создания проекта будет запущен мастер, с помощью которого можно или конвертировать старый файл справки в формате HLP, или создать новый проект. Файл справки (CHM-файл) нужно сохранить в том же каталоге, где расположена документация в формате HTML. Если этого не сделать (сохранить файл в другом каталоге), начнется неразбериха с гиперссылками в процессе компилирования. Например, если справочная система расположена в каталоге C:\Projects\Zarp2\Help, то имя файла справки должно выглядеть так: C:\Projects\Zarp2\Help\help. Разумеется, вместо help ты можешь ввести любое другое имя файла (будет создан файл с расширением .HHP). На следующем шаге мастер спросит, имеются ли уже готовые файл содержания (table of contents), указатель (Help index), файлы HTML. Нужно выбрать только последний пункт: документация в формате HTML уже готова. Откроется окно, в котором ты сможешь добавить нужные файлы.

Help Workshop создаст новый проект (файл с расширением .HHP). В окне Help Workshop ты увидишь закладки Project, Contents, Index и Help. Project предназначена для изменения общих параметров проекта, закладка Contents - для создания файла содержания, Index - для создания файла указателя. Закладку Help настоятельно рекомендую не использовать.