Initial commit
This commit is contained in:
commit
c534d5ce80
163 files changed
+11500
No files matched your search
@@ -0,0 +1,63 @@
|
||||
# Разработка шаблона Scientia
|
||||
|
||||
> Скрытая документация для сопровождающих Typst-библиотеки. Инструкции авторов находятся в публичном каталоге [`docs/`](../../../docs/README.md).
|
||||
|
||||
## Текущее устройство
|
||||
|
||||
Автор работает с единственным `main.typ`, каталогами `chapters/`, `assets/` и видимой документацией `docs/`. Внутренняя библиотека, профили организаций, тесты и архитектурные решения находятся в `.template/`.
|
||||
|
||||
Режим `final`, `draft` или `clean-copy` выбирается переменной внутри `main.typ`. Компилируемые публичные примеры четырёх видов документов и элементов оформления одновременно являются источниками для задачи выбора типа документа.
|
||||
|
||||
Обычная сборка использует векторные заглушки. Готовая папка `.private` подключается одним literal-переключателем в `main.typ`; отдельного ZIP installer и отдельной build task нет.
|
||||
|
||||
## Команды сопровождающего
|
||||
|
||||
```powershell
|
||||
# Пользовательский документ
|
||||
typst compile --root . main.typ document.pdf
|
||||
|
||||
# Полная регрессия
|
||||
python .template/development/tests/run-tests.py
|
||||
```
|
||||
|
||||
## Навигация
|
||||
|
||||
| Документ | Назначение |
|
||||
|----------|------------|
|
||||
| [PLAN.md](PLAN.md) | Завершённые фазы редизайна и проверки |
|
||||
| [ARCHITECTURE.md](ARCHITECTURE.md) | Структура, компоненты, data flow и режимы отказа |
|
||||
| [ADR-0001](adr/0001-typst-015.md) | Typst 0.15.1 как baseline |
|
||||
| [ADR-0002](adr/0002-data-and-assets.md) | Границы данных и ресурсов |
|
||||
| [ADR-0003](adr/0003-rendering-model.md) | Детерминированная модель выполнения |
|
||||
| [ADR-0004](adr/0004-error-handling.md) | Ошибки и media fallback |
|
||||
| [ADR-0005](adr/0005-ddd-boundaries.md) | Направление зависимостей |
|
||||
| [ADR-0006](adr/0006-visual-regression.md) | Визуальная регрессия |
|
||||
| [ADR-0007, устарел](adr/0007-author-workspace.md) | Историческое решение о трёх entrypoints |
|
||||
| [ADR-0008](adr/0008-vscode-onboarding.md) | Версионируемая рабочая область VS Code |
|
||||
| [ADR-0009](adr/0009-single-main-and-public-docs.md) | Один `main.typ`, публичные примеры и приватная сборка |
|
||||
| [ADR-0010](adr/0010-private-folder-and-employees.md) | Папка `.private`, справочник сотрудников и частичные подписи |
|
||||
| [Рабочее пространство автора](../modules/author-workspace.md) | Минимальный корень и один входной файл |
|
||||
| [Публичные примеры](../modules/starter-packs.md) | Четыре вида документов и каталог оформления |
|
||||
| [Публичная документация](../modules/user-documentation.md) | Видимый `docs/` для авторов |
|
||||
| [Рабочая область VS Code](../modules/vscode-workspace.md) | Расширения, задачи и настройки |
|
||||
| [Приватные ресурсы](../modules/private-assets.md) | Справочник сотрудников, `.private/settings.typ`, offsets и placeholders |
|
||||
| [Публичный фасад](../modules/facade.md) | Стабильный Typst API |
|
||||
| [Документ](../modules/domain-document.md) | Профили и режимы выпуска |
|
||||
| [Организация](../modules/domain-company.md) | Реквизиты и ресурсы компании |
|
||||
| [Стороны](../modules/domain-parties.md) | Адресаты, подписанты и стороны |
|
||||
| [Приложения](../modules/domain-attachments.md) | Приложения разных видов документов |
|
||||
| [Сборка](../modules/application-render.md) | Application orchestration |
|
||||
| [Ресурсы компаний](../modules/infrastructure-assets.md) | Загрузка публичных профилей и overrides |
|
||||
| [Основа вёрстки](../modules/presentation-foundation.md) | Tokens и media policy |
|
||||
| [Отчёт](../modules/presentation-report.md) | Renderer отчёта |
|
||||
| [Письмо](../modules/presentation-letter.md) | Renderer письма |
|
||||
| [ТКП](../modules/presentation-commercial-offer.md) | Renderer предложения |
|
||||
| [Договор](../modules/presentation-contract.md) | Renderer договора |
|
||||
| [Компоненты](../modules/components.md) | Таблицы, формулы и подписи |
|
||||
| [Ссылки](../modules/references.md) | Перекрёстные ссылки и библиография |
|
||||
| [Нумерация](../modules/numbering.md) | Стратегии нумерации |
|
||||
| [Тестирование](../modules/testing.md) | Static, compile, semantic и visual suites |
|
||||
|
||||
## Статус
|
||||
|
||||
Редизайн принят. Корневой и публичные примеры компилируются на Typst 0.15.1; полная тестовая матрица является release gate.
|
||||
Reference in new issue
Block a user