]> mj.ucw.cz Git - diplomky.git/blobdiff - README
Restructure directory tree
[diplomky.git] / README
diff --git a/README b/README
index 67e104cde80cc483509dd95076df0b85cc3f9ecf..904dbebd2f67988e9fa8015fb86bf0539c896172 100644 (file)
--- a/README
+++ b/README
@@ -1,45 +1,57 @@
-Šablona pro sazbu bakalářské práce v LaTeXu
-Vytvořil Martin Mareš <mj@ucw.cz> roku 2011, aktualizováno 2015
-Tento balík souborů je povoleno libovolně šířit, používat a upravovat.
-Pokud máte jakékoliv připomínky nebo návrhy na vylepšení, dejte mi prosím vědět.
---------------------------------------------------------------------------------
+A template for typesetting a bachelor thesis at MFF UK in LaTeX
 
-Šablona existuje ve dvou verzích -- české (adresář cs) a anglické (en).
+Authors:
 
-Povinné náležitosti úpravy bakalářských prací jsou dány směrnicí děkana
-č. 1/2015. Mimo to existují ještě další doporučení -- ta najdete v souboru
-bp_uprava.pdf. Tento formát pro LaTeX se jimi řídí a snaží se důležité věci
-připomínat komentáři. Přesto si ale celá pravidla přečtěte -- například
-úprava desek práce je popsána pouze tam.
+       Martin Mareš <mj@ucw.cz> -- the current maintainer
+       Arnošt Komárek <komarek@karlin.mff.cuni.cz>
+       Michal Kulich <kulich@karlin.mff.cuni.cz>
 
-Pokud LaTeX ještě neznáte, na webu naleznete mnoho úvodních textů.
-Mně se nejvíce osvědčil http://en.wikibooks.org/wiki/LaTeX. Pár poznámek
-k TeXové sazbě najdete také zde v souboru ukazka.tex.
+This package can be freely distributed, used, and modified.
+If you have any bug report or comment, please tell us.
+--------------------------------------------------------------------------------
 
-Základní nastavení sazby naleznete v souboru prace.tex, ten se také
-odkazuje na ostatní soubory s jednotlivými kapitolami práce. Pečlivě
-si hlavní soubor přečtěte a doplňte všechny chybějící údaje.
+There are two versions of the template -- Czech (directory "cs")
+and English ("en").
 
-Pokud pracujete na Unixovém systému, může se vám hodit ukázkový Makefile --
-stačí spustit program "make" a ten už se postará o přeložení všech souborů
-TeXem.
+Requirements on formatting of bachelor theses are given by Dean's directives
+4/2019, 1/2015, and 7/2016, and by the Rector's directive 72/2017. Other
+guidelines can be found in the example.pdf file. This LaTeX template follows
+the directives; it also tries to emphasize important points in comments. Still,
+we advise you to read the complete rules.
 
-Práci je potřeba kompilovat pdfLaTeXem, starý způsob generování PDF přes
-DVI a PostScript již není podporován.
+If you are not familiar with LaTeX yet, you can find numerous tutorials on
+the Web. One example we like is http://en.wikibooks.org/wiki/LaTeX.
 
-Další materiály o psaní bakalářských prací a odborných textů vůbec najdete
-na http://mj.ucw.cz/vyuka/bc/.
+Basic typographical settings can be found in thesis.tex, which also refers
+to all other files containing individual chapters. Please read the main file
+carefully and fill in the thesis name, author, and other identifiers. You also
+need to update the meta-data file thesis.xmpdata.
 
---------------------------------------------------------------------------------
+The Czech version contains several example chapters with hints on typesetting
+of common expressions. There are not available in the English version yet,
+sorry.
+
+The electronic version of your thesis must be submitted to SIS. It must
+conform to the PDF/A-1a or -2u standard. This template produces PDF/A-2u
+using the pdfx LaTeX package (https://www.ctan.org/tex-archive/macros/latex/contrib/pdfx).
+Please note that many installations of TeX have this package either obsolete
+or broken. So we advise to download the current version of the package and
+unpack it to tex/pdfx/.
+
+Our FAQ on producing PDF/A is currently available in Czech only, but if you
+encounter any problems, please ask Martin Mareš for advice.
 
-Zásadní změny oproti verzi z roku 2011
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+If you are using Windows, beware that MikTeX contains old versions of some
+(mostly mathematical) fonts, which leads to improper PDF/A output. We have
+much better experience with the TeXlive distribution.
 
- - Již pro českou sazbu nepoužíváme starý csLaTeX, nýbrž Babel.
-   Stále ale využíváme tradiční CS-fonty, neboť mají hezčí akcenty.
+If you are using a UNIX system, you might want to use our example Makefile --
+just run "make" to process all files by TeX.
 
- - PDF generujeme přímo pomocí pdfTeXu, stará oklika přes DVI a PS
-   už snad není na žádné aktuální instalaci TeXu potřeba.
+You can also run TeX manually. In this case, you should use pdfTeX and also
+BibTeX for generating bibliography. (The usual order is: pdflatex, bibtex,
+and then pdflatex twice to get cross-references right. Alternatively, you
+can use latexmk.)
 
- - Všechny údaje o práci se nyní definují jako makra v hlavním souboru
-   a automaticky se dosazují na všechna relevantní místa.
+The current development version of this template and other hints on writing
+theses can be found at http://mj.ucw.cz/vyuka/bc/.