Skip to content

README.md

Latest commit

 

History

History
77 lines (53 loc) · 2.77 KB

README.md

File metadata and controls

77 lines (53 loc) · 2.77 KB

APA7 Thesis Template For Overleaf

This repository is designed around one student workflow: upload the prepared Overleaf package, open one file, and start writing.

Students should use the release asset overleaf.zip, not the raw repository checkout.

For Students

Use exactly one main file:

  • thesis_eng.tex for English
  • thesis_ger.tex for German

Edit only these locations:

  • your chosen thesis_*.tex file
  • bibliography.bib
  • your own files inside figures/

Ignore these locations:

  • template/
  • maintainer/
  • dev/
  • Makefile
  • bachelor_*.tex

Quick Start

  1. Download overleaf.zip from the GitHub Release assets.
  2. In Overleaf, create a new project by uploading that zip.
  3. Open thesis_eng.tex or thesis_ger.tex.
  4. Replace the % (CHANGE ME) fields at the top.
  5. Click Recompile.

Daily Use

  • Write by replacing the example sections with your own text.
  • Add citations to bibliography.bib and cite with \cite{Key}.
  • Upload images to figures/ and include them with \includegraphics{figures/your-file.ext}.
  • Recompile once after text changes and twice after bibliography changes.

Troubleshooting

  • Missing citations usually mean you need another compile pass, or Overleaf must be set to LaTeX (pdfLaTeX) + Biber.
  • Missing images usually mean the filename or path in figures/ does not match exactly.
  • The warning microtype: Unable to apply patch 'footnote' is harmless.
  • Red errors matter; most yellow warnings do not.

Repository Scope

This repository contains a few maintainer-side and historical files that are intentionally excluded from the student ZIP.

  • thesis_eng.tex and thesis_ger.tex are the supported public templates.
  • bachelor_eng.tex and bachelor_ger.tex are legacy examples, not part of the public student flow.
  • The Overleaf release ZIP is generated by scripts/make_overleaf_zip.sh.

For Maintainers

Local validation requires TeX Live or MacTeX with pdflatex, biber, latexmk, and make on PATH.

  • make build-en builds the English thesis PDF.
  • make build-de builds the German thesis PDF.
  • make build-all builds both thesis PDFs.
  • make clean removes auxiliary files.
  • make zip creates overleaf.zip.

GitHub Actions builds both public thesis entry points.

  • Push and pull request runs upload temporary workflow artifacts.
  • Published GitHub Releases receive permanent assets: overleaf.zip, thesis_eng.pdf, and thesis_ger.pdf.
  • The release-assets workflow can also be run manually for an existing tag if you need to repair or replace release assets.

License

Repository source files are released under the MIT License. Institutional logos and bundled third-party materials may be subject to their own terms.

Contact

Maintainer: karl.koschutnig@uni-graz.at