krono/swathesis

An unofficial LaTeX class for writing theses at the Software Architecture Group, Hasso-Plattner-Institut, University of Potsdam, Germany.

swathesis

A LaTeX class for writing theses at the Hasso-Plattner-Institut, University of Potsdam, Germany. It has often been used at the Software Architecture Group.

This package consists of

• The swathesis class
• Supporting style files
• The swth script for managing swathesis directories

Usage

Simply say

swth create

and after a few questions, you are rewarded with a nice thesis template.

You can easily compile and your LaTeX file with

swth go

or care for individual steps with

swth latex
swth bibtex
swth show

A swth managed bachelor’s thesis is meant to be multipart, and so you can add an additional author to it via

swth author

That are the simple cases. swth --help has more information.

Installation

Use the install script like

./install.sh [--help …]

or use

./tdsify.sh

to generate a TDS compatible package for manual installation.

Requirements

swathesis needs, among others,

• The HPITR class
• The KOMA-Script bundle by Markus Kohm
• The uni-titlepage package by Markus Kohm
• A current microtype version
• A current fontaxes package for microtype
• A current acronyms or glossaries package

See DEPENDS.txt for an exhaustive list of requires packages

Contents

.
├── README.md             — This file
├── LICENSE.txt           — The LPPL
├── DEPENDS.txt           — List of necessary packges
├── install.sh            — Installation helper
├── tdsify.sh             — Packaging helper
├── bin/swth.sh           — The manager script
├── contrib/              — Additional resources, templates for swth
├── swathesis.cls         — The class
├── swa-*.sty             — The style files
├── amd64masm.def         — listing languages
├── javascript.def
├── lua.def
├── smalltalk.def
├── title-hpi-swa.def     — uni-titlepage style
└── title-hpi-swa-phd.def — uni-titlepage style for PhD theses

swathesis's Issues

Section reference not translated to german although "de" specified in documentclass

\autoref{sectionX} results in "section X" instead of "Abschnitt X"

quickfix:
add ngerman to documentclass

\chapter{...} and "birds-eye view"

Is it possible to ignore the clear-page command for \chapter if we are in birds-eye mode?

Avoid creating auxiliary file with common file ending (blx.bib)

I want to configure git-ignore by using the endings of temp files such as acn, glo, toc, aux, ... but *-blx.bib seems to be an automatically created biblatex file. Is it possible to give it another file ending?

Zentrierung und Bindekorrektur

\AtBeginDocument{
\KOMAoption{titlepage}{firstiscover}
\renewcommand{\coverpageleftmargin}{\dimexpr\evensidemargin + .8in\relax}
}
\AtEndPreamble{
\KOMAoptions{BCOR=12pt,DIV=9}
\areaset[current]{\textwidth}{1.61803399\textwidth}
}

Add bird's-eye view

It would be great to make better use of the screen real estate while writing the thesis' contents (and before layouting them) to have a bird's-eye view of the paper:

• small margins
• small fonts
• two-columns
• centered

The following snippet achieves this:

\AtEndPreamble{
 \KOMAoptions{
  twocolumn=true,
  twoside=semi,
  fontsize=8pt,
  headings=small,
  footinclude=false,
  headinclude=false,
  DIV=calc,
  BCOR=0pt,
 }
}

Insert it before \begin{document}. The result resembles ACM or IEEE research paper formats.

new babel

installation script should automatically install a new version of babel, so it doesn't do this:

! Package babel Error: Language definition file main=english.ldf not found.

\autoref with page number?

If the referenced figure is not in the same, previous, or next page, it would be great to add a page number:

lstlisting has non-fixed width spaces

It is not possible to layout code in the default lstlisting environment like this due to spaces being shorter than the letters:

Transcript cr;
           show: 'foo'.

(Note that the cr is exactly above the show.)

This was my example:

methodsFrom(?classView, ?methodView) if
  hasMethod(forall, ?classView,
            exists, ?methodView),
  not( notHasMethod(exists, ?classView,
                    forall, ?methodView)).

Generate temporary files into an extra folder?

Is it possible to not spoil the root folder of my document but to put aux, bbl, glo, log, lol, ... into a custom "aux" folder?

Main-file support for Sublime

%!TEX root = TEMPLATE.tex

Listing Numbers are not unique (+ solution)

An exemplary "list of listings" using the current template appears as follows:

The listing numbering is restarted per chapter, however, the chapter number is not part of the counter. Hence, there are two listings with identifier "1".
The reader should be able to tell apart different listings by their number:

I worked around this issue the following way:

\usepackage{chngcntr}

\begin{document}

\counterwithin{lstlisting}{chapter}
...

and think this would be a nice addition to the template, but I am not sure how to integrate it.
With the change, the numbering of listings is consistent with the numbering of figures and tables.

hardwrap

Package titlepage was renamed to uni-titlepage

The package titlepage is no longer found at https://komascript.de/repository/tds/titlepage-11.tds.zip (link in get_requirements.sh). Instead its found at https://github.com/komascript/uni-titlepage.

When installing this package with l3build there are still a few issues when building (using swth go).
One that I found is that the argument degree was renamed to academicgrade. There might be more issues that I am not aware of (yet)

Bibliography in Table of Contents

Possibly, it would be nice for the bibliography to appear in the table contents. Usually the bibliography takes up a few pages and is a good link target. I've seen other thesis including the bibliography in the ToC by default.

-\printbibliography
+\printbibliography[heading=bibintoc]

Do you have opinions on this?

change \mathbold in template to \mathbb

\mathbold in the template does only work with euler included, use \mathbb instead or include euler per default (e.g. by defaulting font to palatino)

Windows installation helper

with special respect to MiKTeX (superseeds #13 )

Better document how to add logos

As a thesis author, I want to be informed about the option of adding the logo images to my thesis, in order to not miss this feature.

I personally was not sure about how to add the logo images to my thesis after the Studienreferat told me that I still need to add them (until Toni told me that the swa template already has some logic for them and I just need to put the files inside it), and I know of a student who even handed in the thesis without ever adding the logo images. The intended process here (e.g. where to get the images from and where to put them, so that they are incorporated automatically) should either be reworked, or at least communicated very actively to the author.

Zweispaltige TOC im "birds-eye view"

...für die Übersicht der Struktur des Dokuments. 😄

itemize environment should be indented a bit

Cross-platform installation instructions (like ACM, IEEE, LNCS)

It would be great to just copy some files and start writing the thesis -- i.e., without having to execute some Linux-specific shell scripts. 😄

tutex not on older TeXen

Add time to draft header/footer

Could be important to distinguish between morning and afternoon versions. 😄

abbreviate=false no longer working in biblatex 2019/12/01 v3.14

\usepackage[backend=biber,style=numeric,abbreviate=false]{biblatex}
\addbibresource{thesis.bib}

Integrate phd template

Take #9 and make it use swathesis

Thesis template does not compile on recent TeX Live (+ workaround)

I would like to point out that it is not possible to compile the thesis template on a recent version of TeX Live, and to propose a temporary workaround.

$ swth create
...
$ swth go
Beware of Dragons!
This is pdfTeX, Version 3.14159265-2.6-1.40.19 (TeX Live 2018) (preloaded format=pdflatex)
! Package Listings Error: Numbers none unknown.

l.36 ...Error{Listings}{Numbers #1 unknown}\@ehc}}
! Emergency stop.
 ...
l.36 ...Error{Listings}{Numbers #1 unknown}\@ehc}}
!  ==> Fatal error occurred, no output PDF file produced!
Transcript written on redacted.log.
INFO - This is Biber 2.12
INFO - Logfile is 'redacted.blg'
ERROR - Cannot find control file 'redacted.bcf'! - Did latex run successfully on your .tex file before you ran biber?
INFO - ERRORS: 1
Whoops

I suppose this is due to incompatible changes in dependent packages as per this TeX StackExchange question. Possible solution would be to update the lstlinebgrd package to cope with the changes in listings.

My current workaround this to downgrade the listings package using the TeX Live Utility, and to defer any changes to the setup until completion of my thesis ;) Apparently Rev. 37534 is operational. After the downgrade the document compiles.