Создание справочной системы приложения_лекция

Создание справочной системы приложения
Разработанное вами приложение должно быть интуитивно понятным и дружественным к пользователю. В случае возникновения у него затруднений он должен быстро получить справку о возможных действиях. Обычно требуемую формацию можно получить одним из следующих способов:
найти в руководстве пользователя;
обратиться за консультацией к разработчику приложения;
воспользоваться справочной системой приложения, содержащей информацию, о приложении, описание его основных функций и инструкцию по работе. Это самый простой способ получения нужной справочной информации.
Создание справочной системы приложения является необходимым шагом в процессе создания серьезного приложения. Для решения этой задачи предназначено приложение HTML Help Workshop, которое предоставляет разработчику широкие возможности организации справочной системы для приложений. Создание справочной системы включает в себя ряд этапов проектирования и реализации, рассмотрению которых и посвящен этот урок.
Концептуальные основы реализации справочной системы
Разработку справочной системы следует начать с планирования, которое включает в себя два блока задач: содержание справочной системы и организацию доступа к файлам справочной системы. Основу любой справочной системы составляют темы, содержащие пояснительный текст в виде html-файлов. Перечислим основной набор задач, которые необходимо решить при разработке справочной системы приложения.
Содержание справочной системы представляет собой список доступных в системе тем, каждая из которых имеет заголовок и уникальный символьный идентификатор. Дополнительно каждой теме можно поставить в соответствие уникальный индекс темы, который должен быть целым числом.
Для поиска темы в справочной системе предусмотрены ключи, содержащие название темы и ссылку на нее. Каждой теме можно поставить в соответствие более одного ключа поиска. Допускается и обратное, один ключ может содержать ссылку на несколько тем.
Для организации контекстного вызова темы из справочной системы вы можете использовать числовые значения индексов или значения ключа. Использование идентификаторов тем для контекстного вывода справочной информации не допускается.
Для связывания между собой отдельных тем предназначены перекрестные ссылки. При этом текст, используемый для организации перекрестной ссылки, выделяется зеленым цветом и подчеркиванием.
В описании любой системы используются термины, специфичные для конкретной системы. Например, в системах складского учета такими терминами будут накладная, счет, отпуск товара. В качестве термина может рассматриваться не только отдельное слово, но и любая фраза из текста темы.
Рассмотрим только средства, используемые при создании справочной системы с помощью пакета HTML Help Workshop. В качестве примера создадим простую справочную систему, состоящую из нескольких тем. Для каждой темы определим заголовки, идентификаторы и ключи, используемые для поиска информации.
Основные этапы создания справочной системы
После инсталляции HTML Help Workshop можно приступать к разработке справочной системы в формате HTML. Создаваемая справочная система представляет собой множество файлов разного типа, которые создаются разработчиком приложения с помощью данной программы. По сравнению с другими аналогичными средствами программа HTML Help Workshop имеет ряд преимуществ, состоящих в возможности компилирования, тестирования, просмотра и редактирования всех разделов справочной системы.
В наиболее общем виде разработка справочный системы включает ряд этапов, основными из которых являются следующие:
1. Создание исходных файлов справочной системы, включающих:
html-файлов с описанием отдельных тем справки;
файла проекта;
файла содержания, задающего иерархическую структуру разделов, подразделов и страниц справки, которая отображается на вкладке Содержание (Contents);
индексного файла, используемого для быстрого поиска информации.
2. Операцию компиляции файла проекта, после выполнения которой все файлы справочной системы компилированы в один файл справки.
3. Тестирование и отладка справочной системы.
4. Назначение разделов справки элементам интерфейса приложения.
Рассмотрим особенности реализации каждого из перечисленных этапов более подробно.
Создание файла проекта
На первом этапе от вас потребуется создание файла проекта. Данная процедура предусматривает выполнение ряда последовательных действий:
Используя один из редакторов, поддерживающих формат файлов HTML (например, Microsoft Word), создайте темы справочной системы и сохраните каждую из них в отдельном HTML-файле.
Запустите программу HTML Help Workshop и постройте новый проект справочной системы, выбрав команду FileNew.
Выберите в открывающемся окне диалога New (рис. 1.1) вариант Ргоject и нажмите кнопку ОК. Появляется окно диалога New Project. С этого момента к созданию справочной системы подключается мастер проекта.
СОВЕТ: При наличии у вас ранее созданного проекта справочной системы в формате WinHelp вы можете преобразовать его в проект формата HTML, предварительно установив в окне диалога New Project флажок Convert WinHelp project.
4. Нажмите кнопку Далее (Next) для перехода к окну диалога New Project – Destination и укажите в нем название файла проекта и папку, в которой он будет храниться. После выполнения этого нажмите еще раз кнопку Далее (Next). Файлу проекта по умолчанию будет присвоено расширение .hhp.

Рис. 1.1. Окно диалога New предназначено для выбора варианта спецификации
5. Выберите в открывающемся окне New Project Existing Files (рис. 1.2) форматы заготовок файлов, которые должны быть включены в состав справочной системы. Если, как было предложено в пункте 1 данного алгоритма, вы создали темы справочной системы в виде hmtl-файлов, то вам потребуется установить флажок HTML files (.htm) и нажать кнопку Далее (Next).

Рис. 1.2. Окно диалога New Project – Existing Files
Используя кнопки Add и Remove, включите в текстовое поле появляющегося окна диалога New Project – HTML Files ранее созданные HTML файлы с темами. Затем, нажав кнопку Далее, перейдите в окно диалога New Project – Finish и щелкните на кнопке Готово.
После выполнения перечисленных действий отображается окно HTML Help Workshop (рис. 1.3).
СОВЕТ: При необходимости в будущей работе пополнения файла проекта новой темой выделите в окне HTML Help Workshop раздел [FILES] и нажмите кнопку Add/Remove topic file. Затем установите в открывающемся окне диалога Topic Files нужную тему и нажмите кнопку ОК.
Главное окно HTML Help Workshop
Окно программы HTML Help Workshop (рис. 1.3) состоит из двух частей. В левой части находятся вкладки Project, Contents (Содержание) и Index (Указатель). Вдоль левой границы окна размещена соответствующая им контекстно-зависимая панель инструментов.

Рис. 1.3. Главное окно программы HTML Help Workshop с файлом проекта
В правой части окна отображается содержимое выбранной темы справочной системы в виде файла HTML. Вы можете не только просмотреть этот файл, но и редактировать его с помощью команд из меню Tags (Теги) и кнопок панели инструментов.
HTML Help Workshop предоставляет вам возможность просмотра файлов с темами в Web-броузере (рис. 1.4). Для реализации этой возможности пометьте имя требуемого файла в разделе [FILES] и нажмите кнопку Display in Browser (Отобразить в браузере).

Рис. 1.4. Просмотр темы создаваемой справочной системы в Web-браузере
Настройка параметров проекта справочной системы
Параметры проекта отображаются в разделе [Options] вкладки Project (Проект). Для их редактирования выполните двойной щелчок мыши на разделе [Options] или нажмите кнопку Change Project Options (Изменить параметры проекта) на панели инструментов этой вкладки. Откроется окно диалога Options (Параметры) (рис. 1.5), которое содержит четыре вкладки: General (Общие), Files (Файлы), Compiler (Компилятор) и Merge Files (Объединяемые файлы).

Рис. 1.5. Вкладки окна диалога Options предназначены для настройки параметров проекта
Остановимся на назначении параметров вкладок окна диалога Options:
Вкладка General предназначена для определения следующих параметров:
- Title заголовок окна справочной системы;
- Default file и Default window – соответственно файл темы и окно, выбираемые при открытии справочной системы;
- Language и Font язык и шрифт, используемые для отображения справочной системы.
Вкладка Files используется для указания расположения файлов справочной системы (Compiled file), файлов с указателями (Index file) и содержанием (Contents file).
На вкладке Compiler задаются параметры компиляции справочной системы.
На вкладке Merge Files можно задать откомпилированные файлы справки, которые должны сливаться в процессе работы приложения.
Определение псевдонимов тем
Для использования справочной системы в приложениях предварительно необходимо определить псевдоним каждой темы. Это можно сделать следующим образом:
Откройте окно диалога HtmlHelp API information, нажав одноименную кнопку на панели инструментов вкладки Project (Проект).
Перейдите на вкладку Alias (Псевдоним) (рис. 1.6) и нажмите кнопку Add (Добавить)

Рис. 1.6. Вкладка Alias окна диалога HtmlHelp API information
Установите в окне диалога Alias (Псевдоним) (рис. 1.7) с помощью раскрывающегося списка имя файла темы и введите в расположенное над ним поле связанный с ним псевдоним (в данном случае IDN_Стимул). В результате в справочную систему будет добавлен новый псевдоним.
4. Повторите пункт 3 необходимое количество раз в соответствии с имеющимся количеством файлов справочной системы.
ПРИМЕЧАНИЕ: Отметьте, что в левой части окна HTML Help Workshop появился новый раздел [Alias] ([Псевдоним]).
5. После создания и редактирования файла псевдонимов нажмите в панели инструментов вкладки Project (Проект) на кнопке Save file.

Рис. 1.7. Назначение файлам справочной системы псевдонимов
Установка связи между псевдонимами и индексами тем
Индексы тем используются при открытии определенной темы справочной системы. Задание связи между ними и псевдонимами тем осуществляется путем создания специального текстового файла. В этом файле вы должны описать все идентификаторы, по которым будет осуществляться контекстный вызов. Данный файл состоит из строк, содержащих ключевое слово #Define, за которым следуют разделенные пробелом идентификатор (псевдоним) и индекс темы.
Ниже приведен пример текста:
#Define IDN_Пропаганда 1
#Define IDN_Реклама 2
#Define IDN_сегмент 3
После создания файла связи (данный файл должен иметь расширение .h) вы должны связать его с файлом проекта. Для этого перейдите в окне диалога HtmlHelp API information на вкладку Map и добавьте его в список подключаемых файлов.
ПРИМЕЧАНИЕ: Отметьте, что в левой части окна HTML Help Workshop появился новый раздел [Мор].
Создание содержания справочной системы
Наиболее типичный способ получения справки по интересующему нас разделу или теме состоит в обращении к содержанию справочной системы. Обычно окно справочной системы содержит три вкладки: Содержание (Contents), Указатель и Поиск. Для того чтобы в окне диалога присутствовала вкладка Содержание, необходимо создать файл с содержанием справки.
В данном разделе мы рассмотрим технологию создания содержания справочной системы, реализация которой предполагает выполнение следующей последовательности шагов:
Перейдите на вкладку Contents, нажав мышью на ее заголовке в левой части окна справочной системы. В том случае, если файл содержания не найден, появится окно диалога Table of Cont
·ents Not Specified (рис. 1.8).
Если вы еще только собираетесь создать содержание справочной системы, то оставьте предлагаемый по умолчанию вариант Create a new contents file (Создать новый файл содержания) и нажмите кнопку ОК. Появляется окно диалога Сохранение.

Рис. 1.8. Окно диалога Table of Contents Not Specified
Укажите папку и имя создаваемого файла с содержанием справочной системы, примите предлагаемое по умолчанию расширение файла в формате ННС и нажмите кнопку Сохранить. В результате будет создан файл содержания, в котором пока не содержится никакой информации (об этом свидетельствует пустая область раздела Contents (Содержание) в левой части главного окна). На следующем шаге мы приступим к наполнению файла содержания путем последовательного ввода заголовков тем и страниц справочной системы.
Для добавления заголовка или строки ссылки на тему справочной системы нажмите соответственно на одну из кнопок: Insert a heading (Вставить заголовок) или Insert a page (Вставить страницу). В обоих случаях откроется окно диалога Table of Contents Entry (рис. 1.9).

Рис. 1.9. Вкладка General окна диалога Table of Contents Entry
5. Задайте в этом окне наименование строки содержания в поле Entry title и URL-ссылку в расположенном под ним текстовом поле ввода. Нажмите кнопку ОК. В результате в разделе Contens (Содержание) появляется строка содержания (в данном случае это заголовок темы – Редактирование).
6. Аналогичным образом вы можете добавить заголовки нескольких уровней вложенности и непосредственно ссылки на темы справочной системы, варьируя нажатие кнопок Insert a heading (Вставить заголовок) и Insert a page (Вставить страницу).
СОВЕТ: Вы можете создать многоуровневое содержание справочной системы. Для изменения уровня заголовка используйте кнопки Move selection right (Сдвинуть вправо) и Move selection left (Сдвинуть влево).
Результатом выполнения перечисленных операций будет создание содержания справочной системы, внешний вид которого приведен на рис. 1.10.
7. После создания и редактирования файла содержания нажмите в панели инструментов вкладки Contents (Содержание) на кнопке Save file.

Рис. 1.10. На вкладке Contents отображается содержание разрабатываемой
справочной системы приложения
Создание ключей для поиска тем справочной системы
Ключи к темам предназначены для организации поиска тем и страниц справочной системы. Как и строки, определяющие содержание тем и страниц справочной системы, ключи хранятся в специальном файле, который также сначала надо создать, а затем наполнить конкретным материалом.
1. Для создания файла с ключами поиска перейдите на вкладку Index (Указатель), нажав на строке заголовка с ее именем. Отображается окно диалога Index Not Specified (рис. 1.11).

Рис.1.11. Окно диалога Index Not Specified
Примите предлагаемый по умолчанию вариант Create a new index file (Создать новый файл содержания) и нажмите кнопку ОК. Появится окно диалога Сохранение, идентичное рассмотренному нами ранее при изучении раздела, посвященного созданию содержания справочной системы.
Укажите папку и имя (можно оставить предлагаемое по умолчанию имя Index) создаваемого файла с ключами, примите предлагаемое по умолчанию расширение файла в формате ННК и нажмите кнопку Сохранить. В результате будет создан специальный файл, предназначенный для хранения информации о ключах справочной системы. Но пока он не заполнен (об этом свидетельствует пустая область раздела Index в левой части главного окна). Теперь пора приступить к наполнению индексного файла конкретным содержанием. Используя кнопки панели инструментов вкладки Index (Индекс), вы можете создан новый ключ, редактировать ранее созданный или удалить ключ.
Для добавления нового ключа нажмите кнопку Insert a keyword (Вставить ключ). Откроется окно диалога Index Entry (рис. 1.12).

Рис. 1.12. Задание тем для ключа
Введите в поле Keyword (Ключ) название ключа, а затем, используя кнопку Add, добавьте в список Files/URLs and their information types созданные ранее темы справочной системы.
Для изменения тем используйте кнопку Edit (Редактировать), а для удаления – кнопку Remove (Удалить).
Результатом выполнения данного алгоритма будет создание ключей справочной системы, которые отображаются в разделе Index (Индекс) (рис. 1.13).

Рис. 1.13. Определение ключей для поиска тем
7. После создания и редактирования файла, содержащего установленные вами ключи к темам, нажмите в панели инструментов вкладки Index (Индекс) на кнопке Save file.
Компиляция и тестирование справочной системы
Следующим шагом после подготовки проекта справочной системы является выполнение процедур сохранения и компилирования.
Перейдите на вкладку Project (Проект) и сохраните файлы проекта, содержания и указателя, нажав кнопку Save project, contents and index files на панели инструментов этой вкладки.
Для компиляции созданного проекта нажмите кнопку Compile HTML file (Компилировать HTML файл) на панели инструментов HTML Help Workshop.
Нажмите кнопку View compiled file (Просмотр скомпилированного файла), чтобы просмотреть созданный файл справочной системы. Откроется окно, представленное на рис. 1.14.


Рис. 1.14. Просмотр справочной системы
Подключение справочной системы к приложению
Для подключения справочной системы к документу необходимо сначала познакомиться с элементами управления, с помощью которых организуется связь с темами справочной системы.
ПРИМЕЧАНИЕ: Использование справочной системы имеет свои особенности для MS Access 2000 и остальных приложений MS Office 2000. Рассмотрим сначала процесс подключения справочной системы к документам различных приложений MS Office, а потом – к базам данных MS Access.
Чтобы вызвать справочную систему, обычно создают соответствующую команд в меню Справка (Help) или кнопку на панели инструментов, а потом назначают ей макрос (пример такого макроса приведен далее), вызывающий соответствующий файл справки.
Кроме простого вызова справочной системы можно также использовать контекстно-зависимую справку для различных форм и элементов управления, входящих в состав документа.
Определение темы контекстно-зависимой справочной системы
для форм элементов управления
Для связывания формы и элементов управления с темами справочной системы необходимо, прежде всего, определить для проекта файл справки.
1. С помощью команды Properties из меню Tools откройте окно свойств проекта и введите в поле Help File Name (Имя файла справочной системы) имя файла справочной системы с указанием полного пути к нему (рис. 1.15).

Рис. 1.15. Определение файла справки для проекта
2. Задайте для элементов управления формы или для самой формы свойство HelpContextID, которое использует индекс темы, заданный в разделе [MAP] файла проекта справочной системы.
Если вы установили это свойство, то во время просмотра формы нажатие клавиши F1 приведет к открытию указанной темы справочной системы.
Работа со справкой из VBA в приложениях MS Office
Чтобы вызвать справочную систему из программы VBA, следует использовать метод Help объекта Application. Рассмотрим подробнее этот метод.
Метод Help
Метод Help отображает темы справочной системы. Синтаксис метода Help:
Expression.Help(HelpFile, ContextID)
Элементы синтаксиса метода Help представлены в табл. 1.1.
Таблица 1.1. Элементы синтаксиса метода Help
Элемент
Описание

Expression
Обязательный элемент синтаксиса – выражение, которое возвращает объект Application

HelpFile
Необязательный элемент синтаксиса. Данный параметр типа String задает имя отображаемого файла справки. Если данный аргумент отсутствует, то будет использована справочная система соответствующего приложения

ContextID
Необязательный элемент синтаксиса. Этот параметр типа Long определяет
индекс справки. Если данный аргумент отсутствует, то отображается окно диалога Содержание

ПРИМЕЧАНИЕ: С помощью данного метода можно отобразить как файлы справки с расширением .chm, так и с расширением .hlp.
Пример процедуры, использующей метод Help для вызова справки, представлен ниже:
Sub Examp()
Application.Help "е:\пе1р\Маркетинг.chm", 3
End Sub
Работа со справочной системой в MS Access
Так же как и в других приложениях для вызова справки, в MS Access обычно создают меню Справка или специальную кнопку на панели инструментов. При этом в качестве значения свойства Действие (OnAction) этой команды или кнопки следует задать имя функции, отображающей справку (пример такой функции приведен далее).
Как уже было сказано ранее, работа со справочной системой в MS Access имеет свои особенности. Например, если в проектах MS Word или MS PowerPoint мы можем назначить файл справки только всему проекту в целом, то в MS Access для каждой отдельной формы или отчета можно назначить свой файл справки.
Сначала мы рассмотрим процедуру назначения контекстно-зависимой темы раздела справки форме или элементу управления, а потом поясним процесс управления отображением справки из программы VBA.
Назначение темы контекстно-зависимой справки
формам и элементам управления в MS Access
Для того чтобы в форме можно было вызвать контекстно-зависимую справку, необходимо задать соответствующие значения свойствам Help File (Файл справки) и Help Context Id (Идентификатор справки) этой формы. Значением свойства Help File (Файл справки) должен являться полный путь к файлу контекстно-зависимой справки и его имя, а в качестве значения свойства Help Context Id (Идентификатор справки) следует указать контекстное число этого раздела.
Конкретные разделы справки можно назначить не только форме, но и элементу управления, так как они также имеют свойство Help Context Id (Идентификатор справки). В отличие от формы элементы управления не имеют свойства Help File (Файл справки) и поэтому для них разделы справки должны содержаться в файле справки соответствующей формы.
ПРИМЕЧАНИЕ: Если для элемента управления не задано свойство Help Context Id (Идентификатор справки), то для него используется раздел справки, назначенный для формы.
Работа со справкой в MS Access из программы VBA
Объект Application в MS Access, в отличие от MS Excel и MS PowerPoint, не имеет специального метода Help для вызова справки. Однако мы можем использовать функцию Windows API, которая называется HtmlHelp.
Объявление данной функции выглядит следующим образом:
Public Declare Function HtmlHelp Lib "HHCtrl.ocx" Alias _
"HtmlHelpA" (ByVal hwndCaller As Long, _
ByVal pszFile As String, ByVal uCommand As Long, _
dwData As Any) As Long
Рассмотрим параметры функции HtmlHelp:
параметр hwndCaller это дескриптор окна приложения или Null. В данном случае этот параметр равен 0;
параметр pszFile задает имя скомпилированного файла справки;
параметр uCommand определяет выполняемую команду;
параметр dwData задает дополнительные данные, определяемые предыдущим параметром.
Дополнительно к ним нужно объявить две константы, которые используются в качестве значения параметра uCommand:
Public Const HH_DISPLAY_TOPIC = &H0
Public Const HH_HELP_CONTEXT = &HF
Команда, определяемая константой HH_DISPLAY_TOPIC, требует указания имени исходного файла, содержащего нужный раздел, а команда, определяемая константой HH_HELP_CONTEXT, требует указания идентификатора этого раздела.
Приведем пример вызова функции HtmlHelp:
Function CallHelp()
Call HtmlHelp(0, "[ Cкачайте файл, чтобы посмотреть ссылку ]р\Маркетинг.chm", _
HH_DISPLAY_TOPIC, ByVal "Стимулирование сбыта.htm")
End Sub








13PAGE 15


13PAGE 14- 13 -15




15

Приложенные файлы

  • doc 26643813
    Размер файла: 395 kB Загрузок: 0

Добавить комментарий