3. Создание текстовых файлов

Вся справочная информация помещается в один или несколько текстовых файлов в формате RTF. Для их создания может использоваться любой текстовый редактор, поддерживающий этот формат.

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

• Количество RTF-файлов может быть произвольным. Вы можете поместить всю справочную информацию в один файл или предусмотреть для каждого раздела отдельный файл — все зависит от объема и структуры справочной службы, а также ваших личных пристрастий.

• В пределах одного файла каждый раздел отделяется от другого служебным символом конца страницы (в Word этот символ вставляется нажатием клавиш Ctrl+Enter).

• Любой раздел, доступный с помощью перекрестных ссылок или индексных указателей, должен иметь связанный с ним идентификатор — уникальную текстовую строку.

• Раздел может иметь название и связанный с ним список ключевых слов.

Управляющие символы, которые включаются в текстовый файл, представлены в табл. 75.

Таблица 75.

Управляющие символы

Символ	Описание
Сноска #	Указывает идентификатор раздела
Перечеркнутый или дважды подчеркнутый текст	Определяет отображение связанного с текстом раздела (перекрестной ссылки) в стандартном справочном окне

1	2
Подчеркнутый текст	Определяет отображение раздела перекрестной ссылки в окне пояснений («всплывающем» окне)
Скрытый текст	Определяет идентификатор раздела, связанного с перекрестной ссылкой
Сноска $	Задает название раздела
Сноска К	Указывает список ключевых слов для поиска раздела
Сноска +	Задает порядковый номер раздела в списке просмотра связанных разделов
Сноска А	Определяет условие компиляции раздела
Сноска >	Определяет тип дополнительного окна, в котором будет отображаться раздел
Сноска !	Указывает макрокоманду, которая будет выполняться при открытии окна с разделом

3.1. Задание идентифицирующей строки и организация перекрестных ссылок

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

Идентифицирующая строка может содержать любые символы, кроме #, @, !, *, =, >, % и пробелов. Разница в регистре латинских букв (но не кириллицы!) игнорируется. Длина строки — до 255 символов. В качестве идентификаторов имеет смысл использовать текст заголовка раздела, заменив в нем пробелы символами подчер­кивания, — в этом случае вам не придется вспоминать идентификатор при ссылке на него.

Идентификатор задается с помощью сноски # в самом начале раздела. Например:

# Назначение^программы

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

Рис. 89. Пример задания перекрестных ссылок

Как показано на рисунке, раздел Перекрестные ссылки связан с идентификатором HYPER, который задан в виде текста сноски #, предшествующей первому символу заголовка (для задания сноски выберите в главном меню Word команду Вставка > Сноска, в окне Сноски установите переключатель Другая и введите символ # в поле 1, 2, 3). В тексте раздела указаны две перекрестные ссылки в виде слов ССЫЛКА и ГИПЕРТЕКСТ. Эти слова выделены соответственно дважды подчеркнутым и пере­черкнутым шрифтом, но в окне справочной службы они будут выглядеть одинако­во: выделены зеленым цветом и подчеркнуты одной линией. Сразу за каждой ссылкой следует идентификатор соответствующего раздела. Поскольку идентификатор выделяется скрытым текстом, в обычном режиме он скрыт и появляется только в режиме отображения служебных символов после щелчка на кнопке Непечатаемые символы инструментальной панели Word.

Для задания скрытого текста в редакторе Word необходимо выделить текст, воспользоваться командой Формат > Шрифт и в группе Эффекты открывшегося диалогового окна установить флажок Скрытый.

Поскольку эту последовательность действий при написании текста справочной службы придется выполнять очень часто, полезно предварительно настроить Word. Для этого выберите команду Сервис > Настройка, в открывшемся диалоговом окне перейдите на вкладку Команды, в списке Категории выделите пункт Все команды и перетащите мышью (нажав и не отпуская левую кнопку) пункт Hidden из списка Команды на инструментальную панель, где он превратится в кнопку. После этого щелкните на кнопке Закрыть в окне Настройка. Теперь, чтобы ввести скрытый текст, достаточно выделить его и щелкнуть на новой кнопке. Для задания перечеркнутого или дважды подчеркнутого текста нет специальной команды, поэтому автоматизировать соответствующие действия нужно с помощью макроса. Чтобы создать макрос, сначала выделите текст, затем выберите команду Сервис > Макрос > Начать запись, в окне Запись макроса введите подходящее имя (например, Зачеркнутый) и щелкните на кнопке Панели, затем из окна Настройка перетащите имя макроса на инструментальную панель и закройте окно. Теперь указатель мыши будет иметь вид кассеты с лептой, а на экране появится соответствующая панель управления. Выберите команду Формат > Шрифт > Зачеркнутый и остановите запись макроса щелчком на левой кнопке панели управления или с помощью команды Сервис > Макрос > Остановить запись.

Любой вызываемый раздел может отображаться в основном окне справки или в окне пояснений. Это окно появляется поверх основного окна (такие окна иногда называют «всплывающии») и обычно используется для пояснений (рис. 90).

Рис. 90. Пример использования окна пояснений

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

Для проверки работы ASI-шиныASI и связанных с ней датчиков…

В выделенную скрытым текстом часть ссылки можно вставить следующие до­полнительные управляющие символы:

• * — отменяет выделение текста ссылки цветом;

• % — отменяет выделение текста ссылки цветом и подчеркиванием;

• @ — указывает Help-файл, в котором находится нужная тема;

• > — указывает тип окна для отображения раздела.

Символы * и % вставляются непосредственно перед идентификатором раздела и так же, как и он, оформляются скрытым текстом. Например:

ГИПЕРТЕК%HYPER

Теперь в справочном окне слово ГИПЕРТЕКСТ ничем, кроме формы расположенного над ним указателя мыши, не будет отличаться от обычного текста справки; тем не менее, щелчок на нем вызовет переход к теме HYPER. В ссылке можно указать только один из символов отмены выделения — * или %.

Символы @ и >, наоборот, вставляются в конце скрытого текста, и за ними должны следовать:

• маршрут доступа и имя Help-файла — для символа @;

• имя типа окна, в котором следует отобразить раздел — для символа >; это окно должно определяться в файле проекта (см. ниже подтему «Секция Windows» в теме «Разработка проектного файла»).

Например, если раздел HYPER расположен в файле C:\PROBA\PROBA.HLP и должен показываться в дополнительном окне типа WIND, соответствующая ссылка будет такой:

ГИПЕРТЕКСТHYPER@C:\PROBA\PROBA.HLP>WIND

Обратите внимание: символы @ и >, как и следующие за ними символы маршрута и имени окна, должны оформляться скрытым текстом. Если, как в приведенном примере, в ссылке одновременно указываются и маршрут, и тип окна, порядок их следования безразличен, однако в одной ссылке можно указать только один символ @ и (или) один символ >. Имя окна нужно указывать прописными буквами, даже если в файле проекта оно определено строчными.