[класс] parsed-file

Аннотация

Класс, экземпляры которого представляют разбираемые файлы, которые "пропускаются" через компилятор.

Пакет

ystok.help

Надклассы

asd:dynamic-file

Подклассы

context-popup, parsed-html-file, text-topic

Описание

Класс parsed-file представляет препарированные автором файлы, которые подаются на вход компилятора:

• либо файл в гипертекстовом формате для книги помощи,
• либо текстовый файл регулярной страницы или контекстной подсказки, показываемой прикладной программой непосредственно (а не в браузере).

Данный класс "абстрактный" (в терминологии С++) или "примесь" (mixin в терминологии Лисп), т.е. непосредственно от экземпляры не порождаются, а порождаются от его подклассов.

Ключевые аргументы :option value

name

Имя целевого файла страницы: строка или символ; для символа берётся печатное имя и преобразуется в нижний регистр. Тип файла, если "html" желателен, может быть указан внутри name после точки.

pathname

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

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

Пример задания логического пути:
 :pathname #P"LIB:doc;settings;general.html"

title

Строка — альтернативный заголовок статьи, который будет помещен в оглавление вместе с гиперссылкой на данную статью. Элемент TITLE перекрывает значение этого аргумента.

description

Строка аннотации (краткого описания), которая будет высвечиваться в качестве всплывающей подсказки в оглавлении. Метаэлемент
 <МETA name="description" ...> перекрывает значение этого аргумента.