[{"_1":2,"_163":-5,"_164":-5},"loaderData",{"_3":4,"_18":19,"_25":26,"_142":143},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16,"_17":11},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","dockerRebrandTour","routes/_layout",{"_20":-5,"_21":22,"_23":11,"_24":22},"username","isAskGordonEnabled",true,"showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_129":-5,"_130":11,"_131":22,"_132":11,"_133":11,"_134":11,"_135":-5,"_136":11,"_137":-5,"_138":139,"_140":91,"_141":-7},"canonicalUrl","https://chstno1.isgood.host/r/andrerichter/tum-dissertation-latex/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","andrerichter","reponame","tum-dissertation-latex","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":22,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2016-12-07T12:55:58.968064Z","description","Build environment for the tum-dissertation-latex template.","is_private","last_updated","2021-06-10T17:41:45.420439Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",2552,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","# TUM dissertation/PhD thesis LaTeX template\n\nAn _unofficial_ Latex template for a TUM dissertation/PhD thesis that aims to satisfy the new [2016 corporate design guidelines of the TUM](https://portal.mytum.de/corporatedesign/index_html) regarding titlepage header and color usage.\n\nMade by [Andre Richter](https://github.com/andre-richter) with help from [his colleagues](#contributions).\n\nFor a preview of the cover, [click here](#cover-preview). For a full preview, see either the template [PDF](dissertation.pdf) or have a look at already published dissertations in the [Hall of Fame](/doc/hall_of_fame.md).\n\n## Hall of Fame\n\nIf you used the template to publish your dissertation, we'd be super happy if you reference yourself in the [Hall of Fame](/doc/hall_of_fame.md). Just create a pull request or an issue.\n\nThe Hall of Fame is also a great resource for previewing the template and getting inspired regarding style.\n\n## Getting started\n\nThe following instructions work with Linux, macOS and Windows, because a **Docker** image is used that provides the whole build environment.\n\n##### Docker image info\n[![](https://images.microbadger.com/badges/version/andrerichter/tum-dissertation-latex.svg)](https://microbadger.com/images/andrerichter/tum-dissertation-latex) [![](https://images.microbadger.com/badges/commit/andrerichter/tum-dissertation-latex.svg)](https://microbadger.com/images/andrerichter/tum-dissertation-latex) [![](https://images.microbadger.com/badges/image/andrerichter/tum-dissertation-latex.svg)](https://microbadger.com/images/andrerichter/tum-dissertation-latex)\n\n### Step by step\n\n1. Install Docker on your system. Find install instructions or binaries for your OS [here](https://www.docker.com/community-edition#/download).\n - Windows users only: [Share the local drive](https://docs.docker.com/docker-for-windows/#shared-drives). Right-click on the Docker icon in the bottom right gives you access to the settings.\n2. Logos are needed for the cover. To circumvent copyright problems, they must be downloaded using your TUM login and cropped manually. You can skip this for now, and run `make placeholder` (or `make.bat placeholder` under Windows) to use placeholders. But eventually you need to get the logos:\n 1. Login at https://portal.mytum.de/corporatedesign/vorlagen/index_Logos\n 2. Download the **SVG version** of the blue TUM logo and save it to `inc/`\n 3. Download the **SVG version** of your faculty's logo and save it to `inc/`\n 4. If the above link did not work for you, e.g. you could not see or access the logos, please refer to the section [Link list of logo resources](#link-list-of-logo-resources) at the bottom of this readme. They provide alternative links that may work.\n 5. Start a terminal/console/command and navigate where you saved the repository.\n 1. Linux/macOS: Execute `make crop`\n 2. Windows: Execute `make.bat crop`\n\n_The command in the last step will first pull the Docker image from remote, which will take a couple of minutes. Fortunately, this must only be done once._\n\nIf everything worked, your setup is complete now and you are good to go!\n\n## Building the PDF\n\n### Linux/macOS\nIn a terminal, execute\n\n- `make` to build the pdf.\n- `make clean` to clean up temporary files.\n\n### Windows\nIn a cmd or powershell, execute\n\n- `make.bat` to build the pdf.\n- `make.bat clean` to clean up temporary files.\n\n*Double-clicking `make.bat` in the explorer also builds the pdf.*\n\n## Troubleshooting\n\n### Linux/macOS\n- If you get errors on the `make` commands, you can try to invoke them via sudo, e.g. `sudo make crop`\n\n## Template Usage\n\n- At the top of `dissertation.tex`, you'll find parameters for the titlepage, e.g. names, faculty name, dissertation title, etc.\n - Also, have a look at the two binding correction options!\n- Use `\\captionabove{}` instead of `\\caption{}` if you place a caption above a figure.\n- Easy usage of TUM CI colors is provided by the tumcolors package. See `doc/tumcolor.pdf` for instructions.\n\n## Compatibility\n\nThe TUM design guidelines lack explicit statements about how to place non-quadratic faculty logos. Each faculty logo has at least a partial circle. Most likely, the logo must be centered to the center of the logo's partial circle, and scale the diameter of the partial circle to 10mm. At least this is what we can derive from looking at page 16 of the [style guide](https://portal.mytum.de/corporatedesign/regeln/index_styleguide/styleguide/Manual_CD_2016_v1).\n\n## TODOs\n\n- [ ] Error handling in `crop_place_logos.sh` (missing binaries, files not found, etc.).\n- [ ] Improve the windows batch file.\n\n## Building without Docker\n\nLinux/macOS users who want to build without Docker most likely know what to do. Dependencies can be found inside `Dockerfile`.\nThe `Makefile` already has targets for building without docker, just make them default.\n\n## Auto build and publish dissertation\n\nYou can auto build and publish your dissertation on every tagged release.\n\n\n### GitLab\n1. Use GitLab (e.g. [gitlab.com](https://www.gitlab.com) or [gitlab.lrz.de](https://gitlab.lrz.de)).\n2. [Enable Pipelines][auto_1] for your project under `Settings > General > Permissions`.\n3. [Enable GitLab runners][auto_2] for your project under `Settings > CI/CD`.\n4. Create a [Personal Access Token][auto_3] with the `api` scope.\n5. Add the token [as environment variable][auto_4] `GITLAB_ACCESS_TOKEN` in project `Settings > CI/CD > Variables`.\n6. Create and push a tag, wait ~2mins and find your dissertation as PDF under your project tags to download (https://gitlab.com/USER/REPO/tags).\n\n_Note: https://gitlab.lrz.de/ currently does not provide shared runners. Submit a friendly request here: https://servicedesk.lrz.de/de_\n\n[auto_1]: https://docs.gitlab.com/ee/ci/enable_or_disable_ci.html\n[auto_2]: https://docs.gitlab.com/ee/ci/runners\n[auto_3]: https://gitlab.com/profile/personal_access_tokens\n[auto_4]: https://docs.gitlab.com/ee/ci/variables/#creating-a-custom-environment-variable\n\n\n### GitHub\nTo use GitHub Actions, you can simply paste the below code into a new `.yml` or `.yaml` file in `.github/workflows/`. The automatic tests then work after the next push event.\n\n```yaml\n# This is a workflow file to auto-build the latex code.\n\nname: CI\n\n# Controls when the action will run. Triggers the workflow on push or pull request\n# events but only for the master branch\non:\n push:\n branches: [ master ]\n pull_request:\n branches: [ master ]\n\n# A workflow run is made up of one or more jobs that can run sequentially or in parallel\njobs:\n # This workflow contains a single job called \"build\"\n build:\n # The type of runner that the job will run on\n runs-on: ubuntu-latest\n\n # Steps represent a sequence of tasks that will be executed as part of the job\n steps:\n # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it\n - uses: actions/checkout@v2\n\n # Runs a single command using the runners shell\n - name: Build\n uses: docker://andrerichter/tum-dissertation-latex\n with:\n entrypoint: make\n args: pdf-local\n # if your dissertation is not in the root directory of the github repository, add the directory using the -C option of make.\n\n # Publish the artifacts\n - name: Publish artifact\n uses: actions/upload-artifact@v2-preview\n with:\n name: dissertation\n path: dissertation.pdf\n # if your dissertation is not in the root directory of the github repository, you have to adapt the previous path!\n\n # Publish artifact as release so it is more prominent\n - name: Release artifact\n uses: ncipollo/release-action@v1\n with:\n artifacts: \"dissertation.pdf\"\n # if your dissertation is not in the root directory of the github repository, you have to adapt the previous path!\n token: ${{ secrets.GITHUB_TOKEN }}\n tag: current\n allowUpdates: true\n\n```\n\n## Link list of logo resources\n\n- [TUM Logo](https://portal.mytum.de/corporatedesign/vorlagen/index_Logos/dateien/TUM_Logo_blau_rgb_s)\n\n- [Architektur](https://portal.mytum.de/corporatedesign/vorlagen/index_Logos/dateien/FAK_AR_RGB_s.svg)\n- [Bau Geo Umwelt](https://portal.mytum.de/corporatedesign/vorlagen/index_Logos/dateien/FAK_BGU_RGB_s.svg)\n- [Chemie](https://portal.mytum.de/corporatedesign/vorlagen/index_Logos/dateien/FAK_CH_RGB_s.svg)\n- [Elektrotechnik und Informationstechnik](https://portal.mytum.de/corporatedesign/vorlagen/index_Logos/dateien/FAK_EI_RGB_s.svg)\n- [Hochschule für Politik München](https://portal.mytum.de/corporatedesign/vorlagen/index_Logos/dateien/FAK_HFP_RGB_s.svg)\n- [Informatik](https://portal.mytum.de/corporatedesign/vorlagen/index_Logos/dateien/FAK_IN_RGB_s.svg)\n- [Maschinenwesen](https://portal.mytum.de/corporatedesign/vorlagen/index_Logos/dateien/FAK_MW_RGB_s.svg)\n- [Mathematik](https://portal.mytum.de/corporatedesign/vorlagen/index_Logos/dateien/FAK_MA_RGB_s.svg)\n- [Medizin](https://portal.mytum.de/corporatedesign/vorlagen/index_Logos/dateien/FAK_MED_RGB_s.svg)\n- [Physik](https://portal.mytum.de/corporatedesign/vorlagen/index_Logos/dateien/FAK_PH_RGB_s.svg)\n- [TUM School of Education](https://portal.mytum.de/corporatedesign/vorlagen/index_Logos/dateien/FAK_SE_RGB_s.svg)\n- [Sport- und Gesundheitswissenschaften](https://portal.mytum.de/corporatedesign/vorlagen/index_Logos/dateien/FAK_SP_RGB_s.svg)\n- [TUM School of Management](https://portal.mytum.de/corporatedesign/vorlagen/index_Logos/dateien/FAK_SOM_RGB_s.svg)\n- [Wissenschaftszentrum Weihenstephan](https://portal.mytum.de/corporatedesign/vorlagen/index_Logos/dateien/FAK_WZW_RGB_s.svg)\n\n## Contributions\n\nAndre Richter - \n- Makefile\n- Title page design\n- Plot cycle list\n- Figures, tables, acronyms in table of contents\n- Added a customized bibliography style based on [unsrturl.bst](http://ctan.mackichan.com/biblio/bibtex/contrib/urlbst/unsrturl.bst) that abbreviates first names\n- Appendix support\n- TUM color syntax highlighting for source code listings\n- Siunitx styles\n- Support for non-quadratic faculty logos\n\nMichael Vonbun - \n- tumcolors package\n- Various cls file tweaks\n- Latexmk support\n- Sans serif title page option\n\nChristian Herber - \n- Barchart cycle list with pattern styles\n- Table of contents in pdf index hack\n\nStefan Wallentowitz - \n- Prevent orphans and widows\n\nAndreas Oeldemann - \n- Help with Docker support.\n\n## License\n\n $\"Creative$
This work is licensed under a Creative Commons Attribution 4.0 International License.\n\nSee [license file](LICENSE) for details.\n\n## Cover Preview\n\n\n\n![Cover Preview](/../preview/preview.png?raw=true \"Cover Preview\")\n\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":22,"_83":11,"_84":11},"read","write","admin","user","storage_size",16748748460,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":22},"content_type","creator",1307904,"full_size",380624798,"id",6654425,"images",[101],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},"architecture","amd64","digest","sha256:a22a4723517d3e6a254f53ef53ad47ced0e893f46572e91a5ec799554606b050","features","","last_pulled","2026-11-04T04:46:57.646429068Z","last_pushed","2021-06-10T17:41:46Z","os","linux","os_features","os_version","size","variant","2021-06-10T17:41:45.128462Z","last_updater","last_updater_username","media_type","latest","repository",1098069,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxRunInCloud","showSbxAgenticPlatformBadge","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":144,"_151":152,"_138":161,"_162":11},{"_40":145,"_42":146,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":147,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":148,"_79":22,"_80":150,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":149},[78],{"_82":22,"_83":11,"_84":11},"tags",{"_153":64,"_154":-5,"_155":-5,"_156":157},"count","next","previous","results",[158],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":159,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":22},[160],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},[],"canDeleteTags","actionData","errors"]

andrerichter/tum-dissertation-latex

Tags for andrerichter/tum-dissertation-latex