Создание файла документа справочной информации

Файл документа справочной системы представляет собой RTF-файл определенной структуры. Создать RTF-файл справочной информации можно, например, при помощи Microsoft Word. Сначала нужно набрать текст разделов справки, оформив заголовки разделов одним из стилей Заголовок, например, Заголовок1. При этом текст каждого раздела должен находиться на отдельной странице документа (заканчиваться символом "разрыв страницы").

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

При написании текста раздела лучше использовать обычные системные шрифты (например, MSSansSerif), т.к. у пользователя может не оказаться нужного шрифта. В текст можно включать также таблицы, рисунки и кнопки.

Разделы могут содержать так называемые горячие области: выделенные слова или кнопки, позволяющие пользователю переходить из данного раздела в другие. Можно определить прямой переход на заданную тему, переход с помощью макроса KLink, который предлагает пользователю выбор из разделов, в К-сносках которых встречаются заданные ключевые слова, и с помощью макроса ALink, практически идентичного KLink, но берущего ключевые слова из A-сносок.

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

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

В текст раздела можно добавлять изображения в виде файлов bmp, dib, wmf, shg, mrb (командой Вставка / Рисунок). Если изображение используется в нескольких местах, то экономичнее использовать следующие команды:

· {bmcИмя_файла}-позиционирует изображение также как обычные символы, следующий за изображением текст продолжается в той же строке;

· {bmlИмя_файла}-позиционирует изображение у левого края страницы и текст обтекает его справа;

· {bmrИмя_файла}-позиционирует изображение у правого края страницы и текст обтекает его слева.

Можно добавить в текст кнопки, нажимая которые пользователь будет запускать тот или иной макрос. Это делается командой {button Надпись, Список_макросов}. Надпись будет отображаться на изображении кнопки. Список_макросов содержит вызов макросов с указанием нужных параметров. Если макросов несколько, то они разделяются двоеточием.

Пример. Команда {button См. также, Klink(Меню)}создаст кнопку с надписью «См. также», при нажатии на которую появится окно Найденные разделы, где будет показан список разделов, содержащих в своих К-сносках текст «Меню».

После того, как текст разделов будет набран, нужно, используя сноски, пометить заголовки разделов справочной информации (сноски используются компилятором справочной системы в процессе преобразования RTF-файла в HLP-файл). Сноски должны располагаться перед названием раздела.

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

Рис. 2. Диалоговое окно Сноски.

В результате в документ будет вставлена сноска #, и в нижней части страницы рядом со значком сноски следует ввести идентификатор помечаемого раздела справки (рис. 3). В качестве идентификатора можно использовать аббревиатуру заголовка раздела справки или сквозной номер раздела, поставив перед ним, например, буквы Ti (TopicIdentifier). Однако лучше, чтобы идентификатор раздела справки начинался с префикса IDH_. В этом случае во время компиляции RTF-файла будет проверена корректность ссылок: компилятор выведет список идентификаторов, которые перечислены в разделе [MAP] файла проекта, но которых нет в RTF-файле.

Сноска #

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