[класс] text-topic

Аннотация

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

Пакет

ystok.help

Надклассы

topic-mixin, parsed-file

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

toc-level

Целое число, большее, 1 или nil.

use-templates

Одно из значений: nil, t или :braces.
Умолчание: значение аргумента :use-templates, заданное в определении книги.

Описание

Аргумент toc-level задаёт уровень данной статьи в оглавлении книги. По умолчанию статья помещается в соответствии с уровнем сегмента (Cам текст заголовка может быть указан при помощи аргумента. :title.)

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

Аргумент use-templates может принимать одно из следующих значений.

nil

Исходный файл статьи является "плоским" текстовым файлом, который попросту копируется в целевую папку книги или раздела;

t

Исходный файл статьи является шаблоном, т.е. может содержать псевтотеги; к содержимому файлов будет применена функция html-template:fill-and-print-template. Шаблонные выражения в фигурных скобках не допускаются.

:braces

Исходные файл является шаблоном и в нём допустимы шаблонные выражения в фигурных скобках вида
 {выражение}.

Если в определении книги использование шаблонов вовсе запрещено, т.е. указано
 :use-templates nil,
то в текстовых статьях разметка шаблонов также игнорируется независимо от значения use-templates.

Технология шаблонов YHTML-Template применима не только к HTML-файлам, но и к произвольным текстовым файлам. Разумеется, якоря из таких файлах не извлекаются.