Шаблон документов Scientia

Готовая рабочая область Typst для отчётов, писем, технико-коммерческих предложений и договоров. Для повседневной работы нужен один файл настроек — main.typ, текст в chapters/ и материалы в assets/.

Что находится на виду

Элемент	Что с ним делать
`main.typ`	Выбрать компанию и режим, заполнить реквизиты, подключить главы
`chapters/`	Писать основной текст документа
`assets/`	Хранить рисунки, таблицы, CSV и библиографию
`docs/`	Читать инструкции и открывать готовые примеры

.template/, .private/ и .vscode/ являются служебными и скрыты в проводнике VS Code. Документация для разработчика шаблона также скрыта и не смешивается с инструкциями автора.

Первый запуск

Установите Visual Studio Code, Git и Typst 0.15.1 или новее.
В VS Code выберите Файл → Открыть папку и откройте корень проекта.
Установите предложенные расширения или откройте Extensions (Ctrl+Shift+X), введите @recommended и нажмите Install Workspace Recommended Extensions.
Откройте main.typ и запустите Typst Preview через Ctrl+Shift+P.

Автосохранение уже включено. Изменения текста появляются в предпросмотре примерно через 700 мс.

Начало нового документа

По умолчанию открыт пример полноценного отчёта. Для другого типа:

Нажмите Ctrl+Shift+P.
Выполните Tasks: Run Task / Задачи: выполнить задачу.
Выберите Scientia: выбрать тип документа.
Выберите report, letter, commercial-offer или contract.

Предыдущие main.typ и chapters/ автоматически сохраняются в локальной .private/starter-backups/.

Настройка одного `main.typ`

В начале файла находятся три основных переключателя:

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

Отдельных файлов для черновика и чистой копии нет. После переключателей последовательно заполните исполнителей, источники, приложения и параметры выбранного документа.

Главы подключаются внизу main.typ обычными строками:

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

Чтобы добавить, убрать или переставить главу, измените только список #include.

Приложения отчёта хранятся отдельными файлами в chapters/appendices/. В main.typ достаточно перечислить их пути; название и метка находятся в самом файле, а номера А, Б, В назначаются автоматически. Подробный пример: приложения отчёта.

Рисунки, таблицы, формулы и ссылки

Корневой пример отчёта уже содержит:

обычный рисунок и рисунок из нескольких панелей;
таблицу с настраиваемыми столбцами;
отдельную и встроенную формулы;
автоматическую нумерацию и ссылки в тексте;
библиографию и приложение.

Расширенный каталог с пояснениями находится в руководстве по оформлению. Исходник можно открыть и собрать отдельно: docs/examples/formatting/main.typ.

Сборка PDF

Нажмите Ctrl+Shift+B или запустите задачу Scientia: собрать PDF. Будет создан document.pdf.

В Typst Typewriter также доступны две кнопки: быстрый экспорт автоматически формирует имя PDF из названия отчёта, этапа и тома, а экспорт с настройками позволяет выбрать входной .typ, имя и папку результата.

Через терминал выполняется та же команда:

typst compile --root . main.typ document.pdf

Подписи и печати

Без папки .private оставьте use-private-assets = false: чистый форк собирается без ошибок. Для печати и подписи организации используются безопасные заглушки, а у отсутствующей подписи сотрудника остаётся пустая строка.

Для выпуска с реальными изображениями:

Скопируйте полученную папку .private в корень проекта с заменой.
В main.typ поменяйте одну строку: #let use-private-assets = true.
Пользуйтесь обычным предпросмотром и задачей Scientia: собрать PDF.

В .private/settings.typ хранятся доступность изображений и индивидуальные смещения подписей. Состав исполнителей и их роли меняются понятными строками в main.typ. Подробная структура: приватные данные.

Git в двух словах

Commit — контрольная точка с объяснением изменений.
Branch — отдельная версия для главы или набора правок.
Pull — получить изменения коллег.
Push — отправить свои контрольные точки на сервер.
Merge — объединить работу веток.

Пошаговая инструкция для сотрудников без опыта программирования: Git для авторов документов.

Публичная документация

Тема	Ссылка
Полная навигация	Документация пользователя
Виды документов и главы	Работа с документами
Таблицы, рисунки, формулы и ссылки	Руководство по оформлению
Все компилируемые примеры	Каталог примеров
VS Code, расширения и предпросмотр	Настройка VS Code
Коммиты, ветки и merge	Git для авторов
Подписи, печати и смещения	Приватные данные
Редактирование технического текста	Подсказка по стилю
Типовые проблемы	Решение проблем

Документация разработки шаблона предназначена только для сопровождающих: .template/development/docs/README.md.

8.6 KiB Raw Permalink Blame History Unescape Escape