]> mj.ucw.cz Git - diplomky.git/blobdiff - en/thesis.tex
Fixed multi-line \XXX in English version, which is broken by mkdist
[diplomky.git] / en / thesis.tex
index d141c7e7542d0ac5053f048fa8989e38c12dd22a..2a10da45c4f2463493616fedb1527937ee46fc89 100644 (file)
@@ -11,7 +11,6 @@
 \setlength\topmargin{0mm}
 \setlength\headsep{0mm}
 \setlength\headheight{0mm}
-% Recommended layout mentions line spacing 1.5, but this is not relevant to TeX.
 % \openright makes the following text appear on a right-hand page
 \let\openright=\clearpage
 
 % \setlength\headheight{0mm}
 % \let\openright=\cleardoublepage
 
+%% Generate PDF/A-2u
+\usepackage[a-2u]{pdfx}
+
 %% Character encoding: usually latin2, cp1250 or utf8:
 \usepackage[utf8]{inputenc}
 
-%% Further packages
-\usepackage{graphicx}
-\usepackage{amsthm}
+%% 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{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}
-
-% Translation of the title to Czech
-\def\ThesisTitleCS{Název práce}
+\def\ThesisTitle{Thesis title \X{as in the formal assignment}}
 
 % Author of the thesis
 \def\ThesisAuthor{Name Surname}
 % 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}
-\def\DepartmentCS{Název katedry nebo ústavu}
+\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}
-\def\DeptTypeCS{Katedra}
 
 % Thesis supervisor: name, surname and titles
-\def\Supervisor{Supervisor's Name}
+\def\Supervisor{Supervisor's Name \X{+titles}}
 
 % Supervisor's department (again according to Organizational structure of MFF)
 \def\SupervisorsDepartment{department}
-\def\SupervisorsDepartmentCS{pracoviště}
 
 % Study programme and specialization
 \def\StudyProgramme{study programme}
-\def\Specialization{specialization}
+\def\StudyBranch{study branch}
 
 % An optional dedication: you can thank whomever you wish (your supervisor,
 % consultant, a person who lent the software, etc.)
 Dedication.
 }
 
-% Abstract (around 80-200 words; this is not a copy of your thesis assignment!)
+% Abstract (recommended length around 80-200 words; this is not a copy of your thesis assignment!)
 \def\Abstract{%
-Abstract.
-}
-\def\AbstractCS{%
-Abstract.
+Abstract. \X{Recommended length around 80--200 words. This is not a~copy of your thesis assignment!}
 }
 
-% 3 to 5 keywords, each enclosed in curly braces
+% 3 to 5 keywords (recommended), each enclosed in curly braces
 \def\Keywords{%
-{klíčová} {slova}
-}
-\def\KeywordsCS{%
-{key} {words}
+{key} {words} \X{usually 3 to~5 key words or phrases}
 }
 
 %% The hyperref package for clickable links in PDF and also for storing
 %% metadata to PDF (including the table of contents).
-\usepackage[pdftex,unicode]{hyperref}   % Must follow all other packages
+%% Most settings are pre-set by the pdfx package.
+\hypersetup{unicode}
 \hypersetup{breaklinks=true}
-\hypersetup{pdftitle={\ThesisTitle}}
-\hypersetup{pdfauthor={\ThesisAuthor}}
-\hypersetup{pdfkeywords=\Keywords}
 
-\input title.tex
+% Definitions of macros (see description inside)
+\include{macros}
 
-%%% A page with automatically generated content of the bachelor thesis. For
-%%% a mathematical thesis, it is permissible to have a list of tables and abbreviations,
-%%% if any, at the beginning of the thesis instead of at its end.
+% Title page and various mandatory informational pages
+\begin{document}
+\include{title}
+
+%%% A page with automatically generated table of contents of the bachelor thesis
 
-\openright
-\pagestyle{plain}
-\setcounter{page}{1}
 \tableofcontents
 
 %%% Each chapter is kept in a separate file
 \include{preface}
-\include{chap1}
-\include{chap2}
-
-% An example of LaTeX use (uncomment, if you wish)
-% \include{example}
+\include{chap01}
+\include{chap02}
 
 \include{epilog}
 
 %%% Bibliography
 \include{bibliography}
 
-%%% Tables used in the thesis, if any
-\chapwithtoc{List of Tables}
+%%% Figures used in the thesis (consider if this is needed)
+\listoffigures
+
+%%% 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.}
 
 %%% 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}
-
-%%% Attachments to the bachelor thesis, if any (various additions such
-%%% as programme extracts, diagrams, etc.). Each attachment must be referred to
-%%% at least once from one's own text of the thesis. Attachments are numbered.
-\chapwithtoc{Attachments}
+\XXX{In mathematical theses, it could be better to move the list of abbreviations to the beginning of the thesis.}
+
+%% PHDONLY
+%%% Doctoral theses must contain a list of author's publications
+\chapwithtoc{List of publications}
+\XXX{Doctoral theses must contain a list of author's publications.}
+%% ONLYPHD
+
+%%% 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. 72/2017.
+\appendix
+\chapter{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. 72/2017.}
+
+\section{First Attachment}
 
 \openright
 \end{document}