Работа с документами

Один файл настроек

В проекте используется только один входной файл — main.typ. В нём находятся данные документа, выбранный режим и порядок глав. Отдельные draft.typ и clean-copy.typ не нужны.

#let company-id = "scientia" // "scientia" | "technology" | "too"
#let document-mode = "final" // "final" | "draft" | "clean-copy"
#let use-private-assets = false // true, когда есть настроенная .private

final — выпускной документ; приватные подписи и печати показываются при use-private-assets = true;
draft — черновик с водяным знаком без реальных подписей;
clean-copy — чистая копия с зарезервированными местами для ручного подписания.

Виды документов

Вид	Когда использовать	Готовый исходник
Отчёт	Технический или научный отчёт с титулом, содержанием, источниками и приложениями	report/main.typ
Письмо	Исходящее письмо с адресатом, номером, подписью и перечнем приложений	letter/main.typ
ТКП	Предложение с составом работ, стоимостью, сроками и условиями оплаты	commercial-offer/main.typ
Договор	Стороны, представители, разделы, реквизиты и приложения	contract/main.typ

Самый простой способ выбора — задача VS Code Scientia: выбрать тип документа. Она заменяет main.typ и chapters/, предварительно сохраняя резервную копию в .private/starter-backups/.

Главы

Один крупный смысловой раздел удобно хранить в одном файле:

chapters/
├── 00-introduction.typ
├── 10-methods.typ
├── 20-results.typ
├── 30-discussion.typ
└── 90-conclusion.typ

Числовой префикс помогает видеть порядок в проводнике, но сам по себе ничего не подключает. Состав PDF задаётся внизу main.typ:

#include "chapters/00-introduction.typ"
#pagebreak()
#include "chapters/10-methods.typ"

Ресурсы

изображения — assets/images/;
библиография — assets/references.bib;
таблицы данных — assets/data/ или непосредственно assets/;
материалы конкретной главы можно хранить в подпапке с понятным именем.

Используйте прямые слеши: assets/images/section-2.png. Путь внутри главы считается относительно файла главы, поэтому из chapters/10-main.typ изображение обычно открывается как ../assets/images/example.png.

Как начать собственный проект

Выберите вид документа до начала больших правок.
Откройте main.typ и проверьте параметры сверху вниз.
Переименуйте или создайте главы.
Обновите список #include.
Замените учебные рисунки, таблицы и формулы своими данными.
Соберите PDF и сохраните законченную часть отдельным коммитом.

documents.md 4.1 KB 永久連結 文件歷史 原始文件