Files
Report-showcase/.template/development/modules/starter-packs.md
T
2026-10-09 01:45:17 +00:00

2.7 KiB

Модуль: Публичные примеры документов

Ответственность: хранит исполняемую документацию четырёх профилей и источник безопасной установки выбранного типа.
Расположение: docs/examples/

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

Каталог Назначение
documents/report/ Полный отчёт с главами, bibliography и appendix
documents/letter/ Деловое письмо
documents/commercial-offer/ Технико-коммерческое предложение
documents/contract/ Договор
formatting/ Каталог рисунков, таблиц, формул, ссылок и списков
private/settings.typ Безопасный полный пример private settings без PNG

Зависимости

Модуль Что использует
/.template/lib/index.typ Только публичный фасад
use-starter.ps1 Backup и копирование примера в корень
Presentation profiles Реальный layout каждого вида документа

Инварианты

  • Каждый main.typ компилируется непосредственно из своего каталога.
  • Тот же каталог компилируется после копирования в корень.
  • Каждый пример явно показывает company-id, document-mode, use-private-assets, profile metadata и media policy.
  • Public example не зависит от .template/development/.
  • Formatting guide содержит пояснения рядом с копируемыми блоками.
  • Выбор типа создаёт backup до замены пользовательских файлов.

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

  • Обратную совместимость со старыми starters.
  • Синхронизацию уже изменённого примера с пользовательским fork.
  • Юридическую корректность демонстрационного договора.

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

Не создавайте отдельную showcase-копию: публичный пример должен одновременно быть тестовым fixture и источником установки. Изменение API считается завершённым только после обновления всех четырёх main.typ и formatting guide.