8.2. Подготовка справочного файла с помощью программы Windows Help Designer

Окно программы имеет структуру:

Создание справочного файла начинает с разработки оглавления(Contents). На вкладке Contents формируется оглавление в виде дерева. Используя контекстное можно:

Создать главу (Header),Команда: Insert.

Создать тему (Topic),Команда: Insert.

Рис.8.3.Окно WHD.

Изменить название главы, или темы. Команда:Properties>Title

Затем на вкладке Topics выполняется настройка атрибутов тем с помощью контекстного меню:

Вызывают команду Properties и на вкладке Basics редактируют:

Рис.8.4.Окно свойств тем.

Название темы (Topic Title).

Идентификатор (Topic ID).

Порядковый номер контекста темы (Context number).

Тип окна справочной системы(main).

Возможность прокрутки текста (флаг No Scroll area).

Идентификаторы следует вводить латинскими буквами, для их отличия от названий.

Затем темам назначаются ключевые слова. Вкладка Keywords, окна Properties.

Рис.8. 5.Задание ключевых слов.

C помощью данного окна назначают ключевые слова (Add), редактируют(Edit), удаляют(Remove).

Следующий этап разработки – создание гипертекстовых переходов. Для этого нужно открыть тему где содержится текст с точкой перехода, выделить ключевое слово, или фразу и используя команду контекстного меню Jump properties на вкладке Topic Context настроить переход:

Указать тему – адрес перехода(Jump to Context).

Идентификатор окна отображения текста

(Display in window>main).

Тип окна:

Текущее(Same window)

Всплывающее (Pop up)

После завершения формирования переходов сохраняют проект справки в файл с расширением PRJ, программа автоматически создает RTF файл.

Затем выполняется компилирование справки с помощью инструмента , в результате на диске создается два файла:

Рис.8.6. Настройка гипертекстового перехода.

• файл с расширением CNT (оглавление)

• файл с расширением HLP (файл справки)

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

При разработке справочной системы можно получить следующие дополнительные возможности:

Операция	Действие
Вставка рисунка	Insert>Picture
Вставка таблицы	Insert>Table
Вставка видео	Insert>AVI
Вставка символа	Insert>Symbol
Кнопка	Insert>Button
«Шапка в названии темы»

8.3. Подключение справочной системы к программе

При использовании Visual Basic для просмотра справочного файла с помощью программного кода следует выполнить следующие действия:

Разместить в модуль программы API функцию WinHelp. Запрограммировать обращение к функции путем использования кодов команд управления просмотром справочного файла.

Основные команды управления справочной службой:

Команда	Код
Открытие оглавления	11
Открытия раздела поиска по ключу	105h
Справка о «Справке»	4
Закрытие справочной службы Windows	2

Функция WinHelp требует для своей работы задания четырех параметров:

• Указателя на окно программы

• Имя справочного файла проекта

• Кода команды

• Параметра

Пример кода модуля программы с процедурой для просмотра содержимого справочного файла.

Declare Function WinHelp Lib "user32" Alias "WinHelpA" _

(ByVal hwnd As Long, ByVal lpHelpFile As String, ByVal wCommand As Long, ByVal dwData As Any) As Long

Public Const HELP_QUIT = 2 'Закрыть справочную службу

Public Const HELP_FINDER = 11 'Вывод содержания

Public Const HELP_HELPONHELP = 4 'Получение "справки о справке"

Public Const HELP_PARTIALKEY = &H105

Sub HelpFile(frmForm As Form, nHelpCmd As Integer)

Dim i As Integer

Dim nFlag As Integer

Dim aData As Variant

'Проверка наличия файла справки

If Len(LTrim(RTrim(App.HelpFile))) = 0 Then

MsgBox "Справочный файл не найден !", _

vbOKOnly + vbCritical,"Информация"

Exit Sub

End If

'Проверка достоверности команд

Select Case nHelpCmd

Case Is = HELP_QUIT

nFlag = True

Case Is = HELP_FINDER

nFlag = True

Case Is = HELP_HELPONHELP

nFlag = True

Case Is = HELP_PARTIALKEY

nFlag = True

Case Else

nFlag = False 'invalid command!

End Select

'Вызов справочной службы Windows с

'допустимым кодом команды

If nFlag = True Then

If nHelpCmd = HELP_PARTIALKEY Then

i = WinHelp(frmForm.hwnd, App.HelpFile, nHelpCmd, "")

Else

i = WinHelp(frmForm.hwnd, App.HelpFile, nHelpCmd, 0&)

End If

Else

MsgBox "Недопустимый код команды", _

vbOKOnly + vbCritical,"Информация"

End If

End Sub

Чтобы указать имя справочного файла проекта следует использовать событие Load главной формы:

Private Sub Form_Load()

On Error Resume Next

'Подсоединение справочного файла

App.HelpFile = App.Path + "\samplehlp.hlp"

End Sub

Доступ к справочной информации пользователь программы получает с помощью меню команд. Выбор команды приводит к обращению к процедуре HelpFile.

Например:

Call HelpFile(Me, HELP_FINDER)

Следует запрограммировать закрытие справочной службы при выходе из программы. Событие UnLoad главной формы.