[класс]
book
Аннотация
Класс дескрипторов готовых книг помощи.
Пакет
ystok.help
Надклассы
book-mixin
Ключевые аргументы инициализации
- :title
- Название книги, фигурирующее в меню
Помощь
Обычно то же, что и у разрабатываемой книги помощи.
- :location
- Спецификация папки готовой книги помощи
на компьютере пользователя. Может быть задан как в виде абсолютного файлового пути,
так и относительного — в последнем случае он сливается со значением переменной
*default-book-pathname*.
- :external-format
- Внешний формат
файлов книги — спецификация кодировки букв и кодировки перехода на новую
строку. Если не указан, вычисляется исходя из
компьютерной платформы и установок операционной системы.
Описание
Экземпляр класса book является
дескриптором готовой книги помощи.
Во время исполнения прикладной программы он помогает переадресовать
поступающие от пользователя запросы помощи к нужным страницам книги.
Дескриптор создаётся ещё при сборке прикладной программы,
а во время её исполнения переводится в полностью рабочее состояние в результате
загрузкой компилированного
файла якорей.