Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the thesis template and structure #3

Merged
merged 18 commits into from
Jan 16, 2025

Conversation

dvdvgt
Copy link
Contributor

@dvdvgt dvdvgt commented Dec 16, 2024

  • Update the thesis template to use latex-mimosis as the documentclass.
  • Further, adjust the build process slightly by using just as a command runner instead of make.
  • Slightly change the structure of the thesis.
  • Include a short description of what should be included in each chapter.
  • Include a short guide for using the most common latex packages like tikz (drawing), listings (code listings), mathpartir (natural-deduction style judgements), figures, tables and citing.

Check out this PDF to see what the changes look like: thesis.pdf

@dvdvgt
Copy link
Contributor Author

dvdvgt commented Dec 16, 2024

The CI file might need to be adapted such the used fonts are available when building the PDF.

Copy link

@marvinborner marvinborner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

German parts like the Selbständigkeitserklärung should use the ngerman babel language, otherwise the line breaks are wrong (in your example PDF: sin-ngemäß)

@dvdvgt
Copy link
Contributor Author

dvdvgt commented Dec 16, 2024

Good catch, thanks!

Copy link
Contributor

@b-studios b-studios left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good, thanks @dvdvgt! Can we make it work for BSc and MSc theses?

src/evaluation.tex Outdated Show resolved Hide resolved
src/idea.tex Outdated Show resolved Hide resolved
src/idea.tex Outdated Show resolved Hide resolved
@@ -0,0 +1,3 @@
\chapter{Introduction}\label{ch:introduction}
In the introduction, you give context for your research, introduce your research question, and outline your work as well as motivate it.
It is also common to add a list of contributions, i.e., bullet points on what you contribute to the research area.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The introduction is one of the most important sections. Some things that could be explained here:

  • the "zooming in" aspect of an introduction: start from "computer science" zoom into the specific subfield (and motivate it), zoom into the topic at hand, etc.
  • the goal of the introduction is to most importantly answer the reader's questions "why should I care?", "what is the problem?", "how will solving it improve the state of the art?", "why should I trust the author on this?", "what are the specific contributions?"
  • for a BSc / MSc thesis it should be approachable by a non-expert (computer scientist, but not a PL researcher).

Copy link
Contributor

@jiribenes jiribenes Dec 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

though it might be controversial, I used something akin to the following:

The introduction should address the following key questions, ideally in the order stated below:
\begin{enumerate}
\item What is the nature of the problem this thesis investigates?
\item What are the current common approaches for solving this problem?
\item How does this thesis address the problem?
\item What are the results? What are the improvements?
\item What can the reader expect in the individual chapters of the thesis?
\end{enumerate}

The recommended length for the introduction is between 1 and 4 pages.
For longer introductions, consider dividing the content into unnumbered subsections with descriptive headings.
However, avoid extensive discussions of specific topics here; detailed content like definitions, theorems, methods, and data belongs in subsequent chapters.

src/overview.tex Outdated Show resolved Hide resolved
src/overview.tex Outdated Show resolved Hide resolved
@dvdvgt
Copy link
Contributor Author

dvdvgt commented Dec 17, 2024

Can we make it work for BSc and MSc theses?

What would this entail? Just changing the title page?

dvdvgt and others added 2 commits December 17, 2024 10:57
Copy link
Contributor

@jiribenes jiribenes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added some of what I had already based on the official template and on the few theses I supervised / wrote myself. I have much more wrt choosing the correct thesis type, etc., but I can't really put it into a review -- perhaps I should do that after you merge...

Also, the CI should work (but again, I can tackle that in a subsequent PR)

For reference, the "official" template is https://uni-tuebingen.de/de/140699

Makefile Outdated Show resolved Hide resolved
Comment on lines +136 to +149
\thispagestyle{empty}
\begin{otherlanguage}{ngerman}
\chapter*{Selbständigkeitserklärung}
Hiermit erkläre ich, dass ich diese schriftliche Abschlussarbeit selbständig verfasst habe, keine
anderen als die angegebenen Hilfsmittel und Quellen benutzt habe und alle wörtlich oder
sinngemäß aus anderen Werken übernommenen Aussagen als solche gekennzeichnet habe.

\vspace{1cm}
\noindent
\hrulefill \hspace{2.5cm} \hrulefill

\noindent
Ort, Datum \hfill Unterschrift
\end{otherlanguage}
Copy link
Contributor

@jiribenes jiribenes Dec 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had something like this based on the "official" template last year.

\thispagestyle{empty}
\section*{Selbständigkeitserklärung}

Hiermit versichere ich, dass ich die vorliegende \ThesisTypeGerman{}
selbständig und nur mit den angegebenen Hilfsmitteln angefertigt habe und dass alle Stellen, die dem Wortlaut oder dem
Sinne nach anderen Werken entnommen sind, durch Angaben von Quellen als
Entlehnung kenntlich gemacht worden sind.
Diese \ThesisTypeGerman{} wurde in gleicher oder ähnlicher Form in keinem anderen
Studiengang als Prüfungsleistung vorgelegt.

\vskip 3cm

Ort, Datum	\hfill Unterschrift \hfill

where ThesisTypeGerman is:

\def\ThesisTypeTitle{Bachelor Thesis}
% \def\ThesisTypeTitle{Master Thesis}
\def\ThesisTypeGerman{Bachelorarbeit}
% \def\ThesisTypeGerman{Masterarbeit}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I noticed that wording is different. I have directly copied it from the official thesis registration form since it was the most "official" one I could find.

src/title.tex Outdated Show resolved Hide resolved
@dvdvgt
Copy link
Contributor Author

dvdvgt commented Dec 18, 2024

new old
image image

(don't mind the alignment differences. This is because of manually screenshotting the PDFs. The vertical spaces stayed the same.)

src/introduction.tex Outdated Show resolved Hide resolved
Co-authored-by: Jonathan Immanuel Brachthäuser <[email protected]>
@jiribenes jiribenes merged commit 5a25fea into se-tuebingen:main Jan 16, 2025
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants