Universe

Create project in app

Typst шаблон для быстрого автоматического оформления отчетов по стандартам Владивостокского Государственного Университета для кафедры ИТС.

Данный шаблон позволяет без MS Word (и следовательно без WYSIWYG) оформить работу (отчет, лабораторную, бакалаврскую, магистерскую) полностью в соответствии с требованиями действующего стандарта.

Возможности:

  • Используется простой текст в качестве исходника (git-friendly, LLM-friendly), можно использовать в командной работе
  • Не нужно думать об оформлении: шрифт, отступы и прочее - все контролируется шаблоном
  • Автоматическое оформление списка источников и контроль нумерации ссылок (bibtex)
  • Автоматический контроль нумерации рисунков, таблиц, формул
  • Поддержка многостраничных таблиц
  • Автоматическое оформление содержания (с поддержкой приложений и т.п.)

Как использовать

Установка typst

Для установки typst можно скачать его бинарный файл из официального репозитория и самостоятельно разместить в PATH.

Удобнее всего воспользоваться пакетным менеджером:

  • На Windows: winget install --id Typst.Typst
  • На MacOS: brew install typst
  • Или если стоит Rust: cargo install --locked typst-cli

Для корректной сборки в системе должны быть установлены шрифты Times New Roman и Arial. На Windows и MacOS они обычно уже есть. Если у вас Linux или другая система без этих шрифтов, их нужно скачать и установить отдельно.

Проверить установку можно командой:

typst --version

Сборка минимального отчета

Минимальный файл отчета (report.typ) может выглядеть так:

#import "@preview/carrot-vvsu-report:1.0.0": *

#show: vvsu.with()

#title-page(
  title: [Отчет по лабораторной работе],
  title2: [по дисциплине "Название дисциплины"],
  title3: [Название работы],
  department: vvsu-depart-its,
  members: (
    member(role: [Студент\ гр. ZZZ-YY-XX], name: [И.И. Иванов]),
    member(role: [Преподаватель], name: [П.П. Петров]),
  ),
)

= Заголовок

Текст отчета.

== Подраздел

Будущий текст отчета в подразделе.

#conclusion[
  В ходе выполнения работы...
]

Сборка PDF файла:

typst compile report.typ report.pdf

Чем это отличается от MS Word?

MS Word - это редактор класса What You See Is What You Get (WYSIWYG). Такие редакторы очень удобны тем, что вы сразу видите результат того, что редактируете.

За гибкость и удобство MS Word приходится расплачиваться проблемами контроля стилей, ссылок, интервалов, отступов и т.п. Также большинство инструментов по типу git и т.п. относятся к файлам .docx как к blob. Хотя и внутри XML (если убрать сжатие) - это все равно нереалистично использовать для командной работы и версионирования в git репозитории.

Typst - это компилятор (CLI инструмент), позволяющий собрать из файла с разметкой и правилами PDF файл любой сложности, с гарантией, что стиль везде будет одинаковый. Проще говоря: markdown на стероидах. Т.к. исходником является текстовый файл - с ним легко работать в любом редакторе и использовать с ним git, легко решать конфликты (если работают над одним файлом несколько человек).