GithubHelp home page GithubHelp logo

janprovaznik / better-mff-thesis Goto Github PK

View Code? Open in Web Editor NEW

This project forked from exaexa/better-mff-thesis

0.0 0.0 0.0 2.98 MB

A slightly improved variant of the official thesis sample

Shell 1.85% Perl 0.03% TeX 96.81% Makefile 0.39% Dockerfile 0.92%

better-mff-thesis's Introduction

A slightly improved thesis template

What's new:

  • modern packages (biblatex, cleveref, better fonts)
  • less confusing directory structure
  • slightly more useful examples (figures, diagrams, tables, code listings), structure&writing hints, some goodies
  • autobuilding of PDF/A abstracts directly from metadata
  • multiple variants of the front page
    • MFF with the new logo
    • "traditional" UK variant
    • Nature faculty & bioinformatics
  • Czech localization with properly translated references
  • Automated docker-based & CI build options

See the pre-built version for details.

CI configuration

The repository contains valid configuration for both GitLab CI and the GitHub actions. No matter what Git hosting you use, you can always download latest version of your thesis right from the artifacts! The GitHub version additionally pushes the files to GitHub pages to enabler easier sharing (incl. the link above); you can disable that by removing .github/workflow/pages.yml.

How-to

  1. Type make, check that everything compiles. You should get a thesis.pdf that passes the PDF/A validation. If not, complain.
  2. Fill in metadata.tex and all xmpdata files.
  3. Look at the example code (there is plenty of advice to follow), then erase it.
  4. Write the thesis.
  5. Submit and defend the thesis.

Installing LaTeX

LaTeX installation may be hard (especially on various substandard operating systems). On most BSD and GNU-style Linux distributions, it should be sufficient to install some random texlive-* packages (and add more if non-standard TeX functionality is required); see e.g. a complete list for Debian.

Optionally, you can use a Docker container with TeX. You can either build the image yourself from the supplied Dockerfile:

cd docker
docker build -t betterthesis/latex .

...or get some pre-built one (which is usually much faster: image size )

docker pull aergus/latex

After that, you should be able to compile the thesis using this command (change the container name to betterthesis/latex in case you built it yourself):

docker run -u $UID -ti --rm -v $PWD:/th -w /th aergus/latex make

PDF/A

With a bit of luck, you should get a valid PDF/A right out of LaTeX. If you are using GitHub actions or GitLab CI, the CI will run the PDF/A verifier automatically for you.

A PDF/A validator that can point out exact problems is available here: https://github.com/mff-cuni-cz/cuni-thesis-validator

Common PDF/A problems include:

Solutions:

  • use pdfa.sh to convert the imported picture PDFs to PDF/A-compatible form the "hard way" (although this does not retain the PDF/A metadata mark, see comments in the script)
  • read the commentary by Martin Mareš (that describes most of the common problems) here: https://mj.ucw.cz/vyuka/bc/pdfaq.html
  • as a last resort if everything other fails, use pdfa.sh for the whole thesis.pdf

Ideas/improvements/more examples?

Pull requests welcome.

License?

Parts of the code (esp. the title page) are based on the original template (available from the faculty website) by Martin Mareš, Arnošt Komárek, and Michal Kulich. Small and useful fixes were coded or pointed out by Vít Kabele, Jan Joneš, Gabriela Suchopárová, Evžen Wybitul, and many others. (Many thanks to everyone involved!)

University and faculty logos are a property of the respective universities and faculties.

Everything else in this repository is released into the public domain, not encumbered by any kind of copyright at all.

better-mff-thesis's People

Contributors

exaexa avatar jjonescz avatar vitkabele avatar frankmejzlik avatar kukas avatar petrkasp avatar woromi avatar jiriklepl 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.