Как выстроить диссертацию в 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 и считайте этот файл общим законом. Обозначения, которые «плывут» между второй и пятой главой, — подарок придирчивому оппоненту.

Библиография

Один .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 каждой прежней статьи и главу диссертации под контролем версий с пометкой о том, что изменилось (обозначения, расширенные эксперименты, единое введение).

Начните в этом месяце, а не когда придёт время писать

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

Все записи