- •Уральского государственного технического университета
- •РАЗРАБОТКА ВСТРОЕННОЙ ПОМОЩИ
- •РАЗРАБОТКА ВСТРОЕННОЙ ПОМОЩИ:
- •ВВЕДЕНИЕ
- •1. СОЗДАНИЕ РАЗДЕЛОВ ПОМОЩИ
- •1.1. Использование сносок
- •1.2. Подготовка информации раздела
- •1.3. Создание ссылок на разделы помощи
- •2. СОЗДАНИЕ ПРОЕКТА И КОМПИЛЯЦИЯ ФАЙЛА ПОМОЩИ
- •2.1. Средства пакета Help Workshop
- •2.2. Структура файла проекта помощи
- •3. СОЗДАНИЕ ФАЙЛА ОГЛАВЛЕНИЯ ПОМОЩИ
- •4. РАЗРАБОТКА ПРИЛОЖЕНИЙ С КОНТЕКСТНОЙ ПОМОЩЬЮ
- •4.1. Вызов службы помощи
- •4.2. Использование макрокоманд
- •БИБЛИОГРАФИЧЕСКИЙ СПИСОК
- •ОГЛАВЛЕНИЕ
•для последующего изменения и добавления новых разделов в формируемые последовательности следует выбрать шаг нумерации 10 или вовсе не использовать номера. В последнем случае разделы просматриваются в порядке появления в файле помощи;
•если имеется всего одна последовательность, то рекомендуется использовать имя “auto” в качестве кода. Компилятор
сам построит нужную последовательность кодов в порядке появления разделов в файле.
Для управления включением или исключением некоторых разделов помощи при компиляции результирующего файла используется сноска Build tag (*). Содержимое текста сноски состоит из одного или нескольких имен, разделенных точкой с запятой. Используемые имена обычно связывают с версиями создаваемого файла помощи, например, определяющими язык написания (русский, английский и др.) или полноту файла помощи. При создании проекта помощи (задания на компиляцию) автор может указать в соответствующем разделе имена версий, включаемые в помощь. Все разделы, не имеющие сноски Build tag, всегда включаются в файл помощи.
Для задания макроса, исполняемого при открытии раздела, используется сноска Entry Macro (!). В этом случае последовательность макрокоманд, разделенных точкой с запятой, записывается как текст сноски в одну строку без символа «Enter». Синтаксис и семантика макросов будут обсуждаться ниже.
1.2. Подготовка информации раздела
Содержимое раздела может включать текстовую, графическую растровую (Bitmap), аудио- и видеоинформацию. Подготовка текстов полностью соответствует возможностям редактора MS Word. Разрешается использование разнообразных шрифтов, стилей и цветовых выделений. Текст может разбиваться на параграфы, содержать списки, формулы, таблицы. Следует учитывать, что при отображении таблиц служба помощи не поддерживает рисование линий границ между клетками и вокруг таблицы.
Для запрета переноса слов на новую строку при просмотре раздела необходимо установить для параграфа стиль «Запретить автоматический перенос слов». В этом случае при ширине строки, превышающей размеры окна, будет появляться полоса для горизонтальной прокрутки текста.
8
Для фиксации строк в верхней части окна при просмотре пользователем замещающего раздела и создания неперемещаемой области необходимо:
•убедиться в том, что фиксируемый параграф является первым в разделе;
•выделить параграф;
•установить для выделенного параграфа положение «Не отрывать от следующего» в диалоговом окне дополнительного
меню «Абзац».
При использовании фиксированных областей следует иметь в виду следующее ограничения:
•нельзя использовать фиксированные области для всплывающего раздела (Popup);
•при описании окна в проекте помощи можно задать различный цвет фона для фиксированной и перемещаемой частей окна;
•при использовании прозрачной картины в качестве фона окна все области отображаются одинаково.
Для вставки растрового изображения в раздел достаточно вос-
пользоваться стандартными средствами вставки в документ точечного рисунка из файла с расширением BMP, выполненного с использованием 16-цветовой палитры. Следует помнить, что служба помощи не поддерживает рисунки MS Word, и рисунки, выполненные с использованием 256-цветовой палитры, могут отображаться с искажением.
Если рисунок повторяется в файле помощи несколько раз, то для сокращения объема файла помощи целесообразно вместо рисунка вставить ссылку на него вида
{bmx filename.bmp}
где “x” – символы, определяющие следующие режимы: c – выравнивать картинку как символ текста;
l – выравнивать картинку по левой границе окна; r – выравнивать картинку по правой границе окна;
t – используется совместно с режимами выравнивания для заполнения белого фона рисунка пикселями фона окна. Это позволяет заменить белый фон окружения рисунка фоном окна, оставив без изменения содержательную информацию. Режим может использоваться только для 16-цветовой палитры рисунка. Например: {bmr schem.bmp}. Приведенная конструкция может располагаться в произвольном месте строки, указывая точку вставки рисунка. Допускается перечисление имен файлов через точку с запятой для вставки нескольких картинок.
9
Для добавления в текст раздела видео- и аудиоклипов используется предложение следующего вида:
{mci[_left | _right] [options,] filename}
Параметры предложения имеют следующий смысл.
Options задает режимы управления создаваемым мультимедийным окном и может принимать значения:
EXTERNAL |
– сохранять отдельно от файла помощи; |
NOPLAYBAR |
– не показывать средства управления просмот- |
|
ром (полезно для автоматического проигрыва- |
|
ния и повторения); |
NOMENU |
– не показывать меню в средствах управления |
|
просмотром; |
REPEAT |
– автоматическое повторение при проигрывании; |
PLAY |
– автоматическое проигрывание при видимом |
|
фрагменте раздела помощи. |
Filename задает имя и тип (обычно AVI, WAV, MIDI и т.д.) до-
бавляемого мультимедийного файла.
Если не заданы никакие режимы, то при появлении фрагмента текста в окне помощи выдается палитра инструментов для управления проигрыванием мультимедийного файла, и пользователь сам имеет возможно запускать и останавливать просмотр клипа. Например, следующий оператор создает мультимедийное окно управления и запускает файл demo.avi на исполнение:
{mci PLAY, demo.avi}
1.3. Создание ссылок на разделы помощи
Файлы помощи Windows организованы с использованием технологии гипертекста, когда раздел может включать ссылки для перехода к другим разделам. Служба помощи поддерживает два типа ссылок на разделы:
•вызов замещающего раздела;
•вызов всплывающего раздела.
Замещающий раздел показывается в текущем окне, откуда он вызван, и заменяет информацию, ранее отображаемую в окне. Всплывающий раздел показывается во вспомогательном окне, перекрывающем текущее окно. Всплывающее окно исчезает при нажатии любой клавиши на клавиатуре или кнопки мыши.
Для создания ссылки на раздел необходимо:
•поместить текст ссылки в произвольную строку раздела;
•далее без пробела поместить имя вызываемого раздела, определенное в сноске Topic ID;
10
•текст ссылки выделить двойным подчеркиванием для замещающего и одинарным подчеркиванием для всплывающего раздела;
•для имени раздела установить скрытый стиль шрифта. Дополнительно можно установить некоторые режимы отобра-
жения ссылок:
•для отображения ссылки без выделения зеленым цветом перед именем раздела необходимо поставить символ «звездочка» (*);
•для отображения ссылки без выделения зеленым цветом и без подчеркивания перед именем раздела необходимо поставить символ процента (%);
•для создания ссылки на раздел другого файла помощи за именем раздела необходимо поместить символ «эт» (@) и имя другого файла;
•для задания окна для отображения раздела после имени раздела необходимо поместить символ «больше» (>) и имя
окна, описанного в проекте помощи.
Пример организации раздела файла помощи со ссылками различного вида приведен на рис. 3.
# $ K Содержание
Главная форма*MainForm |
Описание формы |
Детальная формаDetalForm |
Настройка таблиц |
Режимы работы%PopupForm |
|
ПодробностиContents@NewHelp.hlp |
|
----------------------------------- Разрыв страницы----------------------------------- |
|
# Contents
$ Contents
K Содержание
Рис. 3. Оформление раздела файла помощи
При подготовке разделов помощи наиболее часто встречающаяся ошибка связана с некорректным использованием скрытого стиля для ссылок на другие разделы. Ошибка связана с тем, что после выделения имени раздела и установки скрытого стиля в конце имени раздела нажимается клавиша “Enter”, что приводит к созданию нового параграфа с наследуемым скрытым стилем. Если в дополнение к описанной ошибочной ситуации еще производится вставка разрыва страницы, то скрытый стиль переносится в начало следующего раздела, и обязательные сноски нового раздела оказы-
11