Merge pull request #11 from Orianti/develop

Release 2023-01-28 (v2.0.0)

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Лог изменений
+
+## 2.0.0 (2023-01-28)
+
+* Добавлена поддержка нескольких авторов для всех типов работ (https://github.com/Orianti/bmstu-latex-class/issues/6).
+* Исправлен заголовок титульной страницы научно-исследовательской работы.
+* Добавлено явное указание формата страницы (https://github.com/Orianti/bmstu-latex-class/issues/4).
+
+## 1.0.0 (2022-01-24)
+
+Первый релиз пакета.

README.md

@@ -2,56 +2,61 @@
 
 <a href='https://www.ctan.org/pkg/bmstu'>![Version shield](https://img.shields.io/ctan/v/bmstu)</a>
 <a href='https://www.latex-project.org/lppl/'>![License shield](https://img.shields.io/ctan/l/bmstu)</a>
-<a href='#'>![TestVKR build shield](https://img.shields.io/badge/TestVKR-build%20203-orange)</a>
+<a href='#'>![TestVKR build shield](https://img.shields.io/badge/TestVKR-build%20216-orange)</a>
 
-LaTeX-класс `bmstu` призван упростить создание отчетов и расчетно-пояснительных записок студентами МГТУ им. Н. Э. Баумана. Пакет, содержащий класс, размещен в CTAN и [**доступен для загрузки**](https://ctan.org/pkg/bmstu).
+LaTeX-класс `bmstu` призван упростить создание отчетов и расчетно-пояснительных записок студентами МГТУ им. Н. Э. Баумана. Пакет, содержащий класс, размещен в [CTAN](https://ctan.org/pkg/bmstu).
 
-К особенностям класса можно отнести:
-* генерацию титульных листов для всех основных типов работ — лабораторных, курсовых, научно-исследовательских, дипломных;
-* генерацию реферата с подсчетом количества объектов;
-* генерацию списков определений и сокращений;
-* генерацию других шаблонных элементов документа;
-* команды для упрощения работы с изображениями, листингами и пр.
+Особенности класса:
+* генерация титульных страниц для всех основных типов работ — отчетов, курсовых, научно-исследовательских, дипломных;
+* генерация реферата с подсчетом количества объектов;
+* генерация списков определений и сокращений;
+* генерация других шаблонных элементов документа;
+* команды для упрощения работы с изображениями и листингами.
 
-Сгенерированные файлы соответствуют [**требованиям МГТУ им. Н. Э. Баумана**](https://mf.bmstu.ru/info/uu/ot/norm_docs/docs/polozhenie_normcontrol_pril1.pdf) и [**ГОСТ 7.32-2017**](https://docs.cntd.ru/document/1200157208). Расчетно-пояснительные записки к выпускным квалификационным работам успешно проходят проверку программы TestVKR (сборка 203).
+Сгенерированные файлы соответствуют [требованиям МГТУ им. Н. Э. Баумана](https://mf.bmstu.ru/info/uu/ot/norm_docs/docs/polozhenie_normcontrol_pril1.pdf) и [ГОСТ 7.32-2017](https://docs.cntd.ru/document/1200157208). Расчетно-пояснительные записки успешно проходят проверку программы TestVKR (сборка 216).
 
-Примеры использования команд и окружений представлены в файлах [examples.tex](bmstu/examples/examples.tex) и [examples.pdf](bmstu/examples/examples.pdf). Приведены шаблоны для разработки [отчетов](templates/report/), [расчетно-пояснительных записок к курсовым работам](templates/coursework/), [отчетов по научно-исследовательским работам](templates/research/) и [расчетно-пояснительных записок к выпускным квалификационным работам](templates/thesis/).
+Примеры использования команд и окружений представлены в файлах [bmstu-examples.tex](bmstu/examples/bmstu-examples.tex) и [bmstu-examples.pdf](bmstu/examples/bmstu-examples.pdf). Приведены шаблоны для разработки [отчетов](templates/report/), [расчетно-пояснительных записок к курсовым работам](templates/coursework/), [отчетов по научно-исследовательским работам](templates/research/) и [расчетно-пояснительных записок к выпускным квалификационным работам](templates/thesis/).
 
 ## Установка
 
 Перед установкой класса убедитесь, что установлен один из дистрибутивов LaTeX.
 
-### Установка из CTAN
+### Автоматическая
 
-Так как класс размещен в CTAN, можно выполнить автоматическую установку пакета.
+Так как пакет размещен в CTAN, можно выполнить автоматическую установку.
 
-#### Linux (TeX Live)
+Например, для Ubuntu с дистрибутивом TeX Live:
 ```bash
 sudo tlmgr install bmstu
 ```
 
-### Ручная установка
+### Ручная
 
 Если по какой-то причине автоматическая установка невозможна, необходимо установить класс вручную. Для этого следует добавить пакет в texmf-дерево пользователя.
 
-#### Linux (TeX Live)
-
+Например, для Ubuntu с дистрибутивом TeX Live:
 ```bash
 git clone https://github.com/Orianti/bmstu-latex-class.git
 cd bmstu-latex-class/
 mkdir -p $(kpsewhich -var-value TEXMFHOME)/tex/latex/ && cp -R bmstu $_
 ```
 
+## Использование
+
+Для локальной разработки следует использовать компилятор PdfLaTeX и biber в качестве инструмента сборки библиографии. Использование bibtex вместо biber может привести к некорректному отображению ссылок.
+
+Также пакет доступен в онлайн-редакторе [Overleaf](https://www.overleaf.com).
+
 ## Вклад в разработку
 
-Если вы обнаружили некорректное поведение команд пакета, несоответствие требованиям, орфографические ошибки или опечатки и прочие недочеты, пожалуйста, создайте Issue. Там же вы можете оставить свои предложения для улучшения пакета. Также вы можете непосредственно поучаствовать в разработке, создав Pull Request.
+Если вы обнаружили некорректное поведение команд пакета, несоответствие требованиям, опечатки или прочие недочеты, пожалуйста, создайте Issue. Там же вы можете оставить свои предложения для улучшения пакета. Также вы можете непосредственно поучаствовать в разработке, создав Pull Request.
 
 ## Лицензия
 
-Файлы, перечисленные в `manifest.txt`, распространяются по лицензии [**The LaTeX Project Public License**](https://www.latex-project.org/lppl/).
+Файлы, перечисленные в [manifest.txt](bmstu/manifest.txt), распространяются по лицензии [The LaTeX Project Public License](https://www.latex-project.org/lppl/).
 
-Файл `bmstu-logo.pdf` является гербом МГТУ им. Н. Э. Баумана и защищен авторским правом. Распространяется по принципам свободного использования произведений (ст. 1274 ГК РФ).
+Файл [bmstu-logo.pdf](bmstu/bmstu-logo.pdf) является гербом МГТУ им. Н. Э. Баумана и защищен авторским правом. Распространяется по принципам свободного использования произведений (ст. 1274 ГК РФ).
 
 ---
 
-Copyright © Новиков М. Р., 2020–2022<br>
+Copyright © Новиков М. Р., 2020–2023

bmstu/README.md

@@ -1,21 +1,21 @@
 # bmstu package
 
-Release 2022-01-24 (v1.0.0)
+Release 2023-01-28 (v2.0.0)
 
 ## Overview
 
 The class defines commands and environments for creating reports and explanatory notes in Bauman Moscow State Technical University (Russia).
 
-Generated files correspond to [requirements of Bauman Moscow State Technical University](https://mf.bmstu.ru/info/uu/ot/norm_docs/docs/polozhenie_normcontrol_pril1.pdf) and [GOST 7.32-2017](https://docs.cntd.ru/document/1200157208). Explanatory notes to graduate qualification works are successfully tested by [TestVKR](https://vkr.bmstu.ru/) (build 203).
+Generated files correspond to requirements of Bauman Moscow State Technical University and GOST 7.32-2017. Explanatory notes to graduate qualification works are successfully tested by TestVKR (build 216).
 
 Please go to the official repository at https://github.com/Orianti/bmstu-latex-class to submit bug reports, request new features, etc.
 
 ## License
-This work (except `bmstu-logo.pdf`) is distributed under The LaTeX Project Public License.
+Files listed in manifest.txt are distributed under The LaTeX Project Public License.
 
-File `bmstu-logo.pdf` is a logo of Bauman Moscow State Technical University and complies with fair use (article 1274 of the Russian Civil Code).
+File bmstu-logo.pdf is a logo of Bauman Moscow State Technical University and complies with fair use (article 1274 of the Russian Civil Code).
 
 ---
 
-Copyright © 2020-2022 Mikael Novikov<br>
-All rights reserved.
+Copyright © 2020-2023 Mikael Novikov<br>
+All rights reserved.

bmstu/sty/bmstu-appendix.sty → bmstu/bmstu-appendix.sty

@@ -1,5 +1,5 @@
 %% bmstu_appendix.sty
-%% Copyright 2022 Mikael Novikov
+%% Copyright 2023 Mikael Novikov
 %
 % This work may be distributed and/or modified under the
 % conditions of the LaTeX Project Public License, either version 1.3

bmstu/sty/bmstu-biblio.sty → bmstu/bmstu-biblio.sty

@@ -1,5 +1,5 @@
 %% bmstu_biblio.sty
-%% Copyright 2022 Mikael Novikov
+%% Copyright 2023 Mikael Novikov
 %
 % This work may be distributed and/or modified under the
 % conditions of the LaTeX Project Public License, either version 1.3

bmstu/sty/bmstu-defabbr.sty → bmstu/bmstu-defabbr.sty

@@ -1,5 +1,5 @@
 %% bmstu_defabbr.sty
-%% Copyright 2022 Mikael Novikov
+%% Copyright 2023 Mikael Novikov
 %
 % This work may be distributed and/or modified under the
 % conditions of the LaTeX Project Public License, either version 1.3

bmstu/sty/bmstu-essay.sty → bmstu/bmstu-essay.sty

@@ -1,5 +1,5 @@
 %% bmstu_essay.sty
-%% Copyright 2022 Mikael Novikov
+%% Copyright 2023 Mikael Novikov
 %
 % This work may be distributed and/or modified under the
 % conditions of the LaTeX Project Public License, either version 1.3

bmstu/sty/bmstu-figure.sty → bmstu/bmstu-figure.sty

@@ -1,5 +1,5 @@
 %% bmstu_figure.sty
-%% Copyright 2022 Mikael Novikov
+%% Copyright 2023 Mikael Novikov
 %
 % This work may be distributed and/or modified under the
 % conditions of the LaTeX Project Public License, either version 1.3

bmstu/sty/bmstu-listing.sty → bmstu/bmstu-listing.sty

@@ -1,5 +1,5 @@
 %% bmstu_listing.sty
-%% Copyright 2022 Mikael Novikov
+%% Copyright 2023 Mikael Novikov
 %
 % This work may be distributed and/or modified under the
 % conditions of the LaTeX Project Public License, either version 1.3