From: Martin Mares Date: Thu, 18 Jul 2019 08:14:26 +0000 (+0200) Subject: An English version of README X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=560cf0702638ecab38236fc3084e85e2694cf41b;p=diplomky.git An English version of README --- diff --git a/README b/README index 1ca6113..e44a74d 100644 --- a/README +++ b/README @@ -16,7 +16,7 @@ Povinné náležitosti úpravy bakalářských prací jsou dány směrnicemi dě č. 4/2019, 1/2015 a 7/2016 a opatřením rektora č. 72/2017. Mimo to existují ještě další doporučení -- ta najdete v souboru vzor.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. +pravidla přečtěte. Pokud LaTeX ještě neznáte, na webu naleznete mnoho úvodních textů. Nám se nejvíce osvědčil http://en.wikibooks.org/wiki/LaTeX. diff --git a/README.en b/README.en new file mode 100644 index 0000000..904dbeb --- /dev/null +++ b/README.en @@ -0,0 +1,57 @@ +A template for typesetting a bachelor thesis at MFF UK in LaTeX + +Authors: + + Martin Mareš -- the current maintainer + Arnošt Komárek + Michal Kulich + +This package can be freely distributed, used, and modified. +If you have any bug report or comment, please tell us. +-------------------------------------------------------------------------------- + +There are two versions of the template -- Czech (directory "cs") +and English ("en"). + +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. + +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. + +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. + +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. + +If you are using a UNIX system, you might want to use our example Makefile -- +just run "make" to process all files by TeX. + +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.) + +The current development version of this template and other hints on writing +theses can be found at http://mj.ucw.cz/vyuka/bc/. diff --git a/TODO b/TODO index 6048a33..a20d0b0 100644 --- a/TODO +++ b/TODO @@ -4,8 +4,6 @@ Jaký typ PDFkových anotací produkuje hyperref? Někdy prohlížeče rámečky kolem odkazů neukazují, jindy ne, a například linuxové lp je pak vytiskne. -Anglické README. - Pojmenované věty mají nepěknou tučnou tečku za netučným jménem. Za to ovšem může balíček amsthm a není jasné, jak mu v tom zabránit. Pomocí \newtheoremstyle sice jde předefinovat, jak se tečka sází,