Using

• Windows 11 UH22
• Docker 4.14.1
• WLS2 Ubuntu ( for making )

Problem

I just noticed that there large gaps between headers when the hierarchy becomes too big...
This is only the case for larger hierarchys and sometimes may also appear when a paragraph gets too big and continues on the next page.

This is a valid problem for all templates, simple, cleanthesis and eisvogel. I also tried different versions of them.
Is this a problem in general ? Or something that can be fixed easily ?

The .md file

# Technologien

## Sprachen

Während der Praxisphase wurden für die internen Projekte auf eine Vielzahl von verschiedenen Programmiersprachen zurückgegriffen, bei diesen handelt es sich vor allem um höhere Programmier und Scriptsprachen einige dieser werden hier  näher erläutert. [Verweis ?]

### Java

Java ist eine objektorientierte Programmiersprache, die im Jahre 1995 mit der ersten Version veröffentlicht wurde. 2010 wechselte sie den Besitzer und ist nun eine eingetragene Marke der Firma Oracle. Da Java zu Bytecode kompiliert wird, ist es möglich durch die Java Laufzeitumgebung und die eigene Virtuelle Maschine, diesen Bytecode auf jeder beliebigen Plattform auszuführen. Andere Programmiersprachen wie Groovy, Kotlin und Scala werden ebenfalls zu Java-Bytecode kompiliert um von der Platformunabhängikeit zu profitieren. 

### Kotlin
### Groovy
### C\#

## Frameworks
### Grails
### GRPC
### Hibernate
### OpenXR

## Hardware & Engines 
### Tooz
### Unity
### Hololens2

pandoc/extra will include Eisvogel as well as all LaTeX packages needed

from Wandmalfarbe/pandoc-latex-template#354 (comment): docker run --rm --volume "pwd:/data" --user id -u:id -g pandoc/extra input.md -o output.pdf --template eisvogel should do the trick :)

• Basisimage: Ubuntu oder Debian?
• Pandoc: Manuelle Installation, per Kommentar auch für M1 vorsehen
• TexLive: über Debian-Pakete oder über TLMGR?
• CleanThesis und Eisvogel: #21
• Installationsskripte so gestalten, dass sie auch direkt im Ubuntu-Runner laufen können

vgl. https://github.com/cagix/pandoc-thesis/blob/master/docker/dockerfile.df (Pakete über TexLive-Debian-Pakete) vs. https://github.com/cagix/pandoc-hugo-m1/blob/master/docker/install-texlive.sh (Pakete direkt über TLMGR) vs. https://github.com/Wandmalfarbe/pandoc-latex-template/blob/master/.github/workflows/build-examples.yml (Installation im Ubuntu-Runner statt Docker-Image, Pakete direkt über TLMGR)

In https://github.com/pandoc-scholar/pandoc-scholar/blob/main/docker/ubuntu.Dockerfile findet sich ein interessanter Ansatz, auf der Basis von Pandoc/Docker und Debian/Ubuntu und TLMGR weitere Pakete nachzuinstallieren ...

Siehe auch https://github.com/TTPS-ruby/pandoc-eisvogel/blob/master/Dockerfile und https://github.com/pandoc/dockerfiles

Mit Hilfe von Paged.js kann man aus einem HTML-File relativ einfach (und schnell) vergleichsweise ansehnliche PDFs erzeugen.

Die Toolchain wäre dann nur noch Markdown > Pandoc > HTML > Paged.js/PDF, d.h. das relativ langwierige Kompilieren mit LaTeX würde entfallen. (Außerdem könnte man sich die mehrere Gigabyte große TeX-Installation sparen.)

Frage: Taugt das für wissenschaftliche Arbeiten?

Alternative: https://github.com/Kozea/WeasyPrint

something like

```{.python caption="The preprocessing step, cf. [@Nystrom2018]" #lst:huh}
def foo():
""" Wuppie! """
pass
```

will be translated using pandoc --filter=pandoc-citeproc --listings xxx.txt -o xxx.pdf into something like

Listing 1: ]The preprocessing step, cf. [@Nystrom2018]

However, I'd expect something like

Listing 1: The preprocessing step, cf. (Nystrom 2018)

upstream issue: jgm/pandoc#6068

see cagix/faq-praxisphase-abschlussarbeit#45:

Idea: Create a genuine TeX template and make it compatible with Sciebo-Overleaf (= base). Adapt the tooling here so that it uses this TeX template, plus Docker with Pandoc, LaTeX, filters, ... (= extension).

Da fliegen viele Dateien herum, die an irgendeiner Stelle irgendwie eingebunden werden:

• titlepage.tex (--include-in-header)
• include-header.tex (--include-in-header für CleanThesis)
• frontmatter.tex (--include-before-body)
• references.md (geht am Ende vom Content mit)
• backmatter.tex (--include-after-body)

Diese Dateien sollten zumindest in einen "versteckten" Ordner verschoben werden.

Welche Strukturen/Dateien brauchen wir wirklich noch? Was kann irgendwie anders realisiert werden, etwa per Definition im entsprechenden Defaultfile?

references.md könnte durch ein eigenes Markdown-Template eingespart werden (vgl. #27).

Ein eigenes Markdown-Template könnte die Struktur des Gesamtdokuments deutlicher machen. Außerdem könnten Teile wie "references.md" direkt eingebunden werden und müssten nicht als Dummy-Datei definiert werden. Möglicher Nachteil: Es müsste zunächst von Markdown nach Markdown übersetzt werden, und Pandoc ist da teilweise etwas zu eifrig mit dem Escaping ... Außerdem ist die Templatesyntax evtl. störend?

Eigenes Markdown-Template: Einbinden anderer Dateien (auf der selben Ebene!) via ${ abstr.md() } funktioniert, TeX-Befehle bleiben erhalten. Problem: $ wird als besonderes Zeichen erkannt, d.h. die eingebundenen Dateien dürften Markdown enthalten, aber kein $ (bzw. man müsste jedes $ mit einem weiteren $ escapen, also statt $e=m*c^2$ müsste man $$e=m*c^2$$ schreiben). => Template mit Dokumentstruktur und Einbinden der Markdown-Inhalte per lokalem Link (plus Filter, der die Links auflöst)?

Spezifikation von Footern etc. im YAML-Header (aus Wandmalfarbe/pandoc-latex-template#381 (comment)):

header-includes: 
- \usepackage{lastpage}
footer-left: "\\thepage \\hspace{1pt} / \\pageref*{LastPage}"
``

• Readme: Kurze Anleitung, was man braucht und wie man das Projekt startet
• Markdown-Files:
  • Übersetzen des Projekts
  • Erklären der Struktur und Umfänge
  • Hinweise zu bestimmten Markdown-Aspekten
• Bekannte Issues:
  • Abbildungen in Eisvogel mit [H] (kein floating)
  • Probleme mit Overflow am Seitenrand (dann Abbildung verschieben im Text)
  • Listings haben keine Über-/Unterschrift
  • Zitieren in Bildunterschrift/Tabellenüberschrift funktioniert nicht (wirklich? prüfen!)

Alternativ alles im Readme mit zuklappbaren Einheiten (<details>...</details>)?

Style mit aufnehmen - recht nette Anleitung zu LaTeX und wiss. Arbeiten: https://github.com/Digital-Media/HagenbergThesis

Einbindung der einzelnen Markdown-Dateien:

• via Makefile
• via Defaultfile
• via thesis.md (ala Summary.md von mdBook) => Filter nötig (vgl. https://github.com/pandoc/lua-filters/tree/master/include-files, dort über Code-Blöcke => hier per lokalem Link auf eine .md-Datei?)
• via eigenem Template (https://pandoc.org/MANUAL.html#templates)

Beachten: Targets im Makefile sollen nur ausgeführt werden, wenn es wirklich was zu tun gibt - wenn sich die Sourcen geändert haben. Wenn die Sourcen in einem eigenem Template oder einem Defaultfile gezogen werden, müsste man sie entweder im Makefile erneut definieren oder aber einfach immer übersetzen ...

Ein eigenes Markdown-Template könnte die Struktur des Gesamtdokuments deutlicher machen. Außerdem könnten Teile wie "references.md" direkt eingebunden werden und müssten nicht als Dummy-Datei definiert werden. Möglicher Nachteil: Es müsste zunächst von Markdown nach Markdown übersetzt werden, und Pandoc ist da teilweise etwas zu eifrig mit dem Escaping ... Außerdem ist die Templatesyntax evtl. störend?

Eigenes Markdown-Template: Einbinden anderer Dateien (auf der selben Ebene!) via ${ abstr.md() } funktioniert, TeX-Befehle bleiben erhalten. Problem: $ wird als besonderes Zeichen erkannt, d.h. die eingebundenen Dateien dürften Markdown enthalten, aber kein $ (bzw. man müsste jedes $ mit einem weiteren $ escapen, also statt $e=m*c^2$ müsste man $$e=m*c^2$$ schreiben). => Template mit Dokumentstruktur und Einbinden der Markdown-Inhalte per lokalem Link (plus Filter, der die Links auflöst)?

Für diesen Zweck wäre es gut, wenn Pandoc die Templates nicht als Datei, sondern auch als direkten Text entgegen nehmen würde. Dann könnte man sich ein Template definieren, on-the-fly mit Metadaten vorbefüllen (ohne eine temporäre Datei anlegen zu müssen) und dann für die finale Dokumenterstellung als Text an Pandoc weiterreichen (siehe auch Diskussionen jgm/pandoc#9790, jgm/pandoc#9853, jgm/pandoc#9788)

Siehe auch #60

Die alte FAQ ist unvollständig und an einigen Stellen auch nicht sooo gut gemacht.

=> Als OER neu bereitstellen

• Repo mit Link zum Studiengang
• Markdown als direkt nutzbares Material
• PDF (als "Release" und auch im Download-Bereich vom Studiengang)
• Videos (Praxisphase, BA, Sonderregelungen)

Is there a way to create numbering for equations created with $$ like $$ X $$ for example ?

Im Prinzip könnte man das ganze Paket auch als Template auf Overleaf bereitstellen.

Vorteil:

• Kein Herumschlagen mit Docker und Verständnis für die Toolchain bei "fortgeschritteneren" Fragen
• PDF wird on-the-fly erzeugt

Nachteil:

• Overleaf hat zwar kostenlose Lizenzen, aber so richtig weit kommt man damit nicht. Hochschullizenz ist aber bereits angefragt ...
• Studis müssen doch wieder LaTeX können (nur minimal, aber sie müssten es beherrschen)

How would I add more information like the institute to the titlepage?

https://dl.gi.de/items/2da8e6cd-2428-4f36-b099-44ec9c41d915

@book{book,
    author = "Balzert, Helmut and Schröder, Marion and Schäfer, Christian",
    title  = "Wissenschaftliches Arbeiten - Ethik, Inhalt & Form wiss. Arbeiten, Handwerkszeug, Quellen, Projektmanagement, Präsentation, 3. Auflage",
    year  = 2022,
    doi  = "10.18420/LB-WissArbeiten",
}

Hello,

On my writings I realized that the thesis title is added to the page headline on all pages but the first one of a chapter, so the pages 2–n of a chapter. I think in general this is not an issue, but in my case with a very long title this looks kind of ugly, especially when the section headline touches the thin separation line under the page headline.

Hallo,
Ich habe dein Template auf der Suche nach einem geeigneten Format für meine Thesis gefunden. Und freue mich sehr mit deiner Vorlage gut zurecht zu kommen. Lustigerweise hat mein Prozess auch genau an der uni Bielefeld angefangen, nämlich mit Luhmann und seinem Zettelkasten und nun scheint die Uni Bielefeld mein Begleiter richtung Abgabe zu sein.
Vielen Dank.

Es gibt ein kleines Thema: Ich würde gerne highlighted Backlinks einfügen. habe es schon mit:

OPTIONS                += --highlight-style=pygments
OPTIONS                 = -f markdown+implicit_figures+hard_line_breaks+backtick_code_blocks

versucht. Leider Erfolglos. Weiß jemand woran das liegt?

see #32 (comment)

do not use windows+docker directly but from wsl2:

• Install WSL2, any distribution will work
• Start the Subsystem to gain acess to its shell
• Pull the project
• make docker
• make cleanthesis
• Sucess

See also #62 - use either "pandoc" or a path leading to pandoc.exe, e.g. "C://..../pandoc.exe"

• CleanThesis:

  • per Git Submodule,
  • pull im Makefile, oder
  • TexLive-Paket ("texlive-publishers")?

• Eisvogel:

  • per Git Submodule,
  • pull im Makefile, oder
  • direkt im Docker-Image ablegen?

Cleanthesis: Lt. https://www.ctan.org/pkg/cleanthesis ist dort (und dann in den Debian-Packages) Version 0.4.0 aktuell. Im Repo https://github.com/derric/cleanthesis/releases ist 0.4.1 die letzte Version mit dem verstörenden Hinweis: "Fixed zipped release files, because v0.4.0 zip files contained wrong/old cleanthesis.sty files"

Submodules:

• Vorteil:
  • Version transparent eingebunden (nicht versteckt im Makefile mit extra Target zum Download)
  • Makefile wird einfacher
  • Beschreibung/Dokumentation wird einfacher
• Nachteil
  • Auschecken "schwieriger"
  • Styles müssen noch aus Unterordner in das Arbeitsverzeichnis kopiert werden

Makefile:

• Vorteil: keine Git-Submodules, Handling einfacher
• Nachteil:
  • Version im Makefile "versteckt"
  • komplexeres Makefile für den Download der Templates
  • evtl. Probleme durch Auschecken der letzten 100 Commits, dort muss die Version zu finden sein ...

Docker:

• Vorteil: Templates sind als "Tooling" im Container
• Nachteil:
  • Skript so gestalten, dass es auch separat anzustoßen ist (Linux only?!)
  • Templates liegen in einem bestimmten Ordner im Container und müssen erst in das Arbeitsverzeichnis kopiert werden (Makefile??)

Hi everyone, I apologize in advance for my noobie question but I don't have much experience with pandoc.
Reading the installation section for creating the thesis in PDF, there are two ways: one with docker and the other with pandoc.

Point 4, specifically, says: "Either set an environment variable PANDOC pointing to the location of your pandoc installation or change the line PANDOC ?= docker run --rm -v $(WORKDIR):/pandoc pandoc-thesis pandoc in the Makefile to reflect your settings".

However, I'm not sure how to interpret this point.
Suppose I want to produce the PDF of the thesis with pandoc (Eisvogel template), once I have downloaded the zip containing all the files, what would be the steps and the code to generate it with pandoc?

Thanks in advance

siehe #17:

Erste Seite eines Kapitels ist mit Seitenzahl und Autor, aber ohne Trennstrich.

Sollte auf einer ersten Seite im Kapitel auf Kopf- und Fußzeilen komplett verzichtet werden?!

Also creates empty Pages between abstract and acknowledgements and between acknowledgements and table of content.

• using eisvogel
• using given structure

Anstatt selbst alles nochmal zu wiederholen, am besten für eine Markdown-Anleitung auf Submitting a paper to JOSS verlinken ...

Vorher nochmal das Beispielpaper hier ausprobieren, aber das sah eigentlich alles vernünftig aus und sollte hier exakt genauso funktionieren.

• #18

Erste Seite eines Kapitels ist mit Seitenzahl und Autor, aber ohne Trennstrich.

• #19

Es fehlt der Strich und der Anhang wird Literatur genannt, sollte eigentlich Anhang sein?
Wahrscheinlich wegen dem Befehl "\markboth{Literatur}{Literatur}" in der reference.md?

• #20

Die aus fremden Quellen direkt oder indirekt übernommenen Gedanken sind als entsprechend kenntlich gemacht.
Link zur Zeile

used eisvogel.

Mit Pandoc-Scholar steht ein Pandoc-basiertes Framework bereit, welches das Schreiben wissenschaftlicher Texte erleichtern soll und damit eine ähnliche Zielrichtung wie das Pandoc-Thesis-Projekt hat.

Zu prüfen:

• Kann der Workflow durch den Einsatz von Pandoc-Scholar vereinfacht werden?
• Kann das Eisvogel-Template weiterhin für die PDF-Generierung eingebunden werden?

Edit: Das Projekt scheint seit fast zwei Jahren nicht mehr gepflegt zu werden? Letzter Commit ist vom 28.01.2021 ...

kurzes How-To-Video erstellen und als Anleitung bereitstellen

• Umgang mit Markdown
• Gliederung einer Abschlussarbeit
• Umgang mit dem Repo/Docker-Container/Tooling

Very good project. You have put in lot of effort to create and maintain this project but usage example along with some example output documents (PDF) would provide lot of visibility.

Nicht alle Referenzen sind wirkliche Quellen (aka "Literatur") mit Autor, Jahr, Verlag etc., oft handelt es sich um die Erwähnung einer Projekt-Webseite o.ä. Diese könnte man als normale Quelle behandeln und ins Literaturverzeichnis aufnehmen. Aber (a) ist es eben keine Literatur, und (b) sieht die Referenz in vielen CSL-Formaten kaputt aus, weil es keinen Autor und/oder Jahr gibt.

Für reine Links könnte automatisiert eine Fußnote generiert werden:

• TeX-only: Option -V links-as-notes=true
• Allgemein: Lua-Filter

• Pandoc-Defaultfiles definieren für "simple", "eisvogel" und "clean"
• metadata.yaml anpassen und entschlacken: nur wirkliche Metadaten
• Makefile aufräumen: Optionen gehen in die Defaultfiles

"simple" als Basis, und die Defaultfiles für "eisvogel" und "cleanthesis" ziehen sich das und definieren weitere Zuordnungen.

Beachten: Targets im Makefile sollen nur ausgeführt werden, wenn es wirklich was zu tun gibt - wenn sich die Sourcen geändert haben. Wenn die Sourcen in einem eigenem Template oder einem Defaultfile gezogen werden, müsste man sie entweder im Makefile erneut definieren oder aber einfach immer übersetzen ...

Es gibt einige Tests, die im Rahmen einer Lehrveranstaltung im Sommer 2021 erstellt wurden.

Zu prüfen:

• Passen die Tests zum Projekt
• Welche der Tests sollen/können übernommen werden

Alten LaTeX-Kurs aus der Summer-School aufarbeiten und als OER bereitstellen

• Skript
• Aufgaben
• Self-Assessment
• Videos

Der LNI-Style (https://github.com/gi-ev/LNI.git) ist auch ganz nett. Bevor man einfach nur einen Report/Article nimmt, wäre das eine gute Option.

Eisvogel ist insgesamt ansprechend und hat insbesondere ein sehr angenehmes Deckblatt. Allerdings hat es auch einige in der Praxis nervige Probleme, die es mit LaTeX eigentlich nicht geben sollte, und der Autor scheint in letzter Zeit eher inaktiv zu sein. Obendrein braucht man eine Palette an Packages, die den Docker-Container unnötig aufblähen.

CleanThesis sticht vor allem durch den großen Platzbedarf hervor, in einer aktuellen Arbeit wurde durch den Wechsel von CleanThesis auf Eisvogel die Seitenzahl von 72 (CleanThesis) auf 56 (Eisvogel) runtergedrückt ... Und auch dieser Style scheint nicht mehr aktiv gepflegt zu werden.

latex-mimosis scheint recht attraktiv zu sein und sich an die üblichen LaTeX-Gepflogenheiten zu halten und auch nur relativ wenige zusätzliche Packages zu benötigen. Da es für eine Dissertation genutzt wurde, ist freilich auch hier die Frage, wie lange dieser Style noch aktiv gepflegt werden wird.

Idee: Bei der anstehenden Überarbeitung der Vorlage auf eine reine LaTeX-Lösung sowie den latex-mimosis-Style setzen und Eisvogel sowie CleanThesis rauswerfen. Das dürfte auch das Tooling bzgl. der Bibliotheken sowie Deckblatt und Frontmatter deutlich vereinfachen.

In der Readme fehlt ein Hinweis zum Eintragen der eigenen User und Group ID in docker/dockerfile.df vor dem Bauen des Images via make docker

siehe #17:

Es fehlt der Strich und der Anhang wird Literatur genannt, sollte eigentlich Anhang sein?
Wahrscheinlich wegen dem Befehl "\markboth{Literatur}{Literatur}" in der reference.md?

Sollte auf einer ersten Seite im Kapitel auf Kopf- und Fußzeilen komplett verzichtet werden?!

If you use CygWin for execution:
make will set the mountpath to

 /cygdrive/{PATH}
instead of 
 /{PATH}

Work around:
set absolute path in makefile

Die FH Bielefeld hat eine neue Eigenständigkeitserklärung als PDF veröffentlicht (https://www.fh-bielefeld.de/multimedia/Hochschulverwaltung/Dezernat+II/StudServ/Pr%C3%BCfungsangelegenheiten/Hochschulweite+Ordnungen_+Formulare+und+Antr%C3%A4ge/Eigenst%C3%A4ndigkeitserkl%C3%A4rung.pdf).

Diese muss am PC ausgefüllt und dann ausgedruckt und unterschrieben und dann an die Thesis (z.B. gescant) angefügt werden.

Wenn im Workdirectory Pfade enthalten sind, in denen Leerzeichen vorkommen, dann schlägt der docker run Befehel leider fehl.

siehe #17:

Die aus fremden Quellen direkt oder indirekt übernommenen Gedanken sind als entsprechend kenntlich gemacht.
Link zur Zeile

• Geeignete CSL-Files von https://www.zotero.org/styles suchen
• Direkt in Repo einbinden? => Lizenz??
• Alternativ über Docker-Image-Definition
• Alternativ als Kommentar

Shall we use our Docker image or run this code directly on the Ubuntu runner?

It copies the header from the last chapter.

Using

• Windows 11 22H2
• Docker 4.14.4 with Windows Linux Subsystem 2 Ubuntu ( HyperV was not recommended )

Error & Reproduction

I was following the Usage Example, pulled the repo, ran make docker, ran make simple or make cleanthesis.
Then i was hit by the error message Could not find data file templates/titlepage.tex.

PS C:\Users\Lars\DockerProjects\pandoc-thesis> make cleanthesis
rm -rf .tmp_template_dl
git clone --quiet --single-branch --branch master --depth 100 https://github.com/derric/cleanthesis .tmp_template_dl
cd .tmp_template_dl && git checkout --quiet 63d1fdd815
cp .tmp_template_dl/cleanthesis.sty ./cleanthesis.sty
rm -rf .tmp_template_dl
docker run --rm -v /c/Users/Lars/DockerProjects/pandoc-thesis:/pandoc pandoc-thesis pandoc --wrap=preserve -M cleanthesis=true -M cleanthesisbibfile=references --template=titlepage.tex --metadata-file=md/metadata.yaml -o __titlepage.filled.tex titlepage.tex
Could not find data file templates/titlepage.tex
make: *** [Makefile:196: __titlepage.filled.tex] Error 97

Additional Details

Looks like the templates folder is missing, however you mentioned that in order to generate that folder a make eisvogel or make cleanthesis is required... long story short, doesnt work since the same error is generated as the print above shows.

In addition to this problem, i also noticed that the created docker image does not run and closes instantly.
Not sure if this behaviour is intended.

I tried several combinations of cleaning, making, pulling and setting up the repo again without any sucess.
Is this a bug or is something missing in the tutorial ?