README.en

   1 A template for typesetting a bachelor thesis at MFF UK in LaTeX
   2
   3 Authors:
   4
   5         Martin Mareš <mj@ucw.cz> -- the current maintainer
   6         Arnošt Komárek <komarek@karlin.mff.cuni.cz>
   7         Michal Kulich <kulich@karlin.mff.cuni.cz>
   8
   9 This package can be freely distributed, used, and modified.
  10 If you have any bug report or comment, please tell us.
  11 --------------------------------------------------------------------------------
  12
  13 There are two versions of the template -- Czech (directory "cs")
  14 and English ("en").
  15
  16 Requirements on formatting of bachelor theses are given by Dean's directives
  17 4/2019, 1/2015, and 7/2016, and by the Rector's directive 72/2017. Other
  18 guidelines can be found in the example.pdf file. This LaTeX template follows
  19 the directives; it also tries to emphasize important points in comments. Still,
  20 we advise you to read the complete rules.
  21
  22 If you are not familiar with LaTeX yet, you can find numerous tutorials on
  23 the Web. One example we like is http://en.wikibooks.org/wiki/LaTeX.
  24
  25 Basic typographical settings can be found in thesis.tex, which also refers
  26 to all other files containing individual chapters. Please read the main file
  27 carefully and fill in the thesis name, author, and other identifiers. You also
  28 need to update the meta-data file thesis.xmpdata.
  29
  30 The Czech version contains several example chapters with hints on typesetting
  31 of common expressions. There are not available in the English version yet,
  32 sorry.
  33
  34 The electronic version of your thesis must be submitted to SIS. It must
  35 conform to the PDF/A-1a or -2u standard. This template produces PDF/A-2u
  36 using the pdfx LaTeX package (https://www.ctan.org/tex-archive/macros/latex/contrib/pdfx).
  37 Please note that many installations of TeX have this package either obsolete
  38 or broken. So we advise to download the current version of the package and
  39 unpack it to tex/pdfx/.
  40
  41 Our FAQ on producing PDF/A is currently available in Czech only, but if you
  42 encounter any problems, please ask Martin Mareš for advice.
  43
  44 If you are using Windows, beware that MikTeX contains old versions of some
  45 (mostly mathematical) fonts, which leads to improper PDF/A output. We have
  46 much better experience with the TeXlive distribution.
  47
  48 If you are using a UNIX system, you might want to use our example Makefile --
  49 just run "make" to process all files by TeX.
  50
  51 You can also run TeX manually. In this case, you should use pdfTeX and also
  52 BibTeX for generating bibliography. (The usual order is: pdflatex, bibtex,
  53 and then pdflatex twice to get cross-references right. Alternatively, you
  54 can use latexmk.)
  55
  56 The current development version of this template and other hints on writing
  57 theses can be found at http://mj.ucw.cz/vyuka/bc/.