Контекстная помощь
В первом случае будет выведена строка:
С помощью опции FileOpen можно загрузить файл.
Причем слово FileOpen будет выделено цветом и может использоваться как перекрестная ссылка на справку, заголовок темы которой имеет вид:
.topic FileOpen =…
Во втором случае в окне выводится строка:
Окно обеспечивает просмотр файла в режиме скроллера.
Слова просмотр файла выделяются цветом и используются как перекрестная ссылка на справку с заголовком:
.topic Viewer =…
В заголовке темы можно указывать несколько кодовых слов, например:
.topic FileOpen=3, OpenFile=103, FFileOpen Доступ к такой справке возможен для контекстов const chFileOpen = 3; chOpenFile = 103; chFFileOpen= 104;
Обратите внимание: за кодовым словом FFileOpen не указывается контекст, в этом случае считается, что связанный с ним контекст есть предыдущий контекст, увеличенный на 1, т.е.:
chFFileOpen = 103 + 1 = 104
Файл DEMOHELP.TXT содержит пример исходного текстового файла, подготовленного с учетом описанных требований для преобразования программой TVHC.PAS в файл справочной службы.
Подготовка справочного файла и его использование осуществляется в следующей последовательности.
- Подготавливается текстовый файл NAMETEXT, содержащий заголовки тем, справки и перекрестные ссылки.
- Вызывается программа TVHC.EXE (исходный текст этой программы содержится в файле \BP\EXAMPLES\DOS\TVDEMOS\TVHC.PAS) для создания файла справочной службы NAMEHELP и вспомогательного модуля NAMEPAS. Обращение к программе описано ниже.
- В программе, использующей средства модуля HelpFile:
- вызывается процедура RegisterHelpFile для регистрации объектов модуля HelpFile в потоке;
- открывается поток, связанный с созданным файлом NAMEHELP;
- создается экземпляр объекта THelpFile и ему передается поток и нужный контекст;
- инициируется работа созданного экземпляра;
- ликвидируется экземпляр объекта THelpFile.
Действия 3.б,…, 3,д осуществляются каждый раз, когда необходимо выдать ту или иную справку.
Для преобразования текстового файла во внутренний формат, используемый средствами модуля HelpFile, предназначена программа, исходный текст которой поставляется в файле TVHC.PAS. Перед использованием этой программы ее необходимо оттранслировать в ЕХЕ-файл. Формат вызова программы TVHC.EXE:
TVHC NAMETEXT [NAMEHELP [NAMEPAS]]
(В квадратных скобках указаны необязательные параметры). Здесь:
- NAMETEXT – имя исходного текстового файла,
- NAMEHELP – имя выходного файла справочной службы,
- NAMEPAS – имя выходного файла, содержащего текст модуля с контекстами в виде констант chXXXX.
Если имена выходных файлов опущены, будут созданы файлы с именем исходного файла и расширением HLP для файла справочной службы, PAS для текста модуля.
Текст файл NAMEPAS имеет следующий вид:
unit namepas; interface const chTopicl = nl; chTopic2 = n2; ….. chTopicN = nN; implementation end.
Поскольку этот файл создается программой TVHC.EXE автоматически, будьте внимательны при обращении к ней. Не рекомендуется опускать имена NAMEHELP и NAMEPAS: если имя исходного текстового файла совпадает с именем программы или любого другого PAS-файла, старый файл будет стерт и на его месте будет создан файл с текстом модуля!