Создание справки chm. Создание файла CHM средствами HTML Help Workshop

Любой программист, написавший в жизни хотя бы пару программ, по окончании написания программы задумывался, как организовать справочную систему для своей программы. Написать справку в блокноте - это смешно. Составить справочное руководство при помощи мощного текстового процессора типа 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 . Удачи.

Файл в формате CHM предназначен для отображения справочной документации. Скомпилированный файл справки в формате HTML (.chm) разработан корпорацией Майкрософт.

Файл справки в формате CHM (Compiled Help Modules) по умолчанию открывается утилитой, встроенной в операционную систему. Для открытия файла в этом формате достаточно два раза кликнуть по файлу CHM мышью, или открыть файл в соответствующей программе, которая имеет справочную информацию в виде файла данного типа, из меню управления приложения.

Не открывается файл CHM

В некоторых случаях, файл справки с расширением CHM не открывается:

• если файл CHM находится на сетевом диске, то для открытия файла нужно скопировать файл справки на компьютер
• если в имени файла есть кириллица или специальные символы, то нужно переименовать файл, дав файлу имя буквами латинского алфавита

Не отображается содержимое файла CHM

Намного чаще встречаются другой вариант: сам CHM файл запускается из программы, или непосредственно после клика по файлу, но содержимое справки не отображается. Открыто только содержание документа.

На написание этой статьи меня надоумил случай, происшедший со мной. Я писал обзор программы IrfanView. Программа поддерживает русский язык, но файлы для русификации программы, устанавливаются после установки программы. После установки языкового пакета, я запустил файл справки в программе, и увидел, что содержимое CHM файла не отображается.

Операционная система Windows блокирует отображение файла справки с целью защиты компьютера.

Что делать? На самом деле, я знаю, что следует сделать, так как ранее уже сталкивался с подобной проблемой. Я продумал, что некоторые пользователи также могут столкнуться с таким вариантом запуска документа. Человек надеется получить ответы на свои вопросы, а вместо этого, получает пустое содержание файла справки, отображается только оглавление.

Сначала необходимо найти скомпилированный файл справки в формате CHM на компьютере. В большинстве случаев, он расположен в папке установленной программы.

После этого откроется окно «Свойства: имя_файла». В нижней части окна вы увидите предупреждение: «Осторожно: этот файл получен с другого компьютера и, возможно, был заблокирован с целью защиты компьютера».

Создаем или редактируем файл справки в формате CHM.

Файл справки CHM - это скомпилировнные в единое целое файлы HTML. Начну с того, что если редактировать файл, то сначала нужно его разобрать, а потом его собрать. Для этого нужно скачать бесплатную программу-компилятор MS HTMLHelp WorkShop (3500 KB). Лучше всего не отделываться общими фразами, а сразу описать все в примере.

Начнем. Нужно отредактировать к примеру файл help.chm , создайте папку, например chmhelp , и скопируйте его туда. Запусите MS HTMLHelp WorkShop и выберите меню File - Decompile... . В появившемся окне нажмите первую кнопку Browse... , найдите и укажите вашу папку chmhelp . Нажмите вторую кнопку Browse... , появится еще одно окно, найдите и укажите декомпилируемый файл help.chm . Нажмите ОК и через некоторое время у вас появятся много файлов в формате HTML.

Понятное дело, что без знания HTML-кода такие файлы редактировать тяжело. Для этих целей я написал небольшой патч Mode Edit IE , который из обозревателя Internet Explorer превращает его в редактор HTML. Но не просто превращает его в обычный редактор, а позволяет полностью проследить процесс редактирования, т.е. процесс правки будет полностью визуальный, примерно такой, как если бы вы правили такие файлы в MS Word. Можно тут возразить, а зачем нужно патчить IE, если есть текстовый процессор Word? Могу сказать, что после сохранения HTML-файла в Word, такой файл распухнет до безобразия. Можете поэкспериментировать. А редактирование в Internet Explorer позволяет сохранить код, в котором файл был создан изначально. Патч лишен многих возможностей, но основные операции с текстом и объектами HTML-файла может делать. Можно вставить или изменить гиперссылку, удалить или вставить рисунок. Нет возможности изменить шрифт или назначить фон... Обо всем об этом можно будет узнать из справки, которую можно будет вызвать из меню Сервис - Справка по режиму редактирования. Этот пункт появится в Internet Explorer после пропатчивания. Не буду описывать здесь Mode Edit IE , т.к. статья вообще-то по созданию справок CHM. А для более детального изучения кода HTML рекомендую учебник по HTML Алленовой Натальи , расположенном на ее сайте по адресу http://www.postroika.ru/news2.html

После редактирования файлов HTML, нужно их снова запихать в формат СНМ. После декомпиляции у вас будут файлы с расширением HTM или HTML, или другое расширение, но будет один файл с содержанием, т.е. тот файл, который отвечает за окошко слева главного окна справки, на рисунке ниже отмечен красным.

Его расширение будет СНН , в нашем случае help.chh . Но без файла проекта собрать все же не удастся, поэтому запустите MS HTMLHelp WorkShop, выберите File - New, в появившемся окне выберите Project и нажмите ОК.

Появится окно мастера, нажмите кнопку Next (Далее). На следующей странице (рис. ниже) введите вручную путь к вашей папки и имя без расширения - Next (Далее). На следующей странице мастера никаких галок не ставьте - Next (Далее), и появится последняя страница, на которой нужно нажать кнопку Finish (Готово). В вашей папке chmhelp появится файл с расширением HPP, т.е. help.hhp, а главном окне MS HTMLHelp WorkShop слева, как и в файле справки, этот файл отобразится (на рис. ниже отмечен красным).

Нажмите на панели инструментов MS HTMLHelp WorkShop слева кнопку (Add/Remove topic fies) и в новом окне Topic Files нажмите кнопку Add и найдите начальный файл HTML (обычно такие файлы имеют имя index или default , хотя не исключено и другое имя, в этом вы должны были разобраться при редактировании страниц). В MS HTMLHelp WorkShop перейдите на вкладку Contenst , при этом появится окошко (рис. ниже), в котором нужно установить переключтель в пункт и нажать ОК. Выберите файл help.chh , который тоже откроется в MS HTMLHelp WorkShop на вкладке Contenst .

Здесь нужно будет отредактировать, используя кнопку (Edit Selection), темы справки. Эти темы правятся в окне в поле Entry title (рис. ниже) - ОК. Так нужно поступить с каждой из тем.

После всех этих манипуляций нажмите кнопку (Compile HTML file) и дождитесь компиляции вашего справочного файл help.chm . На разного рода сообщения отвечайте положительно.