Skip to content

Latest commit

 

History

History
73 lines (58 loc) · 7.11 KB

README.md

File metadata and controls

73 lines (58 loc) · 7.11 KB

ВНИМАНИЕ

Этот репозиторий больше не поддерживается, более актуальная преамбула лежит на официальном GitHub факультета.

Цель

Цель данного проекта покончить с мучениями связанными с оформлением записок к дипломным проектам в соответствии с требованиями БГУИР. Способ достижения цели - создание шаблона структуры проекта для LaTeX с преамбулой, настроенной под соблюдение требований к оформлению записок. Документ в соответствии с которым настраивается оформление документа: СТАНДАРТ ПРЕДПРИЯТИЯ. ДИПЛОМНЫЕ ПРОЕКТЫ (РАБОТЫ). ОБЩИЕ ТРЕБОВАНИЯ СТП 01—2013.

Рекомендации

  • Рекомендуемый дистрибутив LaTeX для Windows MiKTeX.
  • Рекомендуемый редактор Sublime Text 2 вместе с менеджером пакетов и установленным пакетом LaTeXTools и PDF просмотрщиком SumatraPDF.
  • Рекомендуемые справочные пособия по вопросам связанным с LaTeX: Bing, Google, Yandex и книги.
  • Рекомендуемая программа для ведения библиографической базы данных: JabRef
  • Инструкция по установке русского Times New Roman из пакета pscyr находится здесь
  • Если возникли проблемы с pscyr, то можно переключиться на использование scalable-cyrfonts-tex, с которым также могут быть проблемы при установке, но их проще решить (см. Wiki→Возникающие-ошибки)

Установка

Docker

На DockerHub лежит образ со всем готовым.

  • пуллим image
docker pull sixnine/latex_bsuir
  • поднимаем контейнер, монтируя репозиторий в контейнер:
docker run --name {имя контейнера} -v {путь к локальному репозиторию}:/latex -it sixnine/latex_bsuir

например,

docker run --name latex -v /Users/vadimkozlov/dev/latex_bsuir:/latex -it sixnine/latex_bsuir
  • теперь можно собирать проект через make, подключаться к контейнеру из VSCode через Dev Containers, настраивать любимые расширения (Latex Workshop завести у меня не получилось, если получится - допиши в ридми, открой пулрик :) )

Vagrant

Если у вас возникли проблемы с установкой и настройкой латеха на Windows или Linux, то вы можете воспользоваться виртуальной машиной для vagrant, которая сразу готова к сборке проекта (предполагается использование scalable-cyrfonts-tex, а не pscyr).

  • установить vagrant (рекомендуем версию 1.7 или выше)
  • зайти в каталог с проектом и выполнить команду vagrant up (дождаться загрузки образа виртуальной машины из сети)
  • выполнить команду vagrant ssh
  • можно приступить к сборке проекта (команды make, make clean и т.д.)

Linux, Ubuntu (TeX Live)

Windows (MiKTeX)

  • см. выше список рекомендаций
  • раскомментировать строку \input{fonts_windows} в файле preamble.tex (и закомментировать строку \input{fonts_linux})

Пример

В качестве примера приведены моя пояснительная записка к дипломному проекту example_diploma.pdf и преддипломной практике example_practice.pdf.

Дальнейшее развитие

Проект будет развиваться по мере необходимости внесения изменений и обнаружения несоответствий требованиям. Помощь в доработке шаблона приветствуется.

Примечание

Многое, наверное, сделано некрасиво и не правильно с точки зрения LaTeX, но я пока новичок и только учусь. Первоначальная компиляция проекта может занять некоторое время, т.к. должны установиться пакеты, используемые в preamble.tex. Для диагностики неисправности рекомендуется посмотреть генерируемый log файл или запустить компиляцию из командной строки с помощью pdflatex.

Помощь

Описания назначений файлов можно прочитать в вики.

UPD

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