Files
test/.template/development/modules/author-workspace.md
T
2026-10-09 04:24:38 +00:00

2.4 KiB

Модуль: Рабочее пространство автора

Ответственность: предоставляет один понятный входной файл и отделяет пользовательский текст от реализации.
Расположение: main.typ, chapters/, assets/, docs/

Публичный интерфейс

Элемент Тип Описание
main.typ entrypoint Компания, режим, metadata, ресурсы и порядок #include
document-mode строка final, draft или clean-copy
chapters/ каталог Текстовые разделы документа
assets/ каталог Рисунки, CSV/TSV, bibliography и другие материалы
docs/ каталог Публичная справка и компилируемые примеры

Зависимости

Модуль Что использует
.template/lib/index.typ Единственный Typst facade import
chapters/*.typ Явно перечисленное содержимое
assets/* Пользовательские paths
.private/settings.typ Только при явном use-private-assets = true

Инварианты

  • В корне существует только один Typst entrypoint main.typ.
  • Все ежедневные параметры и порядок глав видны в одном файле.
  • Режимы не представлены отдельными файлами.
  • docs/ не скрыт настройками VS Code.
  • Автор не обязан открывать .template/ для первого PDF.
  • Generated PDF и .private/ не попадают в Git.

Намеренно НЕ обрабатывает

  • Layout renderer и profile validation.
  • Разработку нового вида документа.
  • Хранение настоящих подписей.

Заметки для агента

Корень является пользовательским интерфейсом. Новый обязательный параметр добавляйте в main.typ и public examples с вариантом в комментарии. Не создавайте дополнительный entrypoint ради режима сборки.