From 4a0105d63eb3aaa678ba61a921456efc6376ad81 Mon Sep 17 00:00:00 2001 From: Florian Walch Date: Wed, 6 Apr 2016 00:13:37 +0200 Subject: [PATCH] Allow compiling without logo files. Work out of the box without requiring manual logo download. --- README.md | 17 ++++++++++++----- pages/cover.tex | 12 +++++++++--- pages/title.tex | 12 +++++++++--- 3 files changed, 30 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index c6ab257..9763f46 100644 --- a/README.md +++ b/README.md @@ -8,16 +8,18 @@ Comments & contributions welcome! ## Quickstart - * [Download][template-download] and extract the template. If you prefer to use Git, just clone/fork the repository. - * Download the TUM logos in PDF format: + * [Download][template-download] and extract the template, or upload it to an online editor such as [Overleaf][overleaf] or [ShareLaTeX][sharelatex]. If you prefer to use Git, just clone/fork the repository. + * If your editor provides support for compiling LaTeX, set it up to use `pdflatex` and `biber`. Set the master document to `main.tex`. Alternatively, you can use the provided Makefile to generate a PDF in the `build` directory (requires `latexmk`). + * Look for `TODO` comments in the provided files. Start at `main.tex`. + * If you want to add TUM logos to the cover and title pages: * Log in to [MyTUM][mytum]. * Download the TUM logo from [here][mytum-logo-tum] and save it to `logos/tum.pdf`. * Download your faculty's logo from [here][mytum-logo-faculty] and save it to `logos/faculty.pdf`. * Some logos might not be cropped; execute the `crop-logos` script to do that for you. The script requires the `pdfcrop` tool (included in TeX Live/MiKTeX), so make sure your `PATH` environment variable is set accordingly. - * Configure your latex editor to use `pdflatex` and `biber`. Set `main.tex` as the master document. Alternatively, you can use the provided makefile to create a PDF in the `build` directory (requires `latexmk`). - * Look for `TODO` comments in the provided files. Start at `main.tex`. -For additional hints, have a look at [the wiki][wiki]. If you still have problems, feel free to [create an issue][issue]. +If you are new to LaTeX, the [ShareLaTeX knowledge base][sharelatex-kb] or the [LaTeX Wikibook][latex-wikibook] might help. + +For additional hints, have a look at [the wiki][wiki]. If you still have problems with the template, feel free to [create an issue][issue]. For general LaTeX questions, use [TeX StackExchange][tex-se]. ## License @@ -32,15 +34,20 @@ This template is licensed under a [Creative Commons Attribution-ShareAlike 4.0 I The license **applies only to the template**; there are no restrictions on the resulting PDF file or the contents of your thesis. [issue]: https://github.com/fwalch/tum-thesis-latex/issues +[latex-wikibook]: https://en.wikibooks.org/wiki/LaTeX [license-compatible]: https://creativecommons.org/compatiblelicenses [license-image]: https://i.creativecommons.org/l/by-sa/4.0/88x31.png [license]: https://creativecommons.org/licenses/by-sa/4.0/ [mytum-logo-faculty]: https://portal.mytum.de/corporatedesign/download/fakultaetslogos/index_html [mytum-logo-tum]: https://portal.mytum.de/corporatedesign/download/TUM_Logo/index_html [mytum]: https://portal.mytum.de +[overleaf]: https://www.overleaf.com/ [sample-pdf]: https://raw.github.com/fwalch/tum-thesis-latex/master/build/main.pdf +[sharelatex-kb]: https://www.sharelatex.com/learn +[sharelatex]: https://www.sharelatex.com/ [template-authors]: https://github.com/fwalch/tum-thesis-latex/graphs/contributors [template-download]: https://github.com/fwalch/tum-thesis-latex/archive/master.zip [template-url]: https://github.com/fwalch/tum-thesis-latex +[tex-se]: https://tex.stackexchange.com/ [thesis-guidelines]: http://www.in.tum.de/en/current-students/administrative-matters/thesis-guidelines-and-topics.html [wiki]: https://github.com/fwalch/tum-thesis-latex/wiki/ diff --git a/pages/cover.tex b/pages/cover.tex index 07a3da6..f881efb 100644 --- a/pages/cover.tex +++ b/pages/cover.tex @@ -9,7 +9,11 @@ \centering - \includegraphics[width=40mm]{logos/tum.pdf} + \IfFileExists{logos/tum.pdf}{% + \includegraphics[height=20mm]{logos/tum.pdf} + }{% + \vspace*{20mm} + } \vspace{5mm} {\huge\MakeUppercase{\getFaculty{}}}\\ @@ -26,6 +30,8 @@ \vspace{15mm} {\LARGE \getAuthor{}} - \vspace{20mm} - \includegraphics[width=20mm]{logos/faculty.pdf} + \IfFileExists{logos/faculty.pdf}{% + \vspace{20mm} + \includegraphics[height=20mm]{logos/faculty.pdf} + }{} \end{titlepage} diff --git a/pages/title.tex b/pages/title.tex index a5c46fc..348c9c7 100644 --- a/pages/title.tex +++ b/pages/title.tex @@ -1,7 +1,11 @@ \begin{titlepage} \centering - \includegraphics[width=40mm]{logos/tum.pdf} + \IfFileExists{logos/tum.pdf}{% + \includegraphics[height=20mm]{logos/tum.pdf} + }{% + \vspace*{20mm} + } \vspace{5mm} {\huge\MakeUppercase{\getFaculty{}}}\\ @@ -26,6 +30,8 @@ Submission Date: & \getSubmissionDate{} \\ \end{tabular} - \vfill{} - \includegraphics[width=20mm]{logos/faculty.pdf} + \IfFileExists{logos/faculty.pdf}{% + \vfill{} + \includegraphics[height=20mm]{logos/faculty.pdf} + }{} \end{titlepage}