Microsoft HTML Help Workshop

Современный программы выводят справочную информацию в Internet- стиле- окно, которое используется для вывода справки, напоминает окно Internet Explorer. И это не удивительно, так как для вывода справочной информации используется компоненты, составляющие основу Microsoft Internet Explorer. Система отображения справочной информации является частью операционной системы, поэтому никакие дополнительные средства для вывода справочной информации не нужны.

Физически справочная информация находится в файлах с расширением chm. CHM- файл- это так называемый компилированный HTML- документ.  CHM- файл получается путем компиляции (объединения) файлов, составляющих HTML-документ, который, как правило, состоит из нескольких HTML- файлов.

Процесс преобразования HTML-документа в справочную систему называют компиляцией. Исходной информацией для компилятора справочной системы являются HTML- файлы, файлы иллюстраций и файл проекта. В результате компиляции получается СHM- файл, содержащий всю справочную информацию.

Чтобы создавать справочную систему, нужно:

 -подготовить файлы справочной информации;

 -создать файл проекта;

 -создать файл контекста (содержания);

 -выполнить компиляцию.

Последние три из перечисленных выше шагов выполняются в программе HTML Help Workshop.

Подготовка справочной информации

Подготовить HTML- файл можно при помощи любого редактора текста. Наиболее быстро это можно сделать, если редактор позволяет сохранить набранный текст в HTML- формате, например редактор Microsoft World

Сначала нужно набрать текст разделов справки (каждый раздел в отдельном файле). Заголовки разделов и подразделов нужно оформить одним из стилей Заголовок. Заголовки разделов, как правило, оформляют стилем Заголовок1, подразделов- Заголовок2.

Далее необходимо вставить закладки в те точки документа, в которые предполагаются переходы из других частей документа. Чтобы вставить в документ закладку, нужно установить курсор в точку текста, в которой должна быть закладка, из меню Вставка выбрать команду Закладка и в поле Имя закладки диалогового окна Закладка (рис. 14.8) ввести имя закладки.

Имя закладки должно отражать суть предполагаемого перехода к закладке, содержимое помечаемого фрагмента текста. В имени закладки пробел использовать нельзя. Вместо пробела можно поставить символ подчеркивания. Заголовки, оформленные стилем Заголовок, помечать закладками не надо. Таким образом, если в создаваемой справочной системе предполагаются переходы только к заголовкам разделов справочной информации, закладки допускается не вставлять. После этого можно приступить к расстановке гиперссылок.

Чтобы вставить в документ ссылку на закладку или заголовок, который находится в этом же документе, надо выделить фрагмент текста (слово или фразу), который должен быть гиперссылкой, из меню Вставка выбрать команду Гиперссылка, в появившемся окне Добавление гиперссылки сначала щелкнуть на кнопке Связать с местом в этом документе, затем- выбрать закладку или заголовок, к которому должен быть выполнен переход.

Если нужно вставить в документ ссылку на раздел справки, который находится в другом файле, то в диалоговом окне Добавление гиперссылки нужно щелкнуть на кнопке Файл и в появившемся стандартном поле окне выбрать имя нужного HTML- файла.

После того как в документ будут помещены все необходимые гиперссылки, документ нужно сохранить в HTML- формате.

Подготовить HTML- файл можно и при помощи HTML-редактора, входящего в состав в состав HTML Help Workshop. Однако для этого надо знать хотя бы основы HTML.

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

После запуска HTML Help Workshop надо из меню File выбрать команду New/Project и в окне New Project - Destination ввести имя файла проекта справочной системы. После щелчка на кнопке Далее в этом и следующем окне, окно HTML Help Workshop

Первое, что надо сделать,- сформировать раздел [FILES], который должен включать имена HTML- файлов, содержащий справочную информацию по разделам. Чтобы добавить в раздел [FILES] имя файла, надо щелкнуть на кнопке Add/Remove topic files, затем, в появившемся диалоговом окне Открыть выбрать HTML- файл раздела справки. Если справочная информация распределена по нескольким файлам, то операцию добавления нужно повторить несколько раз. После того как в диалоговом окне Topic Files будут перечислены все необходимые для создания справочной информации HTML- файлы, нужно щелкнуть на кнопке OK. В результате этих действий в файле проекта появится раздел [FILES], в котором будут перечислены HTML- файлы, используемые для создания справочной системы.

Следующее, что надо сделать- задать главный (стартовый) раздел и заголовок окна, в котором будет выводиться справочная информация.

Текст заголовка и имя файла главного раздела вводятся соответственно в поля Title и Default file вкладки General диалогового окна Options, которое появляется в результате щелчка на кнопке Change project options.

Если для навигации по справочной системе предполагается использовать вкладку Содержание, то надо создать файл контекста. Чтобы это сделать нужно щелкнуть на вкладке Contents, подтвердить создание нового файла контекста и задать имя проекта. В результате станет доступной вкладка Contents, в которую нужно ввести содержание - названия разделов справочной системы.

Содержание справочной системы принято изображать в виде иерархического списка. Элементы верхнего уровня соответствуют разделам, а подчиненные им элементы - подразделам и темам.

Чтобы во вкладку Contents добавить элемент, соответствующий разделу справочной системы , нужно щелкнуть на кнопке Insert a Heading, в поле Entry title появившегося диалогового окна Table of Contents Entry ввести название раздела и щелкнуть на кнопке Add. На экране появится окно Path of URL. В поле HTML titles этого окна будут перечислены названия разделов (заголовки HTML- файлов) справочной информации, которая находится во включенных в проект файлах ( имена этих файлов указаны в разделе [FILES] вкладки Project). Если вместо названия раздела справочной информации будет указано имя файла, то это значит, что в этом файле нет тега <TITLE>. Выбрав (по заголовку или по имени) нужный файл нужно щелкнуть на кнопке ОК. В результате перечисленных выше действий во вкладке Contents появится строка с названием раздела справочной информации.

Если нужно изменить значок, соответствующий добавленному разделу, то следует щелкнуть на кнопке Edit selection и, используя список Image index вкладки Advanced окна Table of Contents, выбрать нужный значок (обычно рядом с названием раздела или подраздела изображена книжка).

Подраздел добавляется точно так же, как и раздел, но после того как подраздел будет добавлен, нужно щелкнуть на кнопке Move selection right. В результате чего уровень заголовка понизится, т.е. раздел станет подразделом.

Элементы содержания, соответствующие темам справочной информации, добавляются аналогичным образом, но процесс начинается щелчком на кнопке Insert a page.

Компиляция - это процесс преобразования исходной справочной информации в файл справочной системы (СНМ- файл).

Исходной информацией для HTML Help компилятора являются:

- файл проекта (ННР- файл);

- файл контекста (ННС- файл);

- файл справочной информации (НТМ- файлы);

- файлы иллюстрации (GIF- и JPG- файлы).

Результатом компиляции является файл справочной системы (СНМ- файл).

Чтобы выполнить компиляцию, надо из меню File выбрать команду Compile, в появившемся диалоговом окне Create a compiled file установить переключатель Automatically display compiled help file when done (после компиляции показать созданный файл справки) и щелкнуть на кнопке Compile. В результате этого будет создан файл справки, и на экране появится окно справочной системы, в котором будет выведена информация.

Чтобы вывести справочную информацию, которая находится в СНМ- файле, нужно воспользоваться ActiveX- компонентом (элементом управления) ньореп, который входит в состав Windows и представляет собой специальную динамическую библиотеку (файл Hhopen.ocx).

Первое, что следует сделать, - установить компонент Hhopen на одну из вкладок палитры компонентов. Для этого надо из меню Component выбрать команду Import ActiveX Control. На экране появится окно Import ActiveX, в котором будут перечислены все зарегистрированные в реестре Windows компоненты. В окне  Import ActiveX, в списке зарегистрированных компонентов, нужно выбрать строку hhopen OLE Control module и щелкнуть на кнопке Install. В результате этого на экране появится диалоговое окно Install,  в котором программист может выбрать пакет (packet - пакет, библиотека компонентов), в который будет добавлен устанавливаемый компонент. Компоненты, добавляемые программистом, "по умолчанию" добавляются в пакет dciusr. В результате щелчка на кнопке ОК выбранный компонент добавляется в пакет, и на экране появляется окно Package и запрос подтверждения процесса перекомпиляции пакета. По завершении процесса компиляции на экране появится окно, информирующее о том, что компонент добавлен в пакет и зарегистрирован. Значок компонента ньореп будет добавлен на вкладку ActiveX. В процессе компиляции будет создан файл представления компонента - модуль HHOPENLib_TLIB.pas, который содержит описание методов, свойств и событий компонента.

Модуль представления можно увидеть, загрузив его в редактор кода из каталога \Delphi 7\Lib. Пролистав в окне редактора кода модуль HHOPENLib_TLIB.pas, который представляет собой интерфейс для доступа к элементу управления, можно найти описание класса тньореп.

Класс тньореп представляет два метода: OpenHelp и CloseHelp.

Метод OpenHelp обеспечивает вывод справочной информации, метод close- Help - закрывает окно справочной системы.

У метода openHelp два параметра - имя файла справочной информации и имя раздела, содержимое которого будет выведено. В качестве имени раздела надо использовать имя HTML- файла, в который применялся программой HTML Help Workshop в процессе создания СНМ- файла. Следует обратить внимание на то, что оба параметра должны быть строками widechar.

Список использованной литературы:

1. Гагарина Л.Г., Кокорева Е.В., Виснадул Б.Д. Технология разработки программного обеспечения: учебное пособие/ под ред. Л.Г. Гагариной. -М.: ИД «ФОРУМ»: ИНФРА-М, 2013.

2. Терехов А.Н. Технология программирования: учебное пособие/ под ред. А.Н. Терехов. -М.: БИНОМ, 2010.

3. Семакин И.Г., Шестаков А.П. Основы программирования: учебное пособие/ под ред. И.Г. Семакин. -М.: НМЦ СПО, 2011.

4. Гвоздева В.А., Лаврентьева И.Ю. Основы построения автоматизированных информационных систем: учебное пособие/ под ред. В.А. Гвоздева. -М.: ИД «ФОРУМ»: ИНФРА-М, 2010.