Словарь терминов

Часть терминов в Docara остаётся английской: так они называются в файлах, полях настроек и сообщениях об ошибках. Здесь собраны такие слова с объяснением и ссылкой на страницу, где тема описана подробно.

Проект и настройки

Заготовка (template) — набор файлов, из которого docara init создаёт проект: minimal или showcase. См. «Заготовки и окружение».

Метаданные страницы (front matter) — блок между строками --- в начале Markdown-файла: заголовок, описание, метки и несколько других ключей. См. «Markdown».

Файл страницы (sidecar, <page>.page.json) — необязательный JSON-файл рядом с Markdown-страницей с настройками только этой страницы. См. «Сайт, раздел и страница».

Вид страницы (preset) — docs для документации с меню и содержанием или landing для лендинга без них. См. «Области макета».

Сброс ($reset) — ключ, который очищает унаследованную ветку настроек. См. примеры наследования и сброса.

Схема (schema) — JSON Schema, которой должен соответствовать файл настроек; поле schema в каждом файле называет её. См. «Схемы JSON».

Маршрут и slug — путь страницы на сайте. Маршрут по умолчанию повторяет путь Markdown-файла, slug в файле страницы задаёт другой. См. «Меню и разделы».

base_url и site_url — путь, под которым сайт размещён на сервере, и полный публичный адрес сайта. См. «Адрес сайта и поисковые системы».

Локаль (locale) — язык сайта, заданный тегом BCP 47, например ru, en или fr-CA. Запасная локаль (fallback) — язык, из которого берётся недостающая подпись интерфейса. См. «Мультиязычный сайт».

Перенаправление (redirect) — страница по старому адресу, которая ведёт на новый. См. «Перенаправления».

Компоненты и интерфейс

SIMAI Framework — библиотека интерфейса, из компонентов которой Docara собирает сайт. Её точная версия входит в пакет Docara.

Framework lock (simai-framework.lock.json) — файл закрепления: точная версия SIMAI Framework, описания компонентов и хеши файлов, которые использует сайт. См. «Файл закрепления Framework».

Manifest (описание компонента) — машиночитаемое описание Smart-компонента: параметры, состояния, шаблоны, ассеты и версия. По нему сборка проверяет вызов компонента. См. «Smart-компоненты».

Smart-компонент — самостоятельный элемент интерфейса с manifest, например ui.button или docara.navigation. См. «Smart-компоненты ui.*».

Типизированный компонент Docara (typed) — блок Docara с фиксированным синтаксисом и проверкой параметров, например :::card или :::steps. Inline-компонент — то же внутри строки текста, например :badge[...]. См. «Как устроены компоненты».

Native Markdown — обычная разметка Markdown без компонентов: заголовки, списки, ссылки, таблицы, код и сноски.

Статус компонента (lifecycle) — supported для доступных компонентов, admission_pending, framework_gap или deferred для ещё не допущенных. См. «Каталог компонентов».

Области макета (regions) — пять частей страницы: header, sidebar, main, outline и footer. Секция (section) наполняет область, блок (block) — секцию. См. «Области макета».

View Tree — проверяемое дерево разметки макета или секции: разрешённые теги, атрибуты и утилиты SIMAI Framework вместо произвольного HTML. См. «Композиция интерфейса».

Привязка данных (binding) — источник данных для Smart-компонента оболочки, например дерево меню для docara.navigation.

Atlas — список всех макетов, секций, блоков, представлений и привязок, доступных в проекте; его выводит docara atlas. См. «Композиция интерфейса».

Hero и Surface — первый экран лендинга и оформленная полоса вокруг части страницы. См. «Первый экран» и «Surface».

Сборка и проверка

Окружение сборки (environment) — имя после build, например local или production; результат пишется в каталог build_<окружение>. См. «Сборка сайта».

Квитанция сборки (receipt) — служебный файл рядом с результатом, в каталоге build_<окружение>.docara/: что и из чего собрано. Квитанции читают verify-static, build --page и inspect.

План страницы (resolved page plan) — итоговые настройки страницы после наследования с их источниками. См. «Схемы JSON».

Происхождение значения (provenance) — запись о том, какой файл задал каждое значение настроек. См. «Откуда пришло значение».

Composition Recipe и Composition Document — описание страницы, которое Docara передаёт сборщику SIMAI Framework, и готовое дерево страницы, которое он возвращает. См. «Архитектура».

verify-static — команда проверки готового каталога: страницы, ссылки и якоря, ассеты, поиск и квитанции. См. «Проверка сборки».

Fail closed — правило: при неверных данных сборка останавливается и не пытается угадать намерение автора. См. «Безопасность».

Хеш (SHA-256) — отпечаток содержимого файла. По нему сборка замечает, что файл изменился.

Разработка

Dry-run и применение по хешу (hash-bound apply) — сначала команда показывает план изменений и его идентификатор, затем применяет именно этот план; если входные файлы изменились, применение отклоняется. См. «SDK для разработчика и AI-агента».

Fixture (эталонный пример) — проверяемый пример вызова компонента, на котором тесты сравнивают результат.

SDK и MCP — команды для разработчиков и AI-агентов (inspect, schema, scaffold, validate, preview, test, qa) и необязательный адаптер, который открывает те же команды по протоколу MCP. См. «SDK для разработчика и AI-агента».