Задание названия раздела
Название раздела используется в Help-службе следующим образом:
оно появляется после активизации опции закладка в главном меню Help-службы;
оно указывается в списке разделов диалоговых окон, связанных с кнопками поиск и хронология инструментальной панели справочного окна.
На рис. 21.3 показано окно поиск справочной службы Delphi.
Рис. 21.3. Окно Поиск со списком названий найденных разделов
Название раздела задается с помощью сноски "$", которая должна предшествовать первому символу текста раздела. На рис. 21.4 показан пример окна Word с названием Режим|0тладка для раздела Отладочный режим. Название раздела записывается в тексте сноски и отделяется от символа "$" одним пробелом. В тексте названия можно указывать любые символы, в том числе и пробелы. Максимальная длина названия - 255 символов. Обычно название раздела совпадает с его заголовком.
Рис. 21.4. Вставки названия раздела
Определение ключевых слов
Help-служба позволяет искать разделы по связанным с ними ключевым словам. В диалоговом окне Поиск (см. выше рис. 21.3) предусмотрены строка (1) для ввода ключевых слов и возможность выбора их из списка (2). Для любого раздела можно назначить сколько угодно ключевых слов и наоборот - с любым ключевым словом можно связать сколько угодно разделов.
Для определения ключевого слова в начале раздела (до первого символа текста раздела) ставится сноска, помеченная латинской буквой "К" или "k". Например: к открыть;текст файл;ASCII;текст
Все связанные с разделом ключевые слова помещаются в текст сноски и отделяются от "К" одним пробелом, а друг от друга символом ";". Группы связанных по смыслу ключевых слов объединяются во фразы, которые отделяются друг от друга пробелами. Help-служба ищет и отображает в списке выбора названия всех разделов, ключевые слова которых перечислены в одной фразе. Например, если для приведенной выше сноски пользователь ввел слово файл, будут представлены названия разделов, связанных со словами файл, ASCII и текст.
Помимо основной таблицы ключевых слов в Help-службе может быть определена дополнительная таблица. Слова из дополнительной таблицы не показываются в окне Поиск. Их использование возможно только вмакрокомандах ALink и TestALink (СМ. П. 21.7). Для вставки ключевых слов в дополнительную таблицу используется сноска, помеченная латинской буквой "А": А таблица/слово
Определение условий компиляции
Подобно директивам условной компиляции Delphi в RTF-файл можно вставлять указания Help-компилятору помещать или не помещать в результирующий файл тот или иной раздел. Такие указания могут понадобиться на этапе отладки справочной службы, а также при создании нескольких версий приложения (например, справочная служба демонстрационной версии может не содержать некоторые разделы, определенные для основной версии). Они вставляются в текст с помощью сноски, помеченной символом "*". Чтобы включить условный раздел в Help-файл или исключить его из файла, ключевое слово, определяемое сноской "*", должно указываться в секции соответственно include или Exclude файла проекта справочной службы (см. п. 21.4.1).
В тексте сноски "*" можно указать одно или несколько управляющих слов (следующие друг за другом слова в тексте сноски разделяются символом ";"). Раздел будет включен в Help-файл, если хотя бы одно из связанных с ним управляющих слов указано в секции include файла проекта (если раздел не имеет сноски "*", он всегда включается в результирующий файл). Управляющие слова могут содержать любые символы, кроме ";" и пробелов. Например:
Test_Build; AppVersionI; DebuggVer
Указание порядка просмотра связанных разделов
Связанные в некотором отношении разделы можно просматривать с помощью кнопок на инструментальной панели окна справочной службы. Связь разделов подразумевается создателем службы и может быть любая - по смысловой связанности, в алфавитном порядке, в порядке знакомства с программным продуктом и пр. Ниже представлен пример списка связанных разделов:
Файл | гл меню:005 | Новый | меню файл:005 | Открыть | меню файл:010 | Сохранить | меню файл:015 | Сохранить как | меню файл:020 | Печатать | меню файл:025 | Выход | меню файл:030 | Редактировать | гл меню:010 | Очистить | меню редак:005 | Вырезать | меню редак:010 | Копировать | меню редак:015 | Вставить | меню редак:020 | Отменить | меню редак:025 | Окно | гл меню:015 | Каскад | меню окно:005 | Мозаика | меню окно:010 | Закрыть все | меню окно:015 |
В этом списке каждой опции меню поставлена в соответствие комбинация символов (гл_меню: 010, меню_файл:025 и т. п.), определяющая порядковый номер просмотра раздела. Все разделы, помеченные соответствующими комбинациями, сортируются в обычном ASCII-порядке следования символов этих комбинаций. Таким образом, раздел Редактировать, помеченный гл_меню:010, будет следовать за Файл (гл_меню: 005), но предшествовать Окно (гл_меню: 015).
Чтобы связать с разделом код для указания порядка просмотра раздела, необходимо вставить сноску "+": гл_меню:010
Обычно в качестве кодовой последовательности выбирают общее название связанных разделов и цифры порядкового номера. Номера полезно задавать с некоторым шагом (в нашем пример шаг равен 5), чтобы была возможность вставлять дополнения в списки разделов и при этом не изменять уже существующие сноски.
Замечу, что кнопки просмотра связанных разделов появляются в справочном окне автоматически, только от одного факта указания сноски "+" в текущем разделе. Чтобы вставить их независимо от этого, нужно выполнить макрокоманду BrowsButtons. Если макрокоманда выполнена, а текущий раздел не связан ссылкой "+" с другими разделами, кнопки появятся, но будут запрещены для выбора.
1 2 3 4
8 8 8
| |