Структура дисертації в LaTeX до того, як почнеться паніка
Вступні сторінки, підключення розділів, абревіатури, файли класів університету, швидкість компіляції та історія Git для магістрантів і аспірантів.
Дисертація — це довга стаття з бюрократією в комплекті. З довгою статтею LaTeX справляється добре. Бюрократія ж, як правило, живе у файлі класу університету, написаному у 2009 році й востаннє перевіреному на іншому TeX Live.
Закладайте структуру заздалегідь, навіть якщо розділи ще порожні. Переміщення вмісту між файлами в останній місяць — це те, від чого ламаються перехресні посилання й шляхи до рисунків.
Прийміть файл класу, огородіть решту
Покладіть в проєкт університетський .cls (і потрібні файли .bst та логотипів).
Не переписуйте клас. Свої макроси, пакети та вміст розділів тримайте у файлах,
які контролюєте ви:
thesis/ main.tex macros.tex chapters/ figures/ university.clsЯкщо клас ламається на сучасному рушії, розбирайтеся за допомогою
файлів класів університету, які не компілюються.
Задокументуйте, який рушій приймає відділ дисертацій (pdfLaTeX, XeLaTeX чи
LuaLaTeX), перш ніж вкладатися у fontspec.
Вступні сторінки, яких очікують комісії
Римські номери сторінок для анотації, присвяти, подяк, змісту, списків
рисунків і таблиць; арабські для основних розділів. Класи book і report мають
\frontmatter / \mainmatter; шаблонам на основі article потрібен ручний
\pagenumbering. Посібник:
спочатку римські, потім арабські.
Зміст титульної сторінки часто має збігатися зі зразком у Word від аспірантури. Копіюйте формулювання дослівно. Творчість тут призводить до того, що PDF відхиляє перевірка за контрольним списком.
Розділи як окремі файли
Один кореневий файл, багато підключених:
\include{chapters/intro}\include{chapters/background}\include{chapters/methods}\include{chapters/results}\include{chapters/conclusion}Відповідайте за розділи самі, навіть коли співавтори допомагають зі статтями, з
яких складається дисертація. Тримайте рисунки в figures/chapter3/, щоб шляхи
лишалися стабільними, коли ви змінюєте порядок. Під час написання використовуйте
\includeonly{chapters/methods}, щоб компіляція всієї дисертації не була ціною
за кожну правку рівняння:
розділення файлів розділів.
Мітки мають бути унікальними в усьому проєкті (eq:ch3-main, а не eq:main у
кожному файлі). Перегляд структури всього проєкту й перевірка посилань наживо
допомагають на дереві зі 200 сторінок.
Абревіатури та символи
Пакети глосаріїв потужні та вибагливі. Для багатьох дисертацій досить списку
символів, який ви ведете вручну, у вступній частині. Якщо потрібні абревіатури,
що розгортаються автоматично, відведіть день на вивчення glossaries-extra
задовго до тижня подання, а не під час нього.
Визначайте математичні макроси в macros.tex і ставтеся до цього файлу як до
спільного закону. Позначення, що розходяться між розділом 2 і розділом 5, —
подарунок для прискіпливого екзаменатора.
Бібліографія
Один .bib на всю дисертацію або невеликий набір, ретельно злитий докупи.
Стабільні ключі. Перевірте до друку в м’якій палітурці:
валідатор BibTeX. Відповідайте стилю, якого хоче
кафедра (числовий, «автор-рік», гуманітарні стилі з великою кількістю виносок).
Не змішуйте стеки biblatex і класичного BibTeX в одній преамбулі.
Швидкість
Компіляція всієї дисертації стає повільною. Чернетковий режим для рисунків,
\includeonly та externalize для TikZ повертають години. Нотатки:
коротше очікування PDF.
Щотижня влаштовуйте ритуал «повної компіляції», щоб рано бачити збої між розділами.
Резервна копія — це не історія
Копія в Dropbox — це резервна копія. Git — це розповідь про те, як змінювався аргумент. Робіть коміт, коли розділ компілюється. Надсилайте зміни у приватний віддалений репозиторій на GitHub або GitLab.
Oleafly (відкривається в новій вкладці) ініціалізує
справжній репозиторій для кожного проєкту, створює контрольні точки після
успішних компіляцій і під час пауз у редагуванні та відновлює одним
натисканням, а поруч — перегляд структури всього проєкту й SyncTeX, що й далі
працює між файлами розділів. Через це цю звичку важче пропустити. Таку саму
дисципліну можна мати в будь-якому редакторі за умови акуратної роботи з Git; дисертація не
повинна залежати від того, чи згадаєте ви виконати git init на вісімнадцятому
місяці.
Зворотний зв’язок від комісії
Експортуйте PDF для читачів, які не відкриватимуть вихідники. Відстежуйте коментарі в задачах або спільному документі, але вносьте правки в TeX. Коли член комісії повертає відсканований PDF із позначками, називайте файл з датою та версією, щоб знати, до якого коміту вихідників він належить.
Контрольний список для м’якої та твердої палітурки
Перед друком або здачею:
- Файл класу й рушій відповідають правилам відділу дисертацій.
- Нумерація сторінок вступної частини правильна; сторінка з підписами є, якщо її вимагають.
- Усі
\ref/\citeрозв’язуються; жодного[?]. - Списки рисунків і таблиць наведено, якщо їх вимагають; підписи узгоджені.
- Поля й розмір шрифту проходять контрольний список у PDF (надрукуйте пробну сторінку).
- Вихідники, PDF і хеш коміту заархівовано після здачі.
Рисунки, таблиці та сторінки зі списками
Багато відділів дисертацій вимагають список рисунків і таблиць. Підписи мають бути узгодженими й не вміщувати весь розділ про методи у 20-рядковому підписі. Використовуйте короткі назви для списків і довші пояснювальні підписи в тексті, якщо клас підтримує необов’язкові короткі підписи.
Плагіат і попередні публікації
Якщо розділи компонують уже опубліковані статті, дотримуйтеся правил університету щодо включення та дозволу співавторів. Зберігайте прийнятий PDF кожної попередньої статті та розділ дисертації під контролем версій із приміткою про те, що змінилося (позначення, розширені експерименти, єдиний вступ).
Почніть цього місяця, а не того, коли писатимете
Створіть каркас, коли пропонуєте план. Порожні розділи, що компілюються, — це вже прогрес. Здебільшого паніка на останньому етапі — це борг за структуру плюс норовливий файл класу, а не прогалина в науковій частині. Сплатіть цей борг рано.