Любой программист, написавший в жизни хотя бы пару программ, по окончании написания программы задумывался, как организовать справочную систему для своей программы. Написать справку в блокноте - это смешно. Составить справочное руководство при помощи мощного текстового процессора типа MS Word - тоже как-то не очень серьезно.
Самый лучший вариант - это сделать справку в современном формате chm, но нужно обладать определенными знаниями для создания справки в этом формате. Как оказывается, эти знания иметь вовсе и не обязательно. На помошь придет программа HelpNDoc, которую Вы можете скачать прямо с сайта по ссылке Скачать HelpNDoc.
Интерфейс программы сделан в ленточном стиле MS Office 2007. Хотя программа на английском языке, разобраться в ней сможет любой, кто хоть раз работал в тектовом редакторе MS Word. Тем не менее кратко опишу процесс создания справки при помощи данной программы и в конце приведу пример справочного руководства, ранее созданного мной для своей программы.
Файл справки в формате CHM. Этап №1. Создание проекта
Итак, при первоначальном запуске программа предложит нам три варианта:
New Project - Новый проект
Open Project - Открыть существующий проект
Import... - данная опция позволит импортировать уже скомпилированный файл справки
Выберем опцию New Project. Откроется окно создания шаблона проекта справки, в котором можно задать имя проекта (Project Title) и язык проекта (Project Language), а также будет отображена таблица первоначального наполнения, которую можно импортировать из уже существующего проекта.
Директ
Отредактировав необходимые параметры, жмем кнопку Создать проект (Create Project), после чего будет создан проект по выбранному шаблону.
Файл справки в формате CHM. Этап №2. Задание опций проекта
Далее все делается интуитивно. Щелкнув по первой кнопке Project Options и выбрав вкладку General settings, мы попадем в окно задания опций проекта, в котором можно задать Имя проекта, автора, версию проекта, написать комментарий, добавить строку Copyright, задать топик, который открывается по умолчанию ("топик" - это раздел вашей справки) и т. д.
На вкладке Generation Settings можно задать пути для формирования файлов справок. Кстати, HelpNDoc позволяет создавать справку не только в формате CHM, но и PDF, HTML и Word.
На вкладках CHM Settings и PDF Settings, можно задать различные параметры файлов справок, формируемых в формате CHM и PDF соответственно. Например, для формата CHM можно задать отображаемые кнопки, размер шрифта и т. д.
Файл справки в формате CHM. Этап №3. Добавление топиков
Для добавления топиков (разделов справки) служит команда Add topic. Подтопики добавляются командой Add child topic.
Менять параметры топиков (иконку топика, Help Context и т.д.) можно через контекстное меню самого топика.
Файл справки в формате CHM. Этап №4. Форматирование текста
На вкладке Write можно задавать различные параметры форматирования текста как в MS Word.
Вкладка Insert позволяет добавлять различные объекты в файл справки, например картинки, видео, документы, HTML-код и т.д. При добавлении картинки и щелчке по ней сразу же появляется контекстная вкладка Format, которая позволяет изменить параметры отображения картинки.
Файл справки в формате CHM. Этап №5. Сохранение проекта
При нажатии на кнопку дискеты, предлагается сохранить проект в формате HND - это формат программы HelpNDoc. При необходимости можно будет потом сохраненный таким образом проект открыть и продолжить его редактирование.
Файл справки в формате CHM. Этап №6. Генерация файла справки
После того, как проект будет полностью закончен, Вам останется только нажать кнопку Generate Help и сгенерировать файл справки.
Совсем забыл. Сгенерировать проект не получится, если у Вас не установлена программа Microsoft HTML Help WorkShop, которую можно скачать в интернете либо прямо с этого сайта по ссылке Скачать MS HTML Help WorkShop.
Ну и напоследок привожу пример файла справки, созданный некогда мной для программы на Delphi Скачать testchop.chm. Удачи.
