[класс] topic

Аннотация

Класс, экземпляры которого представляют регулярные статьи, порожденные из исходных HTML-файлов.

Пакет

ystok.help

Надклассы

topic-mixin, parsed-html-file

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

index

Если есть nil или :none, то при компиляции предметного указателя данная статья будет исключена из рассмотрения.

Аргумент не оценивается. Если не задан, то подавить индексацию статьи можно, указав
  meta="ROBOTS" content="NOINDEX"
в самой исходном файле.

dump

Указание того, следует ли помещать в файл якорей определённые в данной статье якоря.
Умолчание: :parent.

Описание

Аргумент dump может принимать одно из следующих значений:

nil

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

t

Якоря из данной статьи будут сохранены в файле якорей.

:parent

Либо взять значение из слота dump объемлющего раздела, либо, для статьи верхнего уровня, из слота dump книги.