Code Monkey home page Code Monkey logo

scientific-thesis-template's Introduction

Build Status

LaTeX Template for Scientific Theses

This template is a general template for scientific theses. Currently, it is the unofficial LaTeX template for Master, Bachelor, Diploma, and Student Theses at following institutions:

It will be extended to support theses from different institutions.

This README.md of the template is also rendered at https://latextemplates.github.io/scientific-thesis-template/. For architectural decision records see docs/adr.

Characteristics of the template

Even though AuToLaTeX is more powerful than latexmk, it is not included in MiKTeX and therefore it is not used here.

Quick start

Download

  1. Go to the latest release via https://github.com/latextemplates/scientific-thesis-template/releases/latest.
  2. Download the file source.zip
  3. Extract source.zip to the directory you want to work. E.g., c:\users\user\documents\thesis.
  4. Start texing at main-english.tex or main-german.tex.
  5. Users of Paderborn University: Adapt logos/UBP-background-picture.pdf to your needs. It has the format 20cm x 10cm.

Usage at overleaf

See overleaf.

Usage using plain git

We do not recommend to fork this project as a fork denotes that you work on improving the template itself. Thus, just create a new git repository and populate it using the files provided at https://github.com/latextemplates/scientific-thesis-template/archive/master.zip

Recommended LaTeX environments

See LaTeX Editors/IDEs question on TeX.SX for a complete list of LaTeX editors.

Installation hints for Ubuntu

Ubuntu currently ships biber 2.4, so you have to upgrade your texlive distribution. The easiest way is to uninstall the ubuntu package and use install-tl-ubuntu. Then, you can follow the instructions given at http://tex.stackexchange.com/a/55459/9075 to update your texlive distribution. If you do not want to have an updated installation, but fiddle around with dirty patching your installation, please follow http://tex.stackexchange.com/questions/84624/how-to-upgrade-biblatex-properly.

Installation hints for Windows

  • The default installation of MiKTeX ships with incompatible biblatex and biber packages. You have to keep your MiKTeX up to date. In case you followed the linked installation steps, you only have to run "Update MiKTeX". If you installed MiKTeX other ways, you have to run "Update MiKTeX (Admin)" and "Update MiKTeX" and check in both tools for updates (see http://tex.stackexchange.com/a/108490/9075).
  • Install other tools using chocolatey: choco install texstudio sumatrapdf.install latexmk strawberryperl jabref languagetool jre8. This allows you to run choco upgrade all to keep the software updated.
  • Ensure that in the "MiKTeX Package Manager" "biber" and "biblatex-lni" are installed

Recommended setup of MiKTeX

  • Download the basic installer from http://miktex.org/download
  • Start it
  • First screen: Read the license conditions and be sure that you really agree.
  • Second screen: "Shared Installation": Install MiKTeX for: "Only for: username"
  • Third screen: "Installation Directory": Install MiKTeX to: C:\MiKTeX. This enabled browsing for documentation at C:\MiKTeX29\doc\latex
  • Fourth screen: "Settings": Preferred paper: A4 and Install missing packages on the fly: Yes
  • Fifth screen: Press "Start"
  • After the installation:
    1. Open cmd.exe
    2. Execute mpm --update-db
    3. Execute mpm --update
    4. Execute mpm --install=cm-super
    5. Execute initexmf --update-fndb
    6. Execute initexmf --mklinks --force

LaTeX compilation

The template is compiled using normal LaTeX commands. Your LaTeX environment (such as TeXStudio) should take care about the compilation transparently. When the "Package Installation" dialog pops up at TeXStudio, choose your username at "The package will be installed for:" and uncheck "Always show this dialog before installing packages." If you want to include .svg graphics, inkscape has to be in your path.

If you want to compile using the command line, you can use following tools.

Automatic compilation using latexmk

latexmk main-german

Continuous previewing using latexmk

latexmk -pvc main-german

This will open a Sumatra PDF and only works with the supplied configuration.

latexmk configuration

This repository ships a .latexmk which is read by latexmk. It is configured for Windows and especially sets Sumatra PDF as default PDF viewer. You can make this local configuration a global configuration, when you put it at the right place.

If you want to add more packages, configure it there. For instance, for support of makeglossaries see http://tex.stackexchange.com/questions/1226/how-to-make-latexmk-use-makeglossaries.

FAQ

Q: There is an output that biber/biblatex too old

See installation hints of how to update them at different systems.

Q: My Paderborn title page is strange. The boxes seem to be located arbitrarily.

Just run pdflatex again.

Q: I get the error ! pdfTeX error (font expansion): auto expansion is only possible with scalable fonts.

Install the cm-super package using the MiKTeX package manager. Then, run initexmf --mkmaps on the command line. (Long description: http://tex.stackexchange.com/a/324972/9075)

Q: How do I change the appearance of chapter headings?

Edit preambel/chapterheads.tex.

Q: Do I have to do something special for the final version?

  • If you included some version control statements, please remove them. Currently, the template does not support any, but it used to support SVN.
  • By using \largepage and \shortpage, single lines at the bottom or at the top of the page can be manually fixed.
  • Search the PDF for "TODO" or similar things. Remove \usepackage{todonotes} in config.tex.
  • Ensure that you run pdflatex at least three times and that there are no "undefined references".
  • The margins are intended for a duplex printing. Do not change them (or do exactly know what you are doing).

Q: I want to use make instead of latexmk

For those, who have cygwin installed or run a linux machine, this template offers a simple LaTeX makefile. It is not as sophisticated as other projects, but does its job.

make

Make targets:

  • pdf (default): Generates ausarbeitung.pdf
  • aspell: Checks all files using aspell.
  • clean: Removes all temporary files.
  • mrproper: Cleans up and removes also editor backup files.
  • stand: Creates a new PDF with the current status of the thesis.
  • view: Opens the configured viewer
  • 6: Generates a 3x2 postscriptfile using psnup.

Q: Are there any other alternatives to latexmk and make?

Q: Is there any other place to look for further information?

For German users, go to http://texfragen.de/.

Q: I was recommended the Harvard style

This template uses the alphabetic style. That style is explained at the biblatex documentation on page 60:

The alphabetic labels resemble a compact author-year style to some extent, but the way they are employed is similar to a numeric citation scheme. For example, instead of “Jones 1995” this style would use the label “[Jon95]”. “Jones and Williams 1986” would be rendered as “[JW86]”.

We are aware that the University of Stuttgart recommends to use the Hardvard style. However, this style is not common in natural sciences and information science.

Q: Aren't there other templates?

Sure. The Hagenberg Thesis Document Collection seems to be the most promising. However, they currently do not support microtype and not the cover of the University of Stuttgart.

We are collecting alternatives at the issue #25 and plan to add a comparison to each other template.

Contained Files and Directories

Directories

  • graphics Directory containing the figures. By using PDFLaTeX it is possible to use PDFs, JPGs, PNGs, ... We recommend to use PDFs to enable smooth scaling.

Files

Following additional files are included, which do not need to be adapted:

License

The license of this work is CC0, which corresponds to "public domain".

Exceptions

The images in logos are subject to other copyright from other parties:

  • UPB_LOGO_GB_RGB_15.pdf and UPB_Logo_RGB_D_2012.pdf are copyright Paderborn University. Refer to https://www.uni-paderborn.de/universitaet/marketing/design-vorgaben-templates/ for proper use.
  • UBP-background-picture.* are demonstration files generated using an educational edition of Microsoft Office. They can be used in a scientific context only. For commercial use, please change them.
  • UBP-background-picture.pdf is generated out of UBP-background-picture.pptx and is free for personal use only.

scientific-thesis-template's People

Contributors

koppor avatar sven-mayer avatar niklas88 avatar baderas avatar eiselems avatar googol42 avatar siedlerchr avatar jojo134 avatar kmindi avatar miwurster avatar muelletr avatar fakepk avatar qw3ry avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.