ров необходимо использовать Word 95, для более поздних – Word 97 и далее.

Для разработки файла проекта, компиляции и создания оглавления можно использовать продукт Help Workshop, поставляемый вместе с Delphi, который можно найти в каталоге ...\delphi\help\tools\. Результатом работы пакета являются файл проекта с расширением HPJ, файл помощи с расширением HLP и файл оглавления с расширением CNT. Обычно имена всех файлов выбирают одинаковые. Располагают файлы в том же каталоге, где размещен основной проект приложения. При отсутствии Help Workshop создание файла проекта и оглавления можно выполнить в любом текстовом редакторе, например, в Notepad (Блокнот). Компиляцию можно произвести программой HC<n>.exe, где <n> – номер версии компилятора файлов помощи фирмы Microsoft.

Файл оглавления (.CNT) позволяет улучшить интерфейс пользователя помощи за счет иерархической упорядоченности разделов

иотображения их в виде вложенных деревьев.

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

1. СОЗДАНИЕ РАЗДЕЛОВ ПОМОЩИ

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

4

Для удобства работы при создании файла помощи необходимо настроить режимы и панели MS Word следующим образом:

•используя меню «Сервис/Настройка/Команды» добавить на панель инструментов из раздела «Формат» кнопки для выполнения одинарного и двойного подчеркиваний и установки скрытого стиля написания текста;

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

пользуя кнопку со значком .

Каждый раздел файла помощи оформляется как последователь-

ность строк текста и рисунков, заканчивающаяся жестким разделителем страниц (разрыв страницы). Первыми символами раздела должны быть сноски, служащие для идентификации раздела и его основных свойств. Сноски добавляются путем использования позиции меню «Вставка/Сноска» (рис. 2). Необходимо обратить внимание на то, что в

Рис. 2. Диалоговая форма для вставки сноски

предлагаемой форме следует задать режимы «обычная» и «другая», а в окне задать единственный символ сноски из числа приведенных в таблице. После нажатия кнопки «ОК» необходимо заполнить содержимое сноски, начиная с позиции, указываемой редактором. Строка сноски должна содержать требуемые идентификаторы и ключевые слова и не должна иметь в конце символа «Enter». Следует заметить, что обязательной является только сноска Topic ID (#), остальные включаются в текст при необходимости использования соответствующих функций и режимов работы пользователя с разделом. Обычно разработчики включают сноски Topic ID (#), Title ($) и Keyword (K) для использования раздела в поисковых службах помощи.

5

1.1. Использование сносок

Для добавления обязательной сноски Topic ID необходимо установить курсор в начало первой строки раздела, добавить символ сноски # средствами диалогового окна вставки сносок и написать имя раздела за символом сноски в конце страницы. При написании имени учитываются следующие требования:

•имя не должно содержать пробелов и символов кириллицы;

•нельзя использовать служебные символы (# = + @ * % !);

•имя должно содержать не более 255 символов;

•имя не должно начинаться с цифры.

Для возврата в начало формируемого раздела файла помощи достаточно за последним символом имени раздела нажать клавишу – «На строку вверх» . Имена разделов используются в гиперссылках внутри файла помощи и для связи номеров и имен разделов в секции «MAP» проекта.

Для добавления необязательной сноски Title необходимо установить курсор в начало первой строки раздела, добавить символ

6

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

•длина заголовка не должна превышать 255 символов;

•можно использовать все символы клавиатуры, включая кириллицу.

Для добавления необязательной сноски Keyword или A-Keyword необходимо установить курсор в начало первой строки раздела, добавить символ сноски K или A (верхний регистр латинской раскладки), используя диалоговое окно вставки сносок, и написать последовательность ключей за символом сноски в конце страницы. При написании ключей учитываются следующие требования:

•длина ключа не должна превышать 255 символов;

•можно использовать все символы клавиатуры, включая кириллицу;

•ключи разделяются символом «;»;

•нельзя использовать символ «Enter».

Для создания двухуровневых ключей (только для Keyword) ключ первого и второго уровня отделяется запятой; например, для создания структуры вида

«операция чтения записи обновления»

необходимо в строке сноски написать следующий текст:

операция; операция, чтения; операция, записи; операция, обновления

Все ключи сортируются по алфавиту, лидирующие и заключительные пробелы игнорируются.

Для планирования последовательностей просмотра разделов помощи с использованием кнопок «Следующий», «Предыдущий» можно использовать сноску Browse code (+). Текст сноски обычно составляют из двух частей: имя последовательности и номер в последовательности, например: Старт012. Длина сноски не должна превышать 50 символов. Нельзя использовать специальные символы (# = + @ * % !) или пробелы. При использовании последовательностей необходимо:

•добавить кнопку «Browse» в главное окно для просмотра помощи;

•при использовании номера раздела в последовательности необходимо добавить лидирующие нули;

7