Index of /~baranovskyi/tex/vakthesis/support/mon2017dev/v0.03
README
mon2017dev, оформлення дисертації згідно з вимогами МОН, 2019/09/30 v0.03
КОРОТКИЙ ОПИС
=============
LaTeX-клас mon2017dev призначений
для підготовки дисертації згідно з Вимогами до оформлення дисертації,
затвердженими наказом Міністерства освіти і науки від 12.01.2017 № 40
(набрав чинності 10.03.2017),
https://zakon.rada.gov.ua/go/z0155-17
з урахуванням змін, внесених згідно з
наказом Міністерства освіти і науки від 31.05.2019 № 759
(зміни винятково юридичні, немає потреби змінювати LaTeX-клас).
Основні можливості:
-- оформлення титульного аркуша згідно з Вимогами,
-- підтримка анотації і списку ключових слів двома мовами,
-- повтор списку публікацій здобувача з анотації
у списку використаних джерел і в додатку,
-- повтор відомостей про апробацію зі вступу в додатку.
ЩО НОВОГО У ВЕРСІЇ 0.03
=======================
Додано:
-- Опцію класу type, яка дає змогу вибрати тип дисертації:
дисертація на здобуття ступеня кандидата/доктора ... наук (як раніше),
доктора філософії, доктора мистецтва чи доктора наук
(відповідно до Закону України «Про вищу освіту»).
-- Опцію класу instnameorder, яка дає змогу вибрати
порядок розміщення на титульному аркуші
назви установи і назви органу, до сфери управління якого належить установа:
низхідний, висхідний або висхідний з відмінюванням.
-- Дві різні команди \specialitysci і \specialityedu
для підтримки різних переліків спеціальностей:
«Переліку наукових спеціальностей»
і «Переліку галузей знань і спеціальностей,
за якими здійснюється підготовка здобувачів вищої освіти»
відповідно.
Разом з опцією type (див. вище) це дає змогу зробити
різні варіанти титульного аркуша й анотації для різних типів дисертації.
Клас означує команду \speciality як одну з вказаних вище команд
залежно від типу дисертації.
Факультативні аргументи команд тепер можна задавати у форматі ключ=значення.
Змінено:
-- Переписано команди, які мають бути доступні двома мовами,
таким чином, що вони мають додатковий аргумент, який задає мову:
\author(uk){Сорокіна Наталія Володимирівна}
\author(en){Sorokina Nataliya Volodymyrivna}
Тепер зручніше використовувати аналогічні команди для різних мов поряд,
ніж у попередньому варіанті з віддаленими оточеннями uk і en.
І механізм \captions (з пакунка babel) тепер не потрібен
для підтримки команд, доступних двома мовами.
-- Переписано команди \institution і \council таким чином,
що факультативні аргументи можна задавати у форматі ключ=значення.
Це дає змогу уніфікувати ці дві схожі команди і спрощує використання.
-- Переписано оточення для анотації і команду для ключових слів
таким чином, що вони тепер форматуються на місці,
а не копіюються і переносяться (засобами пакунка environ).
Так з ними зручніше працювати.
Крім того, це дає можливість уникнути деяких технічних проблем,
породжених копіюванням і перенесенням.
Змінено оформлення анотації:
тепер анотація кожною мовою, а також список публікацій здобувача
має свій заголовок (рівня \chapter) і починається з нової сторінки.
Оточення abstract отримало факультативний аргумент,
у якому у форматі ключ=значення можна задати
мову анотації,
інший заголовок розділу (наприклад, «Резюме» замість «Анотація»),
а також вимкнути автоматичну генерацію опису дисертації.
-- Файл відповідності шифру і назви спеціальності тепер має формат CSV
(comma-separated values -- значення, розділені комою).
Підготовано заготовки (тобто додано кілька значень для прикладу)
для «Переліку наукових спеціальностей»
і «Переліку галузей знань і спеціальностей,
за якими здійснюється підготовка здобувачів вищої освіти»
українською і англійською мовою.
Для роботи з CSV-файлами використовується пакунок datatool.
-- Внесено деякі дрібні зміни в оформлення титульного аркуша:
Напис «Кваліфікаційна наукова праця на правах рукопису» вирівняно
по лівому краю всередині рамки, вирівняної по правому краю сторінки
(тепер це має такий вигляд, як у зразку з Вимог).
Команда \manuscriptname, яка задає цей текст,
тепер позбавилася аргументу, яким можна було напис розбивати на рядки.
Не мати аргументів -- природно для такого типу команд,
а розбиття на рядки тепер визначається шириною рамки.
Напис «Подається на здобуття наукового ступеня...»
тепер відірвано від наступного тексту (він тепер в окремому абзаці)
і вирівняно по центру сторінки.
Він не пов'язаний з наступним текстом і не мав би бути з ним в одному абзаці,
але оформлення в попередній версії було спричинене
моїм неправильним розумінням нечіткого зразка у Вимогах.
Рядок з підписом автора відсунуто від попереднього тексту,
щоб було більше місця для підпису.
Виправлено вади:
-- Переписано команду \supervisor без використання лічильника @supervisors@count.
Це розв'язує проблему, що виникла в попередній версії,
з некоректним підрахунком наукових керівників різними мовами,
який спричиняв неправильні написи «Науковий керівник»/«Наукові керівники».
-- Додано типове означення команди \cyrdash (з пакунка babel-ukrainian)
на випадок, якщо поточна версія цього пакунка не містить такого означення.
Це має розв'язати проблему з використанням кириличного тире ("---)
в англійському середовищі
для версій пакунка babel-ukrainian, раніших за 1.4b від 2017/08/10.
(Ольга Свинчук і Вадим Коротєєв незалежно повідомили про цю проблему.)
-- Додано означення команд \@Asbuk і \@asbuk.
Це розв'язує проблему з неможливістю використовувати оточення enumerate
з класами vakthesis/mon2017dev,
спричинену тим, що означення цих команд
вилучені з babel-ukrainian, починаючи з версії 1.4 від 2017/06/10.
(Василь Черлінка повідомив про цю проблему:
https://linux.org.ua/index.php?topic=689.msg201933#msg201933)
Документація:
-- Короткий опис класу з переліком можливим труднощів,
який у попередній версії був у файлі mon2017dev.cls,
винесено в окремий файл README (цей файл)
і доповнено інформацією про встановлення і використання.
Файли-приклади:
-- Анотацію винесено в окремий файл mon2017dev-abs.tex,
який підключається в головному файлі дисертації mon2017dev.tex.
ЗВАНТАЖЕННЯ
===========
Найновішу версію mon2017dev можна отримати за адресою
https://www.imath.kiev.ua/~baranovskyi/tex/vakthesis/support/mon2017dev/
Потрібні файли:
README (цей файл)
mon2017dev.cls LaTeX-клас mon2017dev
specsci*.{uk,en}.csv файли відповідності шифру і назви спеціальності
specedu*.{uk,en}.csv (для різних переліків спеціальностей і різними мовами)
mon2017dev.tex приклад головного файла дисертації
mon2017dev-abs.tex приклад анотації
mon2017dev-intro.tex приклад вступу до дисертації
mon2017dev-bib.tex приклад списку використаних джерел
mon2017dev-app1.tex приклад додатку зі списком публікацій
та відомостями про апробацію
mon2017dev.pdf приклад головного файла дисертації
(попередньо згенерований PDF-файл)
Можна звантажити всі вказані файли одним архівом:
mon2017dev-0.03.zip
ЗАЛЕЖНОСТІ
==========
Це допоміжний LaTeX-клас (надбудова над класом vakthesis).
Тому він працює тільки разом з vakthesis:
викликає цей клас, а потім переозначує потрібні команди.
Набір класів і пакунків LaTeX vakthesis доступний за адресою
https://www.imath.kiev.ua/~baranovskyi/tex/vakthesis/
Для підтримки кількох мов в одному документі
потрібен пакунок babel,
що доступний за адресою
CTAN:macros/latex/required/babel
Для створення команд і опцій класу з інтерфейсом ключ=значення
потрібен пакунок xkeyval,
що доступний за адресою
CTAN:macros/latex/contrib/xkeyval
Щоб переносити вміст оточення з однієї частини документа в іншу,
потрібен пакунок environ,
що доступний за адресою
CTAN:macros/latex/contrib/environ
Це використовується, щоб повторити відомості про апробацію зі вступу в додатку.
Навіть якщо користувач не зважає на можливості автоматизації
(вручну робить повтори),
клас mon2017dev все одно викликає цей пакунок,
а отже, він має бути встановлений у системі.
Для означення команд з модифікаторами (uk), (en) тощо
потрібен пакунок suffix,
що доступний за адресою
CTAN:macros/latex/contrib/bigfoot
Для роботи з CSV-файлами
потрібен пакунок datatool,
що доступний за адресою
CTAN:macros/latex/contrib/datatool
Для відмінювання назв установ
потрібен пакунок casus,
що входить до складу набору класів і пакунків vakthesis
(тобто якщо встановлено vakthesis, то встановлено і casus).
Пакунок babel, найімовірніше, уже встановлений у вашій системі.
Решту пакунків можна встановити (якщо вони ще не встановлені)
засобами менеджера пакунків вашого дистрибутиву TeX
або засобами менеджера пакунків операційної системи.
У користувача є потреба безпосередньо працювати хіба що з babel.
Решту пакунків викликає клас без участі користувача.
ВСТАНОВЛЕННЯ
============
Варіант 1
---------
1. Помістити файли туди, де TeX може їх знайти, наприклад:
mon2017dev.cls, spec*.*.csv -> TEXMF/tex/latex/vakthesis/mon2017dev/
README -> TEXMF/doc/latex/vakthesis/mon2017dev/
mon2017dev*.{tex,pdf} -> TEXMF/doc/latex/vakthesis/mon2017dev/example/
Тут TEXMF позначає кореневий каталог (локального) дерева texmf.
2. Оновити базу імен файлів.
Варіант 2
---------
Помістити файли mon2017dev.cls, spec*.*.csv у той самий каталог,
де лежать файли дисертації.
ВИКОРИСТАННЯ
============
Викликати, як стандартний клас документа:
\documentclass{mon2017dev}
Звернути увагу, які команди й оточення використовуються для задання
назви дисертації, імені здобувача тощо
(див. файли прикладів mon2017dev*.tex).
АВТОРСЬКЕ ПРАВО І ЛІЦЕНЗІЯ
==========================
Copyright 2018, 2019 Олександр М. Барановський (Oleksandr M. Baranovskyi)
This work may be distributed and/or modified under the
conditions of the LaTeX Project Public License, either version 1.3
of this license or (at your option) any later version.
The latest version of this license is in
http://www.latex-project.org/lppl.txt
and version 1.3 or later is part of all distributions of LaTeX
version 2005/12/01 or later.
This work has the LPPL maintenance status `author-maintained'.
[Приблизний переклад українською:
Цю роботу можна розповсюджувати і/або модифікувати за
умовами публічної ліцензії проекту LaTeX, або версії 1.3
цієї ліцензії, або (на ваш розсуд) будь-якої пізнішої версії.
Найновіша версія цієї ліцензії є на
http://www.latex-project.org/lppl.txt
і версія 1.3 або пізніша є частиною всіх дистрибутивів LaTeX
версії 2005/12/01 або пізніших.
Ця робота має LPPL-статус підтримки «підтримується автором».]
МОЖЛИВІ ТРУДНОЩІ
================
Вимоги до оформлення дисертації виписані не дуже чітко.
Інколи незрозуміло, що і як треба запрограмувати.
Деякі речі просто ще не реалізовані.
Тому користувачі мають знати про можливі труднощі.
1.+Якщо установа, де здійснювалася підготовка здобувача
і установа, де проводився захист дисертації, -- та сама установа,
то як писати на титульному аркуші?
Повторювати двічі?
Писати назву установи, де здійснювалася підготовка здобувача?
Писати назву установи, де проводився захист дисертації?
(Вони однакові, але треба запрограмувати, аргумент якої команди брати.)
Аналогічна ситуація з анотацією.
Але, крім того, в п. 2 Вимог написано, що в анотації також вказуються
«найменування вищого навчального закладу або найменування наукової установи,
у якому (якій) здійснювалася підготовка;
найменування наукової установи або найменування вищого навчального закладу,
у спеціалізованій вченій раді якої (якого) відбудеться захист»,
а в зразку анотації (додаток 2) вказано тільки одну установу
(де здійснювалася підготовка).
На мій погляд, повторювати двічі ту саму інформацію -- неприродно.
Серед дисертацій, які я переглянув, є такі, де не повторюють.
Але, наприклад, науково-консультаційний центр
Київського національного університету імені Тараса Шевченка
пропонує дисертантам «Вимоги до оформлення дисертації»:
http://scc.univ.kiev.ua/upload/iblock/ebf/Vymogy.docx
(це копія наказу МОН, але з деякими локальними вставками),
де на титульному аркуші двічі написано:
Київський національний університет імені Тараса Шевченка
Міністерство освіти і науки України
хоча в анотації повторів немає.
У нинішній версії класу команда \institution задає
назву установи, де здійснювалася підготовка здобувача,
а обов'язковий аргумент команди \council задає
лише шифр спеціалізованої вченої ради.
Тобто припускається, що раду створено в тій самій установі
(і немає потреби писати ще раз назву установи).
Але ця команда має ще й факультативний аргумент,
у якому у форматі ключ=значення можна задати
назву установи, де створено раду
(тобто назву установи, де проводиться захист дисертації).
Тоді на титульному аркуші й в анотації буде написано обидві установи.
За бажання користувач може тут вказати ту саму установу,
що й в аргументі команди \institution,
і отримати повтор, як у Вимогах КНУ.
Якщо ж не використовувати факультативний аргумент команди \council,
то на титульному буде тільки назва установи, задана командою \institution.
Це логічно, раніше на титульному аркуші дисертації писали якраз
назву установи, де здійснювалася підготовка здобувача,
а на титульному аркуші автореферату --
назву установи, де проводиться захист дисертації.
2.+Оскільки у зразку титульного аркуша дисертації спочатку згадано
найменування вищого навчального закладу або наукової установи,
а потім -- органу, до сфери управління якого належить заклад, установа,
може, треба у такому порядку й писати?
Інститут педагогіки
Національної академії педагогічних наук України
а не
Національна академія педагогічних наук України
Інститут педагогіки
Текст наказу і зразок не вказують чітко, у якому порядку писати назви.
Чому в зразку вони згадуються у такому (незвичному) порядку, незрозуміло.
Наприклад, у формі обкладинки атестаційної справи
здобувача ступеня доктора філософії,
затвердженої наказом Міністерства освіти і науки від 22.04.2019 № 533
(https://zakon.rada.gov.ua/go/z0474-19#n16),
вказано інший порядок:
Підпорядкування
Найменування закладу вищої освіти (наукової установи),
в якому відбувся захист дисертації
У дисертаціях, які я переглянув, пишуть по-різному.
Тому в нинішній версії класу додано опцію instnameorder,
яка дає змогу вибрати порядок розміщення на титульному аркуші
назви установи і назви органу, до сфери управління якого належить установа.
3.+Мабуть, потрібна підтримка «Переліку наукових спеціальностей»
(https://zakon.rada.gov.ua/go/z1133-11)
і «Переліку галузей знань і спеціальностей,
за якими здійснюється підготовка здобувачів вищої освіти»
(https://zakon.rada.gov.ua/go/266-2015-п).
Незрозуміло, що треба використовувати:
у зразку титульного аркуша дисертації йдеться про галузь знань,
але у зразку анотації наведено і наукову спеціальність,
за якою проводиться захист дисертації,
і спеціальність, за якою здійснюється підготовка здобувачів вищої освіти.
У згаданій вище формі обкладинки атестаційної справи
здобувача ступеня доктора філософії
уже чітко написано, що треба вказувати код і найменування спеціальності
відповідно до Переліку галузей знань і спеціальностей,
за якими здійснюється підготовка здобувачів вищої освіти,
а також галузь знань за цим переліком.
Тому я зупинився на такому варіанті:
для дисертації на здобуття ступеня доктора філософії
(а також інших ступенів, передбачених Законом України «Про вищу освіту»:
доктора мистецтва і доктора наук)
природно вказувати на титульному аркуші
код і найменування спеціальності, а також галузь знань
за відповідним переліком для здобувачів вищої освіти
(саме це, ймовірно, і передбачає зразок у Вимогах).
Але нині ще захищають дисертації люди, які почали підготовку раніше.
Вони здобувають ступінь кандидата чи доктора, скажімо, фізико-математичних наук.
Для таких дисертацій природніше писати на титульному аркуші
шифр і назву спеціальності за відповідним переліком наукових спеціальностей
і не писати відповідну галузь науки
(навіть якщо це формально ніби й суперечить Вимогам).
Бо нижче пишеться:
Подається на здобуття наукового ступеня
кандидата/доктора фізико-математичних наук.
Тому видається надлишковим ще й після спеціальності писати:
Фізико-математичні науки.
У дисертаціях бачив по-різному (бо зразок у Вимогах незрозумілий):
на титульному аркуші пишуть шифр і назву спеціальності за одним переліком,
а нижче -- за другим;
або шифр і назву спеціальності за одним переліком,
а нижче -- галузь знань за другим.
На мій погляд, обидва варіанти нелогічні.
Перший, бо те, що науковий ступінь кандидата фізико-математичних наук
згідно із законодавством прирівнюється до ступеня доктора філософії,
не означає, що дисертант, який пройшов підготовку на кандидата наук,
після захисту здобуває ступінь доктора філософії.
Логічніше припустити,
що в зразку анотації написано два варіанти в одному рядку:
для кандидата наук і для доктора філософії.
Для відповідної дисертації треба вибрати один з варіантів.
Другий, бо один перелік ніяк не пов'язаний з іншим юридично
(це також можна сказати і про перший варіант).
Звісно, логічно пов'язати, скажімо, спеціальність «Математичний аналіз» в одному
і галузь знань «Математика і статистика» в іншому переліку.
Але це тільки особиста думка.
Якщо я правильно розумію,
коли всі «старі» кандидати і доктори наук захистяться,
«Перелік наукових спеціальностей» більше не будуть використовувати взагалі.
Тому в нинішній версії класу є дві команди:
\specialitysci і \specialityedu
для відповідних переліків спеціальностей.
А також додано опцію класу type у форматі ключ=значення,
що дає змогу вибрати тип дисертації.
Подробиці див. у файлі mon2017dev.tex.
4.+Команди, що задають інформацію для титульного аркуша, яка не залежить від мови,
треба писати за межами оточень uk, en тощо
(чи оточень otherlanguage з параметрами ukrainian, english тощо).
Це, наприклад, команда \udc;
код УДК однаковий для українського і англійського тексту.
Якщо ці команди розмістити всередині вказаних оточень,
то цю інформацію не буде передано до \maketitle
і її не буде на титульному аркуші.
(Ольга Свинчук повідомила про це.)
Це не велике обмеження,
бо немає потреби задавати такі команди по-різному для різних мов.
Але у майбутньому треба зробити безпечну обробку таких ситуацій
(принаймні повідомлення про помилку для користувача).
У нинішній версії класу команди, які мають бути доступні двома мовами,
переписані так, що механізм \captions (з пакунка babel)
і оточення uk, en (оточення otherlanguage з параметрами ukrainian, english)
не використовуються,
а отже, цієї проблеми вже немає.
5. Немає підтримки розбиття списку публікацій здобувача на групи:
-- праці, в яких опубліковані основні наукові результати дисертації;
-- праці, які засвідчують апробацію матеріалів дисертації;
-- праці, які додатково відображають наукові результати дисертації.
Взагалі кажучи, не сказано явно,
що публікації треба ділити на такі групи і явно позначати такий поділ.
Важливо, щоб саме в такій послідовності.
Справді, у п. 13 Вимог написано:
«Вказуються наукові праці автора у послідовності,
наведеній у пункті 4 розділу ІІІ цих Вимог»
За потреби можна робити це вручну.
Можливо, якісь спеціалізовані пакунки будуть працювати з цим класом
(bibtopic тощо)?
6. Незрозуміло, навіщо тричі повторювати список публікацій здобувача:
-- в анотації після ключових слів (п. 4 Вимог);
-- у списку використаних джерел (п. 9);
-- в окремому обов'язковому додатку до дисертації (п. 13).
Як посилатися на публікації здобувача у тексті дисертації?
У п. 9 Вимог сказано, що в дисертації має бути
«зроблено посилання на всі наукові праці здобувача, наведені в анотації».
Тоді у списку публікацій здобувача після анотації має бути окрема схема нумерації
(наприклад, додати до номера букву «а», що клас vakthesis дозволяє зробити),
щоб посилання на них не плуталися з посиланнями на використані джерела.
Крім того, «список цих праць має також міститися у списку використаних джерел».
Але тоді у списку використаних джерел будуть джерела,
на які немає посилань у тексті.
Бо не можна посилатися одночасно на те саме джерело у одному й другому списку.
Намагаючись надати якогось смислу цим незрозумілим вимогам,
я вирішив, що посилання в тексті мають бути на список використаних джерел
(читачу зручніше працювати з посиланнями на один список, а не на три).
А списки публікацій після анотації і в додатку мають довідковий характер,
тому на них немає посилань у тексті.
Щоб уникнути певних технічних проблем,
пов'язаних з повторним згадуванням тих самих джерел (multiply-defined labels),
я переозначив команду \bibitem в анотації та в додатку так,
що вона тільки генерує мітку, але не дозволяє посилання на неї.
Мені траплялися дисертації, де навіть чотири списки публікацій здобувача,
тобто в анотації -- двічі:
українською -- після анотації українською,
англійською -- після анотації англійською.
Але, на мій погляд, це дивне трактування Вимог:
анотація в дисертації одна (але кілька варіантів різними мовами),
тому й список публікацій здобувача після анотації має бути один.
Справді, у тексті Вимог скрізь ідеться про «анотацію», а не «анотації».
7. Сподіваюся, клас сумісний
з рекомендованими стилями оформлення списку наукових публікацій
(він не містить нічого навмисно, що могло би привести до несумісності).
Але тестування класу проводилося
тільки з BibTeX-стилем Springer MathPhys Style
(виявилося, що клас з ним сумісний).
Тестування з іншими BibTeX-стилями не проводилося.
8. Список використаних джерел може бути
в кінці кожного розділу основної частини дисертації.
Поки що немає (можливо, ніколи й не буде) підтримки для цього.
Не перевіряв, чи клас сумісний зі спеціальними пакунками LaTeX для цього.
9. «Дисертацію друкують на одному або на двох (за бажанням) боках аркуша»
(додаток 4 до Вимог).
Немає якоїсь спеціальної підтримки для цього.
Не перевіряв, чи працюватимуть стандартні засоби LaTeX (oneside, twoside).
10. Не рекомендовано поки що використовувати клас для документів,
у яких головна мова -- не ukrainian (а english чи інша).
Виникають незрозумілі проблеми, для розв'язання яких потрібно більше часу.
До того ж, ще не всі службові слова перекладено
(тільки ті, що використовуються в анотації).
Але у Вимогах немає зразка анотації англійською мовою,
тому мені не було на що орієнтуватися.
11. Можливо, клас не працюватиме із XeLaTeX, LuaLaTeX і polyglossia.
Бо для підтримки кількох мов використовуються засоби babel.
Але тестування класу в такій ситуації не проводилося.
Механізм \captions (з пакунка babel) уже не використовується
у нинішній версії класу.
Але застереження залишається,
якоїсь спеціальної підтримки для XeLaTeX, LuaLaTeX і polyglossia не передбачено.
КОНТАКТНА ІНФОРМАЦІЯ
====================
Повідомлення про помилки і пропозиції нових можливостей, будь ласка,
надсилайте супровіднику:
Олександр Барановський
ombaranovskyi at gmail dot com
![[ICO]](/icons/blank.gif){kind=icon}
![[PARENTDIR]](/icons/back.gif){kind=icon}
![[ ]](/icons/hand.right.gif){kind=icon}
![[ ]](/icons/compressed.gif){kind=icon}
![[ ]](/icons/tex.gif){kind=icon}
![[ ]](/icons/unknown.gif){kind=icon}
![[ ]](/icons/layout.gif){kind=icon}
![[TXT]](/icons/text.gif){kind=icon}