Как создать chm справку к программе
Для создания HTML-документации вполне хватит "Блокнота", а какую программу будем использовать для создания
CHM-файла? Могу порекомендовать две очень удобные программы для создания CHM-файлов:
Microsoft HTML Help Workshop и
HelpScribble.
Первая очень удобна, позволяет из готовых HTML-файлов скомпилировать
CHM-файл (
Help Workshop позволяет). Лично мне эта программа симпатична больше (точнее, к ней я больше привык), чем
Help Scribble, но это только мое мнение. Help Scribble любезно избавит тебя от необходимости использовать дополнительные программы (кроме компилятора справки) для создания файла справки, чем выделяется среди себе подобных. Текст документации можно создавать прямо в
Help Scribble, причем в твоем распоряжении будет полноценный RTF-редактор, позволяющий изменять форматирование, применять макросы форматирования (аналог стилей в Word), вставлять картинки, кнопки и т.д. Главное отличие
HTML Help Workshop от
Help Scribble в том, что первая программа сама является компилятором CHM-файлов, а вторая - это RTF-редактор с функциями создания справки, но для самого процесса компиляции нужен внешний компилятор. Запусти Help Scribble и выбери команду меню Project, Options: ты увидишь окно поиска компилятора help-файлов.
Если ты хочешь создавать
CHM-файлы с помощью
Help Scribble, тебе все равно нужно установить HTML Help Workshop, поскольку он является компилятором
CHM-файлов. Зато
Help Scribble, в отличие от
HTML Help Workshop, умеет создавать файлы справки любых форматов, а не только
CHM: Например:
- 16-разрядный
help-файл, который поддерживается всеми ОС Windows, начиная с Windows 3.11 и заканчивая Windows XP.
- 32-разрядный
help-файл, который поддерживается операционными системами Windows 95-XP.
- CHM-файл, поддерживаемый системами Windows 98, ME, 2000, XP.
Возможности по работе с форматами в 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:ProjectsZarp2Help, то имя файла справки должно выглядеть так: C:ProjectsZarp2Helphelp. Разумеется, вместо help ты можешь ввести любое другое имя файла (будет создан файл с расширением .HHP). На следующем шаге мастер спросит, имеются ли уже готовые файл содержания (table of contents), указатель (
Help index),
файлы HTML. Нужно выбрать только последний пункт: документация в формате HTML уже готова. Откроется окно, в котором ты сможешь добавить нужные файлы.
Help Workshop создаст новый проект (
файл с расширением .HHP). В окне
Help Workshop ты увидишь закладки Project, Contents, Index и Help. Project предназначена для изменения общих параметров проекта, закладка Contents - для создания файла содержания, Index - для создания файла указателя. Закладку Help настоятельно рекомендую не использовать.
Обычно
Help Workshop неправильно устанавливает начальную страницу (
Default Topic). Эта страница будет отображена при запуске справочной системы первой. Нажми кнопку
Change project options (самая верхняя кнопка на странице Project) и в появившемся окне введи заголовок проекта и выбери файл по умолчанию (
Default file) из списка. Файл должен быть указан в списке
FILES.
Закладка Contents используется для создания нового файла содержания, который содержит информацию о разделах справочной системы. Закладка Index позволяет создать файл указателя – не ленись! Разобраться с этими закладками особого труда для тебя не составит, поэтому комментировать их не буду.
Когда файл проекта будет готов к компиляции, нажми кнопку
Compile HTML file, которая находится на панели инструментов
Help WorkShop, или выбери команду
File,
Compile. Убедительно рекомендую перед компилированием сохранить файл проекта. После завершения процесса компилирования увидишь протокол компилирования, в котором
Help WorkShop предоставит подробный отчет о разделах, файлах, картинках, ошибках и предупреждениях.
Вот, собственно, и все. Помни: конечный пользователь не хочет много думать, он хочет получить простой, понятный и наглядный продукт. Документация - неотъемлемая часть хорошей программы.
