bachelor-thesis/README.md


# 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 hints, some goodies
- autobuilding of abstract PDF/A from metadata
- university-wide variants of the front page (nature faculty&bioinformatics!)
- Czech localization with nicely named references

See the [pre-built version](build/thesis.pdf) for details

## 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 are several hints), remember it, erase it.
4. Write the thesis.
5. Submit and defend the thesis.

## PDF/A

With a bit of luck, you should get PDF/A right out of LaTeX.

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

Common PDF/A problems include:

- imported PDF pictures that are not PDF/A.
- the used font does not support PDF/A (including the fonts in imported pictures). See https://martin.hoppenheit.info/blog/2018/pdfa-validation-and-inconsistent-glyph-width-information/ for a very ugly case.

Solutions:

- use `pdfa.sh` to convert 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
- use `pdfa.sh` as a last resort for `thesis.pdf` if everything other fails

## 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. (Thanks!)

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.
v1 2020-05-10 10:03:14 +00:00
improve fonts 2020-05-11 19:43:55 +00:00			`# A slightly improved thesis template`
v1 2020-05-10 10:03:14 +00:00
improve fonts 2020-05-11 19:43:55 +00:00			`What's new:`

details 2020-05-11 20:22:44 +00:00			`- modern packages (biblatex, cleveref, better fonts)`
v1 2020-05-10 10:03:14 +00:00			`- less confusing directory structure`
this 2020-05-12 19:08:51 +00:00			`- slightly more useful examples (figures, diagrams, tables, code listings), structure hints, some goodies`
improve fonts 2020-05-11 19:43:55 +00:00			`- autobuilding of abstract PDF/A from metadata`
make bioinformatics explicit 2020-05-11 20:31:54 +00:00			`- university-wide variants of the front page (nature faculty&bioinformatics!)`
improve fonts 2020-05-11 19:43:55 +00:00			`- Czech localization with nicely named references`
v1 2020-05-10 10:03:14 +00:00
			`See the [pre-built version](build/thesis.pdf) for details`

			`## How-to`

improve fonts 2020-05-11 19:43:55 +00:00			1. Type `make`, check that everything compiles. You should get a `thesis.pdf` that passes the PDF/A validation. If not, complain.
v1 2020-05-10 10:03:14 +00:00			2. Fill in `metadata.tex` and all `xmpdata` files.
			`3. Look at the example code (there are several hints), remember it, erase it.`
			`4. Write the thesis.`
			`5. Submit and defend the thesis.`

PDF/A additions 2020-05-10 20:54:11 +00:00			`## PDF/A`

			`With a bit of luck, you should get PDF/A right out of LaTeX.`

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

			`Common PDF/A problems include:`

			`- imported PDF pictures that are not PDF/A.`
			`- the used font does not support PDF/A (including the fonts in imported pictures). See https://martin.hoppenheit.info/blog/2018/pdfa-validation-and-inconsistent-glyph-width-information/ for a very ugly case.`

			`Solutions:`

			- use `pdfa.sh` to convert 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`
			- use `pdfa.sh` as a last resort for `thesis.pdf` if everything other fails
v1 2020-05-10 10:03:14 +00:00
			`## 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. (Thanks!)`
mind the logo 2020-05-12 19:01:29 +00:00
			`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.`