]> mj.ucw.cz Git - diplomky.git/blobdiff - en/thesis.tex
PDF/A: Stručný návod
[diplomky.git] / en / thesis.tex
index 15551c52cde8126e65b781e4a12595a0eb96ba7f..aa94ebe68bc15371fa069eb1bc9d01eb6b2df1de 100644 (file)
@@ -1,8 +1,8 @@
-%%% Hlavní soubor. Zde se definují základní parametry a odkazuje se na ostatní části. %%%
+%%% The main file. It contains definitions of basic parameters and includes all other parts.
 
-%% Verze pro jednostranný tisk:
-% Okraje: levý 40mm, pravý 25mm, horní a dolní 25mm
-% (ale pozor, LaTeX si sám přidává 1in)
+%% Settings for single-side (simplex) printing
+% Margins: left 40mm, right 25mm, top and bottom 25mm
+% (but beware, LaTeX adds 1in implicitly)
 \documentclass[12pt,a4paper]{report}
 \setlength\textwidth{145mm}
 \setlength\textheight{247mm}
 \setlength\topmargin{0mm}
 \setlength\headsep{0mm}
 \setlength\headheight{0mm}
-% \openright zařídí, aby následující text začínal na pravé straně knihy
+% \openright makes the following text appear on a right-hand page
 \let\openright=\clearpage
 
-%% Pokud tiskneme oboustranně:
+%% Settings for two-sided (duplex) printing
 % \documentclass[12pt,a4paper,twoside,openright]{report}
 % \setlength\textwidth{145mm}
 % \setlength\textheight{247mm}
-% \setlength\oddsidemargin{15mm}
+% \setlength\oddsidemargin{14.2mm}
 % \setlength\evensidemargin{0mm}
 % \setlength\topmargin{0mm}
 % \setlength\headsep{0mm}
 % \setlength\headheight{0mm}
 % \let\openright=\cleardoublepage
 
-%% Použité kódování znaků: obvykle latin2, cp1250 nebo utf8:
-\usepackage[latin2]{inputenc}
-
-%% Ostatní balíčky
-\usepackage{graphicx}
-\usepackage{amsthm}
-
-%% Balíček hyperref, kterým jdou vyrábět klikací odkazy v PDF,
-%% ale hlavně ho používáme k uložení metadat do PDF (včetně obsahu).
-%% POZOR, nezapomeňte vyplnit jméno práce a autora.
-\usepackage[ps2pdf,unicode]{hyperref}   % Musí být za všemi ostatními balíčky
-\hypersetup{pdftitle=Název práce}
-\hypersetup{pdfauthor=Jméno Příjmení}
-
-%%% Drobné úpravy stylu
-
-% Tato makra přesvědčují mírně ošklivým trikem LaTeX, aby hlavičky kapitol
-% sázel příčetněji a nevynechával nad nimi spoustu místa. Směle ignorujte.
-\makeatletter
-\def\@makechapterhead#1{
-  {\parindent \z@ \raggedright \normalfont
-   \Huge\bfseries \thechapter. #1
-   \par\nobreak
-   \vskip 20\p@
-}}
-\def\@makeschapterhead#1{
-  {\parindent \z@ \raggedright \normalfont
-   \Huge\bfseries #1
-   \par\nobreak
-   \vskip 20\p@
-}}
-\makeatother
-
-% Toto makro definuje kapitolu, která není očíslovaná, ale je uvedena v obsahu.
-\def\chapwithtoc#1{
-\chapter*{#1}
-\addcontentsline{toc}{chapter}{#1}
-}
-
-\begin{document}
-
-% Trochu volnější nastavení dělení slov, než je default.
-\lefthyphenmin=2
-\righthyphenmin=2
-
-%%% Titulní strana práce
-
-\pagestyle{empty}
-\begin{center}
-
-\large
-
-Charles University in Prague
-
-\medskip
-
-Faculty of Mathematics and Physics
-
-\vfill
-
-{\bf\Large BACHELOR THESIS}
-
-\vfill
-
-\centerline{\mbox{\includegraphics[width=60mm]{../img/logo.eps}}}
-
-\vfill
-\vspace{5mm}
-
-{\LARGE First and last name of the author}
-
-\vspace{15mm}
-
-% Název práce přesně podle zadání
-{\LARGE\bfseries Title of the thesis}
-
-\vfill
-
-% Název katedry nebo ústavu, kde byla práce oficiálně zadána
-% (dle Organizační struktury MFF UK)
-Name of the department or institute
-
-\vfill
-
-\begin{tabular}{rl}
-
-Supervisor of the bachelor thesis: & First and last name \\
-\noalign{\vspace{2mm}}
-Study programme: & programme \\
-\noalign{\vspace{2mm}}
-Specialization: & specialization \\
-\end{tabular}
-
-\vfill
-
-% Zde doplňte rok
-Prague YEAR
-
-\end{center}
-
-\newpage
-
-%%% Následuje vevázaný list -- kopie podepsaného "Zadání bakalářské práce".
-%%% Toto zadání NENÍ součástí elektronické verze práce, nescanovat.
-
-%%% Na tomto místě mohou být napsána případná poděkování (vedoucímu práce,
-%%% konzultantovi, tomu, kdo zapůjčil software, literaturu apod.)
-
-\openright
-
-\noindent
+%% Generate PDF/A-2u
+\usepackage[a-2u]{pdfx}
+
+%% Character encoding: usually latin2, cp1250 or utf8:
+\usepackage[utf8]{inputenc}
+
+%% Prefer Latin Modern fonts
+\usepackage{lmodern}
+
+%% Further useful packages (included in most LaTeX distributions)
+\usepackage{amsmath}        % extensions for typesetting of math
+\usepackage{amsfonts}       % math fonts
+\usepackage{amsthm}         % theorems, definitions, etc.
+\usepackage{bbding}         % various symbols (squares, asterisks, scissors, ...)
+\usepackage{bm}             % boldface symbols (\bm)
+\usepackage{graphicx}       % embedding of pictures
+\usepackage{fancyvrb}       % improved verbatim environment
+\usepackage{natbib}         % citation style AUTHOR (YEAR), or AUTHOR [NUMBER]
+\usepackage[nottoc]{tocbibind} % makes sure that bibliography and the lists
+                           % of figures/tables are included in the table
+                           % of contents
+\usepackage{dcolumn}        % improved alignment of table columns
+\usepackage{booktabs}       % improved horizontal lines in tables
+\usepackage{paralist}       % improved enumerate and itemize
+\usepackage[usenames]{xcolor}  % typesetting in color
+
+%% SPECIMEN
+% Parts marked as SPECIMEN are used for building the example PDF.
+% When the official template is generated by ./mkdist, all such parts
+% are deleted, as well as all calls of \X and \XXX macros.
+\def\X#1{\textcolor{red}{[#1]}}
+\def\XXX#1{\par\smallskip\noindent \textcolor{red}{[#1]}}
+%% NEMICEPS
+
+%%% Basic information on the thesis
+
+% Thesis title in English (exactly as in the formal assignment)
+\def\ThesisTitle{Thesis title \X{as in the formal assignment}}
+
+% Author of the thesis
+\def\ThesisAuthor{Name Surname}
+
+% Year when the thesis is submitted
+\def\YearSubmitted{YEAR}
+
+% Name of the department or institute, where the work was officially assigned
+% (according to the Organizational Structure of MFF UK in English,
+% or a full name of a department outside MFF)
+\def\Department{Name of the department \X{as per Organizational Structure of MFF UK in English}}
+
+% Is it a department (katedra), or an institute (ústav)?
+\def\DeptType{Department}
+
+% Thesis supervisor: name, surname and titles
+\def\Supervisor{Supervisor's Name \X{+titles}}
+
+% Supervisor's department (again according to Organizational structure of MFF)
+\def\SupervisorsDepartment{department}
+
+% Study programme and specialization
+\def\StudyProgramme{study programme}
+\def\StudyBranch{study branch}
+
+% An optional dedication: you can thank whomever you wish (your supervisor,
+% consultant, a person who lent the software, etc.)
+\def\Dedication{%
 Dedication.
+}
 
-\newpage
-
-%%% Strana s čestným prohlášením k bakalářské práci
-
-\vglue 0pt plus 1fill
-
-\noindent
-I declare that I carried out this bachelor thesis independently, and only with the cited
-sources, literature and other professional sources.
-
-\medskip\noindent
-I understand that my work relates to the rights and obligations under the Act No.
-121/2000 Sb., the Copyright Act, as amended, in particular the fact that the Charles
-University in Prague has the right to conclude a license agreement on the use of this
-work as a school work pursuant to Section 60 subsection 1 of the Copyright Act.
-
-\vspace{10mm}
-
-\hbox{\hbox to 0.5\hsize{%
-In ........ date ............
-\hss}\hbox to 0.5\hsize{%
-signature of the author
-\hss}}
-
-\vspace{20mm}
-\newpage
-
-%%% Povinná informační strana bakalářské práce
-
-\vbox to 0.5\vsize{
-\setlength\parindent{0mm}
-\setlength\parskip{5mm}
-
-Název práce:
-Název práce
-% přesně dle zadání
-
-Autor:
-Jméno a příjmení autora
-
-Katedra:  % Případně Ústav:
-Název katedry či ústavu, kde byla práce oficiálně zadána
-% dle Organizační struktury MFF UK
-
-Vedoucí bakalářské práce:
-Jméno a příjmení s tituly, pracoviště
-% dle Organizační struktury MFF UK, případně plný název pracoviště mimo MFF UK
-
-Abstrakt:
-% abstrakt v rozsahu 80-200 slov; nejedná se však o opis zadání bakalářské práce
-
-Klíčová slova:
-% 3 až 5 klíčových slov
-
-\vss}\nobreak\vbox to 0.49\vsize{
-\setlength\parindent{0mm}
-\setlength\parskip{5mm}
-
-Title:
-% přesný překlad názvu práce v angličtině
-
-Author:
-Jméno a příjmení autora
-
-Department:
-Název katedry či ústavu, kde byla práce oficiálně zadána
-% dle Organizační struktury MFF UK v angličtině
-
-Supervisor:
-Jméno a příjmení s tituly, pracoviště
-% dle Organizační struktury MFF UK, případně plný název pracoviště
-% mimo MFF UK v angličtině
+% Abstract (recommended length around 80-200 words; this is not a copy of your thesis assignment!)
+\def\Abstract{%
+Abstract. \X{Recommended length around 80--200 words. This is not a~copy of your thesis assignment!}
+}
 
-Abstract:
-% abstrakt v rozsahu 80-200 slov v angličtině; nejedná se však o překlad
-% zadání bakalářské práce
+% 3 to 5 keywords (recommended), each enclosed in curly braces
+\def\Keywords{%
+{key} {words} \X{usually 3 to~5 key words or phrases}
+}
 
-Keywords:
-% 3 až 5 klíčových slov v angličtině
+%% The hyperref package for clickable links in PDF and also for storing
+%% metadata to PDF (including the table of contents).
+%% Most settings are pre-set by the pdfx package.
+\hypersetup{unicode}
+\hypersetup{breaklinks=true}
 
-\vss}
+% Definitions of macros (see description inside)
+\include{macros}
 
-\newpage
+% Title page and various mandatory informational pages
+\begin{document}
+\include{title}
 
-%%% Strana s automaticky generovaným obsahem bakalářské práce. U matematických
-%%% prací je přípustné, aby seznam tabulek a zkratek, existují-li, byl umístěn
-%%% na začátku práce, místo na jejím konci.
+%%% A page with automatically generated table of contents of the bachelor thesis
 
-\openright
-\pagestyle{plain}
-\setcounter{page}{1}
 \tableofcontents
 
-%%% Jednotlivé kapitoly práce jsou pro přehlednost uloženy v samostatných souborech
+%%% Each chapter is kept in a separate file
 \include{preface}
-\include{chap1}
-\include{chap2}
-
-% Ukázka použití některých konstrukcí LateXu (odkomentujte, chcete-li)
-% \include{example}
+\include{chap01}
+\include{chap02}
 
 \include{epilog}
 
-%%% Seznam použité literatury
+%%% Bibliography
 \include{bibliography}
 
-%%% Tabulky v bakalářské práci, existují-li.
-\chapwithtoc{List of Tables}
+%%% Figures used in the thesis (consider if this is needed)
+\listoffigures
 
-%%% Použité zkratky v bakalářské práci, existují-li, včetně jejich vysvětlení.
-\chapwithtoc{List of Abbreviations}
+%%% Tables used in the thesis (consider if this is needed)
+%%% In mathematical theses, it could be better to move the list of tables to the beginning of the thesis.
+\listoftables
+\XXX{In mathematical theses, it could be better to move the list of tables to the beginning of the thesis.}
 
-%%% Přílohy k bakalářské práci, existují-li (různé dodatky jako výpisy programů,
-%%% diagramy apod.). Každá příloha musí být alespoň jednou odkazována z vlastního
-%%% textu práce. Přílohy se číslují.
+%%% Abbreviations used in the thesis, if any, including their explanation
+%%% In mathematical theses, it could be better to move the list of abbreviations to the beginning of the thesis.
+\chapwithtoc{List of Abbreviations}
+\XXX{In mathematical theses, it could be better to move the list of abbreviations to the beginning of the thesis.}
+
+%%% Attachments to the bachelor thesis, if any. Each attachment must be
+%%% referred to at least once from the text of the thesis. Attachments
+%%% are numbered.
+%%%
+%%% The printed version should preferably contain attachments, which can be
+%%% read (additional tables and charts, supplementary text, examples of
+%%% program output, etc.). The electronic version is more suited for attachments
+%%% which will likely be used in an electronic form rather than read (program
+%%% source code, data files, interactive charts, etc.). Electronic attachments
+%%% should be uploaded to SIS and optionally also included in the thesis on a~CD/DVD.
+%%% Allowed file formats are specified in provision of the rector no. 23/2016.
 \chapwithtoc{Attachments}
+\XXX{Attachments to the bachelor thesis, if any. Each attachment must be referred to at least once from the text of the thesis. Attachments are numbered.}
+\XXX{The printed version should preferably contain attachments, which can be read (additional tables and charts, supplementary text, examples of program output, etc.). The electronic version is more suited for attachments which will likely be used in an electronic form rather than read (program source code, data files, interactive charts, etc.). Electronic attachments should be uploaded to SIS and optionally also included in the thesis on a~CD/DVD. Allowed file formats are specified in provision of the rector no. 23/2016.}
 
 \openright
 \end{document}