[класс]
chapter
Аннотация
Класс, экземпляры которого представляют разделы (главы) или подразделы.
Пакет
ystok.help
Надклассы
help-module-mixin, asd:module
Ключевые аргументы :option value
- name
- Имя раздела: строка или символ; для символа берётся
печатное имя и преобразуется в нижний регистр. В нём не допустимы пробелы,
буквы, кроме латинских, и другие специальные знаки. Разрешены
лишь литеры, соответствующие компоненту path спецификации URI.
- pathname
- Файловый путь к исходной папке,
откуда берутся препарированные автором файлы раздела.
- Стандартный аргумент ASDlite, не оценивается.
Если не задан, то в качестве значения принимается
относительный путь — подпапка name.
Если задан, путь должен указывать на папку (директорий), т.е. обязательным является конечный слэш,
прямой (/) или обратный (\). Путь может быть как абсолютным, так и относительным
— относительно исходной папки непосредственного родительского компонента.
Допустимо указывать логический путь.
- output-pathname
- Файловый путь к целевой папке,
куда компилятор поместит готовые файлы раздела.
- Аргумент не оценивается. Если не
задан, то в качестве значения принимается
относительный путь — подпапка name.
Если задан, путь должен указывать именно на папку (директорий), т.е. обязательным является конечный слэш,
прямой (/) или обратный (\). Путь может быть как абсолютным, так и относительным
— относительно целевой папки непосредственного родительского компонента.
Если есть ".", то файлы раздела будут размещены непосредственно
в родительской папке.
Допустимо указывать логический путь.
- start
- Имя компонента — начальной статьи.
Страница этой статьи (точнее, её нулевого сегмента) называется также
начальной страницей раздела.
Она будет помещена первой в линейном упорядочении всех страниц.
- Аргумент не оценивается. Если не задан, то в качестве значения принимается
первая в списке компонентов статья главы, т.е. типа
topic.
- dump
- Задаёт значение по умолчанию для слота dump статей данного раздела.
Умолчание: :parent
.
Описание
Экземпляры класса chapter
представляют разделы (главы) или подразделы.
Компонентами раздела могут, в свою очередь, быть подразделы, статьи, вспомогательные файлы
и папки. Порядок задания компонентов определяет линейную последовательность
статейных страниц. В эту последовательность вносят вклад все компоненты типа
topic.