|
|
% This file should be replaced with your file with an appendices (headings below are examples only)
|
|
|
|
|
|
% For compilation piecewise (see projekt.tex), it is necessary to uncomment it and change
|
|
|
%\documentclass[../projekt.tex]{subfiles}
|
|
|
%\begin{document}
|
|
|
|
|
|
% Placing of table of contents of the memory media here should be consulted with a supervisor
|
|
|
%\chapter{Contents of the included storage media}
|
|
|
|
|
|
%\chapter{Manual}
|
|
|
|
|
|
%\chapter{Configuration file}
|
|
|
|
|
|
%\chapter{Scheme of RelaxNG configuration file}
|
|
|
|
|
|
%\chapter{Poster}
|
|
|
|
|
|
\chapter{How to use this template}
|
|
|
\label{jak}
|
|
|
|
|
|
This chapter describes individual parts of the template, followed by a brief instructions on how to use it. If you have any questions, comments etc, feel free to email them to \texttt{sablona@fit.vutbr.cz}.
|
|
|
|
|
|
\section*{Template parts description}
|
|
|
|
|
|
Once you extract the template, you will find the following files and directories:
|
|
|
\begin{DESCRIPTION}
|
|
|
\item [bib-styles] Literature styles (see below).
|
|
|
\item [obrazky-figures] Directory for your images. Currently contains \texttt{placeholder.pdf} (a.k.a TODO image -- see below) and image keep-calm.png to demonstrate inserting raster images (you don't submit these images with your thesis). It is advised to use shorter directory name, so that it is only in your chosen language.
|
|
|
\item [template-fig] Template images (BUT logo).
|
|
|
\item [fitthesis.cls] Template (design definition).
|
|
|
\item [Makefile] Makefile used to compile the project, count standard pages etc. (see below).
|
|
|
\item [projekt-01-kapitoly-chapters-en.tex] File for Your text (replace it's contents).
|
|
|
\item [projekt-20-literatura-bibliography.bib] Reference list (see below).
|
|
|
\item [projekt-30-prilohy-appendices-en.tex] File for your appendices (replace it's contents).
|
|
|
\item [projekt.tex] Main project file -- definitions of formal parts.
|
|
|
\end{DESCRIPTION}
|
|
|
|
|
|
The style of literature in the template is from Ing. Radek Pyšný \cite{Pysny}, whose work was improved by prof. Adam Herout, dr. Jaroslav Dytrych and Mr. Karel Hanák to comply with the norm and support all frequently used types of citations. Its documentation can be found in the appendix
|
|
|
|
|
|
Aside from compilation to PDF, the Makefile also offers additional functions:
|
|
|
\begin{itemize}
|
|
|
\item rename files (see below),
|
|
|
\item count standard pages,
|
|
|
\item run a wave that adds unbreakable spaces,
|
|
|
\item compress (zip) the result, ready to be sent to your supervisor and checked (make sure that all the files you've added are included, if not, add them manually).
|
|
|
\end{itemize}
|
|
|
|
|
|
Keep in mind that the wave is not perfect. You always need to check whether or not there is something inappropriate at the end of a line manually -- see Online language handbook\footnote{Internetová jazyková příručka \url{http://prirucka.ujc.cas.cz/?id=880}}.
|
|
|
|
|
|
Similar rules apply also in English - see eg. article Run Ragged\footnote{Run Ragged\url{https://24ways.org/2013/run-ragged/}}, according to which there should be no prepositions, dash or short words (2--3 letters) at the end of the lines, the two lines following each other should not end with a comma and line break should not be also in the phrases from 2-3 words.
|
|
|
|
|
|
\paragraph {Pay attention to page numbering!} If the table of contents is 2 pages long and the second page contains only \uv{Enclosures} and \uv{List of enclosures} (but there is no enclosure), the page numbering is changed by 1 (table of contents and contents \uv{mismatch}). The same thing happens if the second or third page contains only \uv{References} and there's a chance that this can occur in other situations too. There are multiple solutions to this (from editing the table of contents, setting the page counter all the way to more sophisticated methods). \textbf{Check the page numbering before you submit your thesis!}
|
|
|
|
|
|
\section*{Recommendations for working with the template}
|
|
|
|
|
|
\begin{enumerate}
|
|
|
\item \textbf{Make sure you have the latest version of template.} If you have a template from last year, there should be a newer version (updated information, fixed errors etc.) available at the faculty or study advisor web pages.
|
|
|
\item \textbf{Choose a language}, that you want to use for your technical report (czech, slovak or english) and consult your supervisor about your choice (unless it was agreed upon in advance). If your language of choice is not czech, set the respective template parameter in file projekt.tex (e.g.: \verb|document|\verb|class[english]{fitthesis}| and translate the declaration and acknowledgement to english or slovak).
|
|
|
\item \textbf{Rename the files.} When you extract the files, there should be a file named projekt.tex. If you compile it, it will create a PDF with technical report named projekt.pdf. If multiple students send their supervisor projekt.pdf to have it checked, they have to rename them. For that reason, it is advised to rename the file so that it contains your login and (if needed, abbreviated) work topic. Avoid using spaces, diacritic and special symbols. An appropriate name for your file can look like this: \uv{xlogin00-Cleaning-and-extraction-of-text.tex}. You can use the included Makefile to rename it:
|
|
|
\begin{verbatim}
|
|
|
make rename NAME=xlogin00-Cleaning-and-extraction-of-text
|
|
|
\end{verbatim}
|
|
|
\item Fill in the required information in file, that was originally named projekt.tex, that means type, year (of submission), thesis title, author's name, department (according to specification), supervisor's titles and name, abstract, keywords and other formal requirements.
|
|
|
\item Replace the contents of thesis chapters, references and enclosures files with the contents of your technical report. Individual enclosures or thesis chapters can be saved to separate files -- if you choose this approach, it is advised to comply with the file naming convention, and the number will be followed by the chapter title.
|
|
|
\item If you don't need enclosures, comment the respective part in projekt.tex and erase everything from the corresponding file or delete it. Don't try to come up with an aimless enclosures just to have something in that file. An appropriate enclosure can be the contents of included memory medium.
|
|
|
\item Delete the chapter and attachment files for a language you haven't used (with or without \texttt{-en}).
|
|
|
\item Assignment that you download in PDF from BUT IS (link \uv{Thesis assignment}) save to file \texttt{zadani.pdf} and enable its insertion into work by appropriate template parameter (\verb|document|\verb|class[zadani]{fitthesis}|) in \texttt{projekt.tex}.
|
|
|
\item If you don't want to print references in color (i cannot recommend this without consulting your supervisor), you'll need to create a second PDF for printing and set the template printing parameter:\\ (\verb|document|\verb|class[english,zadani,print]{fitthesis}|). Colored logo must not be printed in black and white.
|
|
|
\item The binder templace where the thesis will be typeset can be generated in faculty IS at specification. Can be enabled for dissertation using the \tt cover \rm parameter in template.
|
|
|
\item Don't forget that source files and (both versions) PDF has to be on a CD or other medium included in the technical report.
|
|
|
\end{enumerate}
|
|
|
|
|
|
\subsection*{Instructions for double-sided printing}
|
|
|
\begin{itemize}
|
|
|
\item \textbf{It is advised to consult your supervisor about double-sided printing.}
|
|
|
\item If you used double-sided printing for your thesis and it's thickness is smaller than the thickness of the binder, it doesn't look too good.
|
|
|
\item Enabled using the following template parameter:\\ \verb|\document|\verb|class[twoside]{fitthesis}|
|
|
|
\item After printing a double-sided sheet, make sure that the canon of page construction is in the same position on both pages. Inferior printers with duplex printing unit usually cause a shift by 1--3 mm. This can be solved with some printers. Print the odd pages first, put them back into the same tray and print the even pages.
|
|
|
\item Leave a blank page after title page, table of contents, references, list of tables, list of appendices and other lists to make sure that the following part starts on an odd page (\texttt{\textbackslash cleardoublepage}).
|
|
|
\item Check the final result thoroughly.
|
|
|
\end{itemize}
|
|
|
|
|
|
\subsection*{Paragraph style}
|
|
|
|
|
|
Paragraphs have justified alignment and there are multiple methods for formatting them. In Czech paper literature, a paragraph indentation method is common, where each paragraph of the text have the first line of a paragraph indented by about one to two quads, that is, about two widths of the capital letter M of the base text (always about the same preselected value). In this case, the last line of the previous paragraph and the first line of the following paragraph are not separated by a vertical space. The interleaving between these lines is the same as the interleaving inside the paragraph \cite{fitWeb}.
|
|
|
|
|
|
Another method is indenting paragraphs, which is common for electronic typesetting and for English texts. In this method, the first line of a paragraph is not indented and a vertical space of approximately half of a line is inserted between the paragraphs. Both methods can be used in the thesis, however, the latter method is often more suitable. Methods should not be combined.
|
|
|
|
|
|
One of the above methods is set as the default in the template, the other can be selected by the template parameter \uv{\tt odsaz\rm }.
|
|
|
|
|
|
|
|
|
\subsection*{Useful tools}
|
|
|
\label{nastroje}
|
|
|
|
|
|
The following list is not a list of all useful tools. If you have experience with a certain tool, feel free to use it. However, if you don't know which tool to choose, consider the ones listed below:
|
|
|
|
|
|
\begin{description}
|
|
|
\item[\href{http://miktex.org/download}{MikTeX}] \LaTeX{} for Windows -- a distribution with simple installation and great automated package downloading. MikTeX even has it's own editor, but I highly recommend TeXstudio.
|
|
|
\item[\href{http://texstudio.sourceforge.net/}{TeXstudio}] Portable opensource GUI for \LaTeX{}. Ctrl+click switches between source text and PDF. Integrated spell checker\footnote{Spell checker for czech version can be installed from \url{https://extensions.openoffice.org/de/project/czech-dictionary-pack-ceske-slovniky-cs-cz}}, syntax highlighter etc. To use this tool, you need to first install MikTeX or another \LaTeX{} distribution.
|
|
|
\item[\href{http://www.winedt.com/}{WinEdt}] A good combination for Windows is WinEdt + MiKTeX. WinEdt is a GUI for Windows, and if you want to use it, you need to first install \href{http://miktex.org/download}{MikTeX} or \href{http://www.tug.org/texlive/}{TeX Live}.
|
|
|
\item[\href{http://kile.sourceforge.net/}{Kile}] Editor for KDE (Linux) desktop environment. Real-time preview. To use this tool, you need to have \href{http://www.tug.org/texlive/}{TeX Live} and Okular installed.
|
|
|
\item[\href{http://jabref.sourceforge.net/download.php}{JabRef}] Neat and simple Java program for bibliography (references) file management. No need to learn anything -- provides a simple window and a form for entry editing.
|
|
|
\item[\href{https://inkscape.org/en/download/}{InkScape}] Portable opensource vector graphic (SVG and PDF) editor. Excellent tool to use to create images for technical text. Difficult to master, but the results are worth it.
|
|
|
\item[\href{https://git-scm.com/}{GIT}] Great tool for teamwork when it comes to projects, but can be incredibly useful even to a single author. Simple version control system, backup options and transfer between multiple computers.
|
|
|
\item[\href{http://www.overleaf.com/}{Overleaf}] Online \LaTeX{} tool. A real-time compilation of source text that allows for simple collaboration (supervisor can continuously keep an eye on the progress made), move to a place in source file just by clicking in the PDF preview, spell checker etc. There are some limitations to what you can do if you want to use it for free (some people are comfortable with it for dissertation, others can run into it while they write a~bachelor's thesis) and it is rather slow for long texts. FIT BUT has for students and employees of a license, which can be activated on \url{https://www.overleaf.com/edu/but}.
|
|
|
\end{description}
|
|
|
|
|
|
Note: Overleaf does not use template Makefile -- to get compilation to work, you need to go to the menu and select \tt projekt.tex \rm as s Main document.
|
|
|
|
|
|
\chapter{Writing english texts}
|
|
|
\label{anglicky}
|
|
|
This chapter is taken from web pages of Jan Černocký \cite{CernockyEnglish}.
|
|
|
|
|
|
A lot of people write their technical reports in english (which is good!), but they make a~lot of unnecesary mistakes (which is bad!). I'm not an english export myself, but I've been using this language for a while now to write, read and even communicate -- this chapter contains a handful of important things. If you want to be certain that your thesis or article is 100\,\% correct, your best bet is to hire a native speaker (preferably someone who is technically capable and understands what you write about \ldots).
|
|
|
|
|
|
|
|
|
\section*{In general}
|
|
|
|
|
|
\begin{itemize}
|
|
|
\item{Before you jump into it head first, I suggest you read a handful of technical articles written in english and try to remember or preferably understand how you should approach writing one yourself.}
|
|
|
\item{Always use a spell checking tools -- built in tools in Word, or in OpenOffice. If you work on Linux, I suggest you use ISPELL. Some spell checking (I think it's the one in PSPad) are not very good and ignore a lot of mistakes.}
|
|
|
\item{Use grammer checking tools. I'm not entirely sure if there is one available for Linux, but the one in Word is fairly decent and if it underlines anything with green color, it's probably wrong. You can even copy and paste Latex source code here, fix any and all grammar errors and save it as a clean text again. If you use vim, there's a~built in grammar checking tool too, and it's capable of detecting typos and errors in basic grammar. Write this in the first line of your thesis tex file:
|
|
|
\begin{verbatim}
|
|
|
% vim:spelllang=en_us:spell
|
|
|
\end{verbatim}
|
|
|
(alternatively \texttt{en\_gb} for OED english) \textit{Editor's note:} There is a very good online tool Grammarly\footnote{\url{https://www.grammarly.com/}}, with free basic version.
|
|
|
}
|
|
|
\item{Online dictionaries are good, but don't rely on them in every situation. Usually you get multiple choices and not all of them are correct for the given context.}
|
|
|
\item{\begin{samepage}You can probably figure out what the correct option is by looking each option up and seeing the context in which they're used, example given: ``advantage/privilege/facility of approach''. Online dictionaries give you a handful of results. Look them up one by one using google search:
|
|
|
\begin{verbatim}
|
|
|
"advantage of this approach" 1100000 hits
|
|
|
"privilege of this approach" 6 hits
|
|
|
"facility of this approach" 16 hits
|
|
|
\end{verbatim}
|
|
|
I'm not saying it's 100\,\% correct, but at least you have something to go on. This can be used to find the correct connectives (e.g. ``among two cases'' or ``between two cases''?)\end{samepage}}
|
|
|
\end{itemize}
|
|
|
|
|
|
\section*{SVOMPT and concord}
|
|
|
|
|
|
The structure of an english sentence is SVOPMT: SUBJECT VERB OBJECT MANNER PLACE TIME and there's no other way around it. It is not a flexible structure. There are possibly exceptions in things like a theater play, where something needs to be emphasized. Subject must be present in every single single sentence, people tend to forget as some languages have a sentence structure where the subject can be implicit and not mentioned. SVOMPT applies to dependent clauses too!
|
|
|
\begin{verbatim}
|
|
|
BAD: We have shown that is faster than the other function.
|
|
|
GOOD: We have shown that it is faster than the other function.
|
|
|
\end{verbatim}
|
|
|
|
|
|
\noindent Concord or grammatical agreement between two words in a sentence -- it sounds silly, but people make countless mistakes here.
|
|
|
|
|
|
\begin{verbatim}
|
|
|
he has
|
|
|
the users have
|
|
|
people were
|
|
|
\end{verbatim}
|
|
|
|
|
|
\section*{Articles}
|
|
|
|
|
|
Articles in english are a nightmare and almost all of us fail to use them correctly. The basic rule is, that if there's a particular noun, it's preceeded by ``the''. Definite articles must be in following phrases:
|
|
|
\begin{verbatim}
|
|
|
the first, the second, ...
|
|
|
the last
|
|
|
the most (superlatives and adverbs) ...
|
|
|
the whole
|
|
|
the following
|
|
|
the figure, the table.
|
|
|
the left, the right - on the left pannel, from the left to the right ...
|
|
|
\end{verbatim}
|
|
|
|
|
|
\noindent On the contrary, there can't be an article when you're referring to a specific figure, chapter, etc.
|
|
|
\begin{verbatim}
|
|
|
in Figure 3.2
|
|
|
in Chapter 7
|
|
|
in Table 6.4
|
|
|
\end{verbatim}
|
|
|
|
|
|
\begin{samepage}
|
|
|
\noindent The use of ``a'' and ``an'' is based on the pronounciation, rather than how the word is written:
|
|
|
\begin{verbatim}
|
|
|
an HMM
|
|
|
an XML
|
|
|
a universal model
|
|
|
a user
|
|
|
\end{verbatim}
|
|
|
\end{samepage}
|
|
|
|
|
|
\section*{Verbs}
|
|
|
|
|
|
Passive voice can be tricky -- regular verbs are usually not a problem, irregular verbs however are a common source of errors, typically
|
|
|
\begin{verbatim}
|
|
|
packet was sent (rather than send)
|
|
|
approach was chosen (rather than choosed)
|
|
|
\end{verbatim}
|
|
|
\noindent \ldots most of the time, the spell checker will correct it, but it's not guaranteed.
|
|
|
|
|
|
Tenses are a mess at times. If something just is in general, use present tense. If you did something, use past tense. If you got results that already exist and you just discuss them, use present tense. Try to avoid complicated tenses such as present perfect or worse past perfect if you're not 100\,\% sure.
|
|
|
\begin{verbatim}
|
|
|
JFA is a technique that works for everyone in speaker recognition.
|
|
|
We implemented it according to Kenny's recipe in \cite{Kenny}.
|
|
|
12000 segments from NIST SRE 2006 were processed. When compared
|
|
|
with a GMM baseline, the results are completely bad.
|
|
|
\end{verbatim}
|
|
|
|
|
|
\section*{Sentence length and structure}
|
|
|
|
|
|
\begin{itemize}
|
|
|
\item{Try to write shorter sentences. If you sentence is 5 lines long, it's probably a pain to read, if it can even be done.}
|
|
|
\item{Comma is a powerful tool and you should use it for your sentence structure. Use a~comma to seperate the initial dependent clause from the main independent clause. Sometimes it is appropriate to put a comma just before ``and'' (unlike other languages)!}
|
|
|
\end{itemize}
|
|
|
\begin{verbatim}
|
|
|
In this chapter, we will investigate into ...
|
|
|
The first technique did not work, the second did not work as well,
|
|
|
and the third one also did not work.
|
|
|
\end{verbatim}
|
|
|
|
|
|
\section*{The specifics of a technical text}
|
|
|
|
|
|
When writing a technical text, don't use common phrases such as
|
|
|
\begin{verbatim}
|
|
|
he's
|
|
|
gonna
|
|
|
Petr's working on ...
|
|
|
\end{verbatim}
|
|
|
\noindent and others. The only tolerated thing is ``doesn't'', but you can never go wrong with ``does not''.
|
|
|
|
|
|
\begin{samepage}
|
|
|
\noindent Technical texts utilize passive voice a lot more than active voice:
|
|
|
\begin{verbatim}
|
|
|
BAD: In this chapter, I describe used programming languages.
|
|
|
GOOD: In this chapter, used programming languages are described.
|
|
|
\end{verbatim}
|
|
|
\end{samepage}
|
|
|
|
|
|
If you want to use active voice, it's more common to use ``we'', even though you work alone. ``I'', ``my'', etc. are only used when you need to emphasize that you are the person of utmost importance, for example in the conclusion or when discussing ``original claims'' in disertation.
|
|
|
|
|
|
|
|
|
\paragraph{Common erros in words}
|
|
|
|
|
|
\begin{itemize}
|
|
|
\item{Pay attention to his/hers, it's not ``it's'' but ``its''}
|
|
|
\item{Image is not picture, it's figure.}
|
|
|
\item{The connective is ``than'', not ``then'' -- bigger than this, smaller than this \ldots very common error! ``Then'' is used in the context of time.}
|
|
|
\end{itemize}
|
|
|
|
|
|
|
|
|
\chapter{Checklist}
|
|
|
\label{checklist}
|
|
|
This checklist was taken from a template for academic work, that is available on Adam Herout's blog \cite{Herout}, based on the ideas of Igor Szöke\footnote{\url{http://blog.igor.szoke.cz/2017/04/predstartovni-priprava-letu-neni.html}}, with their permission.
|
|
|
|
|
|
A big part of the safety of air transport are checklists. They have checklists for basically anything and everything, even the most cut-and-dry procedures. If a pilot can get over the tedious process of marking off every single checkbox of a procedure, you can as well. Make a checklist of your own before you submit your thesis. \bf Yes, really: \rm print it, grab a pencil and check every single item on the list. It will make your life easier –- avoid unnecessary errors that can be fixed within a couple minutes –- as well as others', at very least your supervisor and reviewer of your thesis.
|
|
|
|
|
|
\subsection*{Structure}
|
|
|
\begin{checklist}
|
|
|
\item You can tell that the assignment was completed just by looking at the chapter titles as well as their structures.
|
|
|
\item There is no chapter with less than four pages (except for introduction and conclusion). And if so, I discussed this with my supervisor and they gave me a green light.
|
|
|
\end{checklist}
|
|
|
|
|
|
\subsection*{Figures and charts}
|
|
|
\begin{checklist}
|
|
|
\item Every single image and table was checked and their position is close to the text that references them. In other words, they’re easy to find.
|
|
|
\item Every single image and table has a good enough caption, to ensure that the figure makes sense on it’s own, without the necessity to read the text. (There’s no harm in a long caption.)
|
|
|
\item If an image is taken from somewhere, it is mentioned in the caption: “Taken from [X].”
|
|
|
\item Texts in all images have a font size similar to the surrounding text (neither signifficantly larger, nor signifficantly smaller).
|
|
|
\item Charts and schemes are vector graphics (eg. in PDF).
|
|
|
\item Screenshots don‘t use lossy compression (they‘re in PNG).
|
|
|
\item All images are referenced in the text.
|
|
|
\item Axes in charts have their captions (name of the axis, units of measurement, values) and a grind if need be.
|
|
|
\end{checklist}
|
|
|
|
|
|
\subsection*{Equations}
|
|
|
\begin{checklist}
|
|
|
\item Identifiers and their indexes in equations are single letters (except for rather uncommon cases like $t_{max}$).
|
|
|
\item Equations are numbered.
|
|
|
\item All the variables and functions that haven‘t been explained yet are explained below (or rarely above) the equation.
|
|
|
\end{checklist}
|
|
|
|
|
|
\subsection*{Citations}
|
|
|
\begin{checklist}
|
|
|
\item \bf All used sources are cited. \rm
|
|
|
\item URL adresses referencing services, projects, sources, github, etc. are referenced using \verb|\footnote{\url{…}}|.
|
|
|
\item URL adresses in citations are only present, if necessary – article is cited like an article (author, title, where and when was it published), not using URL.
|
|
|
\item Citations have author, title, publisher (conference title), year of publishing. If a~citation does not have either of these, there is a good explanation for this special case and my supervisor agreed.
|
|
|
\item If there is anything taken over from some other work in the program source code, it is properly cited therein in conformance with the license.
|
|
|
\item If an essential part of the source code of the program is taken over, this is mentioned in the text of the thesis and the source is cited.
|
|
|
\end{checklist}
|
|
|
|
|
|
\subsection*{Typography}
|
|
|
\begin{checklist}
|
|
|
\item No line extends past the right margin.
|
|
|
\item There is no single-letter preposition at the end of a line (fixed using unbreakable space \verb|~|).
|
|
|
\item Number of image, table, equation, citation is never a first item of a new line (fixed using unbreakable space \verb|~|).
|
|
|
\item There is no space before a numeric reference to a footnote (like this\footnote{footnote example}, not like this \footnote{another footnote example}).
|
|
|
\end{checklist}
|
|
|
|
|
|
\subsection*{Language}
|
|
|
\begin{checklist}
|
|
|
\item I used spellchecker and there were no typos in the text.
|
|
|
\item I had someone else read my thesis (at least one person), that knows czech / slovak / english well.
|
|
|
\item Someone who knows english well checked the abstract in a czech or slovak written abstract thesis.
|
|
|
\item No part of the text is written in second person (you).
|
|
|
\item If first person is used (i, we), a subjective matter is being described (i decided, i~designed, i focused on, i found out, etc.).
|
|
|
\item There are no colloquialisms in the text.
|
|
|
\item There are no {\it default} words in the text.
|
|
|
\end{checklist}
|
|
|
|
|
|
\subsection*{Result is on a data medium, i.e. software}
|
|
|
\begin{checklist}
|
|
|
\item I have a non-rewritable data medium ready.
|
|
|
\begin{itemize}
|
|
|
\item CD-R,
|
|
|
\item DVD-R,
|
|
|
\item DVD+R in ISO9660 format (with RockRidge and/or Jolliet extension) or UDF,
|
|
|
\item SD (Secure Digital) card in FAT32 or exFAT format, the card is set to write-protected mode
|
|
|
\end{itemize}
|
|
|
\item If the result is online (service, application, …), URL is visible in introduction and conclusion.
|
|
|
\item The medium contains the following mandatory items:
|
|
|
\begin{itemize}
|
|
|
\item source codes (e.g. Matlab, C/C++, Python, \ldots)
|
|
|
\item libraries necessary for compilation,
|
|
|
\item compiled solution,
|
|
|
\item PDF containing a technical report,
|
|
|
\item text source code (\LaTeX{}),
|
|
|
\end{itemize}
|
|
|
and the following optional items after consulting your supervisor:
|
|
|
\begin{itemize}
|
|
|
\item relevant (e.g. testing) data,
|
|
|
\item demo video,
|
|
|
\item poster in PDF
|
|
|
\item \ldots
|
|
|
\end{itemize}
|
|
|
\item Source codes are refactorized, commented and labelled with an authorship header so that others can tell what they actually are.
|
|
|
\item Any and all snippets of code taken from another sources are properly cited -- differentiated using a opening and in case of multiple lines of code a closing comment. Comments contain everything that the license on web (always try to find out what the license is -- for example, Stack Overflow\footnote{\url{https://stackoverflow.blog/2009/06/25/attribution-required/}} has a very strict citation policy).
|
|
|
\end{checklist}
|
|
|
|
|
|
\subsection*{Submission}
|
|
|
\begin{checklist}
|
|
|
\item Do I want to delay (by at most 3 years) the publication ? If so, I will submit an application (in IS) at least a month prior to the submission of the academic work, and I'll include attitude of the company that the intellectual property belongs to and needs to be protected.
|
|
|
\item I have at least minimum number of standard pages (can be calculated using Makefile and by adding number of pages that images translate to). If I'm just under the minimum, I consulted my supervisor about it.
|
|
|
\item If I want a two-sided print, I consulted my supervisor about it and I've used correct template settings for two-sided printing. Chapters begin on odd pages.
|
|
|
\item Technical report is bound in a bookbindery (at least one print, both prints if I'm delaying the publishing).
|
|
|
\item Title page is followed by the specification (in other words, downloaded from IS and inserted into the template)
|
|
|
\item Abstract and keywords are uploaded in IS.
|
|
|
\begin{itemize}
|
|
|
\item There are no \verb|~| characters for non-breaking spaces in the abstract and keywords in IS.
|
|
|
\end{itemize}
|
|
|
\item PDF of thesis (with clickable links) is in IS.
|
|
|
\item Both prints are signed.
|
|
|
\item One (both if I'm delaying the publishing) of the prints contains a data medium with my login written on it using a CD marker (CD marker can be borrowed in library, at Student affairs or when I'm submitting the work).
|
|
|
\end{checklist}
|
|
|
|
|
|
\chapter{\LaTeX{} for beginners}
|
|
|
\label{latex}
|
|
|
|
|
|
This chapter contains commonly used \LaTeX{} packages and commands, that you might need when you're developing a thesis.
|
|
|
|
|
|
\subsection*{Useful packages}
|
|
|
|
|
|
Students usually encounter the same issues. Some of them can be solved using the following \LaTeX{} packages:
|
|
|
|
|
|
\begin{itemize}
|
|
|
\item \verb|amsmath| -- additional equation typesetting options,
|
|
|
\item \verb|float, afterpage, placeins| -- image placement,
|
|
|
\item \verb|fancyvrb, alltt| -- change the properties of Verbatim environment,
|
|
|
\item \verb|makecell| -- additional table options,
|
|
|
\item \verb|pdflscape, rotating| -- rotate a page by 90 degress (for image or table),
|
|
|
\item \verb|hyphenat| -- change how words break,
|
|
|
\item \verb|picture, epic, eepic| -- direct image drawing.
|
|
|
\end{itemize}
|
|
|
|
|
|
Some packages are used in this very template (in the lower section of fitthesis.cls file). It is also advised to read the documentation for individual packages.
|
|
|
|
|
|
A table column aligned to left with a fixed width is defined as "L" in the template (used as "p").
|
|
|
|
|
|
To reference a place within text, use command \verb|\ref{label}|. Depending on the placement of this label, it will be a number of chapter, subchapter, image, table or a similar numbered element. If you want to reference a specific page, use command \verb|\pageref{label}|. To cite a literature reference, use command \verb|\cite{identifier}|. To reference an equation, you can use command \verb|\eqref{label}|.
|
|
|
|
|
|
Symbol -- (dash) is used generated using two minus signs (like this: \verb|--|) in \LaTeX.
|
|
|
|
|
|
\subsection*{Commonly used \LaTeX{} commands}
|
|
|
\label{sec:Fragments}
|
|
|
|
|
|
I highly recommend you check the source text of this chapter and see how the following examples are created. The source text even contains helpful comments.
|
|
|
|
|
|
% A left-aligned, fixed-width column is defined in the template as "L" (used as p).
|
|
|
|
|
|
Example table:
|
|
|
\begin{table}[H]
|
|
|
\vskip6pt
|
|
|
\caption{Assessment table}
|
|
|
\vskip6pt
|
|
|
\centering
|
|
|
\begin{tabular}{llr}
|
|
|
\toprule
|
|
|
\multicolumn{2}{c}{Name} \\
|
|
|
\cmidrule(r){1-2}
|
|
|
Name & Surname & Assessment \\
|
|
|
\midrule
|
|
|
Jan & Novák & $7.5$ \\
|
|
|
Petr & Novák & $2$ \\
|
|
|
\bottomrule
|
|
|
\end{tabular}
|
|
|
\label{tab:ExampleTable}
|
|
|
\end{table}
|
|
|
|
|
|
% Ohraničení lze upravit dle potřeby:
|
|
|
% http://latex-community.org/forum/viewtopic.php?f=45&t=24323
|
|
|
% http://tex.stackexchange.com/questions/58163/problem-with-multirow-and-table-cell-borders
|
|
|
% http://tex.stackexchange.com/questions/79369/formatting-table-border-and-text-alignment-in-latex-table
|
|
|
|
|
|
\noindent Example equation:
|
|
|
\begin{equation}
|
|
|
\cos^3 \theta =\frac{1}{4}\cos\theta+\frac{3}{4}\cos 3\theta
|
|
|
\label{rovnice2}
|
|
|
\end{equation}
|
|
|
and two horizontally aligned equations: % znak & řídí zarovnání
|
|
|
\begin{align} \label{eq:soustava}
|
|
|
3x &= 6y + 12 \\
|
|
|
x &= 2y + 4
|
|
|
\end{align}
|
|
|
|
|
|
If you need to reference an equation from the text, you can use command \verb|\eqref|. For example, to reference the equations above \eqref{rovnice2}. If you want to align the equation number vertically, you can use command \texttt{split}:
|
|
|
|
|
|
\begin{equation} \label{eq:soustavaSrovnana}
|
|
|
\begin{split}
|
|
|
3x &= 6y + 12 \\
|
|
|
x &= 2y + 4
|
|
|
\end{split}
|
|
|
\end{equation}
|
|
|
|
|
|
Mathematical symbols ($\alpha$) and expressions can be placed even in text $\cos\pi=-1$ and can also be in a footnote%
|
|
|
\footnote{Formula in a footnote: $\cos\pi=-1$}.
|
|
|
|
|
|
Image~\ref{sirokyObrazek} displays a wide image comprised of multiple smaller images. Standard raster image is inserted in the same way as image \ref{keepCalm}.
|
|
|
|
|
|
% Využití \begin{figure*} způsobí, že obrázek zabere celou šířku stránky. Takový obrázek dříve mohl být pouze na začátku stránky, případně na konci s využitím balíčku dblfloatfix (případné [h] se ignorovalo a [H] obrázek odstraní). Nové verze LaTeXu už umí i [h].
|
|
|
\begin{figure*}[h]\centering
|
|
|
\centering
|
|
|
\includegraphics[width=\linewidth,height=1.7in]{obrazky-figures/placeholder.pdf}\\[1pt]
|
|
|
\includegraphics[width=0.24\linewidth]{obrazky-figures/placeholder.pdf}\hfill
|
|
|
\includegraphics[width=0.24\linewidth]{obrazky-figures/placeholder.pdf}\hfill
|
|
|
\includegraphics[width=0.24\linewidth]{obrazky-figures/placeholder.pdf}\hfill
|
|
|
\includegraphics[width=0.24\linewidth]{obrazky-figures/placeholder.pdf}
|
|
|
\caption{\textbf{Wide image.} Image can be comprised of multiple smaller images. If you want to address the partial images from text, use packagae \texttt{subcaption}.}
|
|
|
\label{sirokyObrazek}
|
|
|
\end{figure*}
|
|
|
|
|
|
% Uncomment this to switch to landscape oriented A3 paper
|
|
|
% \eject \pdfpagewidth=420mm
|
|
|
|
|
|
\begin{figure}[hbt]
|
|
|
\centering
|
|
|
\includegraphics[width=0.3\textwidth]{obrazky-figures/keep-calm.png}
|
|
|
\caption{Good text is a bad text, that has been changed countless times. You have to start somewhere.}
|
|
|
\label{keepCalm}
|
|
|
\end{figure}
|
|
|
|
|
|
Sometimes it is necessary to attach a diagram that does not fit on an A4 page. Then it is possible to insert one A3 page and fold it into the thesis (so-called Engineering fold, similar to Z-fold, where two folds are created -- face down and face up). Switching is performed as follows: \texttt{\textbackslash{}eject \textbackslash{}pdfpagewidth=420mm} (210mm to switch it back).
|
|
|
|
|
|
Other frequently used commands can be found above in the text, because a single practical example of correct use is better than ten pages of examples.
|
|
|
|
|
|
% Uncomment this to switch back to A4
|
|
|
% \eject \pdfpagewidth=210mm
|
|
|
|
|
|
|
|
|
% newline command
|
|
|
\newcommand{\odradkovani}{\\[0.3em]}
|
|
|
|
|
|
\chapter{Examples of bibliographic citations}
|
|
|
\label{priloha-priklady-citaci}
|
|
|
The czplain style is based on the style created by mr. Pyšný \cite{Pysny}. This appendix contains a set of supported type of citations with specific examples of bibliograhpic citations.
|
|
|
|
|
|
The next pages of the appendix contain examples of bibliographic citations of the following pubplications and their parts:
|
|
|
\begin{itemize}
|
|
|
\item Article in a periodical literature (magazine) (str. \pageref{pr-casopis-clanek}),
|
|
|
\item monographic publication (str. \pageref{pr-monografie}),
|
|
|
\item conference proceedings (str. \pageref{pr-sbornik}),
|
|
|
\item conference proceedings entry or book chapter (str. \pageref{pr-kapitola}),
|
|
|
\item manual, documentation, technical report and unpublished materials (str. \pageref{pr-manual}),
|
|
|
\item academic work (str. \pageref{pr-thesis}),
|
|
|
\item web page (str. \pageref{pr-webpage}),
|
|
|
\item and web site (str. \pageref{pr-website}).
|
|
|
\end{itemize}
|
|
|
|
|
|
\noindent Items are color-coded depending on whether or not they are required or optional:
|
|
|
\begin{itemize}
|
|
|
\item required element according to the standard
|
|
|
\item \textcolor{blue}{optional element according to the standard}
|
|
|
\item \textcolor{magenta}{required element for online information sources according to the standard}
|
|
|
\item \textcolor{red}{element that is not specified in the standard, but is available and optional within the template's bibliographic style}
|
|
|
\end{itemize}
|
|
|
Required items are only stated if they exist.
|
|
|
|
|
|
\newpage
|
|
|
The bibliography file contains records in the following form:
|
|
|
\begin{verbatim}
|
|
|
@Article{Doe:2020,
|
|
|
author = "Doe, John",
|
|
|
title = "How to cite",
|
|
|
subtitle = "Article citation",
|
|
|
journal = "Writing theses and dissertations",
|
|
|
journalsubtitle = "Formal aspects",
|
|
|
howpublished = "online",
|
|
|
address = "Brno",
|
|
|
publisher = "Brno University of Technology,
|
|
|
Faculty of information technology",
|
|
|
contributory = "Translated by Jan NOVÁK",
|
|
|
edition = "1",
|
|
|
version = "version 1.0",
|
|
|
month = 2,
|
|
|
year = "2020",
|
|
|
revised = "revised 12. 2. 2020",
|
|
|
volume = "4",
|
|
|
number = "24",
|
|
|
pages = "8--21",
|
|
|
cited = "2020-02-12",
|
|
|
doi = "10.1000/BC1.0",
|
|
|
issn = "1234-5678",
|
|
|
note = "This a made up citation",
|
|
|
url = "https://merlin.fit.vutbr.cz"
|
|
|
}
|
|
|
\end{verbatim}
|
|
|
|
|
|
|
|
|
%-------------------------------------------------------------------------------
|
|
|
\newpage
|
|
|
\section*{Article in a periodical literature -- @Article}
|
|
|
\label{pr-casopis-clanek}
|
|
|
\noindent \textbf{Record items}
|
|
|
|
|
|
\medskip
|
|
|
|
|
|
\begin{tabularx}{0.95\linewidth}{>{\raggedright\arraybackslash}X X >{\raggedright\arraybackslash}X}
|
|
|
Element & BibTeX item & Example\\\hline
|
|
|
Author & author & Doe, John\\
|
|
|
Article title & title & How to cite\\
|
|
|
\textcolor{blue}{Article subtitle} & \textcolor{blue}{subtitle} & \textcolor{blue}{Article citation}\\
|
|
|
Periodical literature title & journal & Writing theses and dissertations\\
|
|
|
\textcolor{blue}{Periodical literature subtitle} & \textcolor{blue}{journalsubtitle} & \textcolor{blue}{Formal aspects}\\
|
|
|
\textcolor{magenta}{Type of medium} & \textcolor{magenta}{howpublished} & \textcolor{magenta}{online}\\
|
|
|
Edition & edition & 1\\
|
|
|
Version & version & version 1.0\\
|
|
|
\textcolor{blue}{Secondary author(s)} & \textcolor{blue}{contributory} & \textcolor{blue}{Translated by Jan NOVÁK}\\
|
|
|
Place of publication & address & Brno\\
|
|
|
Publisher & publisher & Brno University of Technology, Faculty of information technology\\
|
|
|
Month & month & 2\\
|
|
|
Year & year & 2020\\
|
|
|
Volume & volume & 4\\
|
|
|
Number & number & 24\\
|
|
|
Pages & pages & 8-21\\
|
|
|
Revision & revised & revised 12. 2. 2020\\
|
|
|
\textcolor{magenta}{Date of citation} & \textcolor{magenta}{cited} & \textcolor{magenta}{2020-02-12}\\
|
|
|
Series title & series & Guidelines for writing theses and dissertations\\
|
|
|
Number in series & editionnumber & 42\\
|
|
|
\textcolor{magenta}{Digital object identifier} & \textcolor{magenta}{doi} & \textcolor{magenta}{10.1000/BC1.0}\\
|
|
|
Standard number & issn & 1234-5678\\
|
|
|
\textcolor{red}{Notes} & \textcolor{red}{note} & \textcolor{red}{This is a made up citation}\\
|
|
|
\textcolor{magenta}{Availability} & \textcolor{magenta}{url} & \textcolor{magenta}{https://merlin.fit.vutbr.cz}
|
|
|
\end{tabularx}
|
|
|
|
|
|
\bigskip
|
|
|
|
|
|
\noindent \textbf{Bibliographic citation}
|
|
|
|
|
|
\medskip
|
|
|
|
|
|
\noindent \textsc{Doe}, J. How to cite: Article citation. \textit{Writing theses and dissertations: Formal aspects} [online]. 1st ed., version 1.0. Translated by Jan NOVÁK. Brno: Brno University of Technology, Faculty of information technology. February 2020, vol. 4, num. 24, p. 8–21, revised 12. 2. 2020, [cit. 2020-02-12]. Guidelines for writing theses and dissertations, no. 42. DOI: 10.1000/BC1.0. ISSN 1234-5678. This is a made up citation. Available at: \url{https://merlin.fit.vutbr.cz}
|
|
|
|
|
|
%-------------------------------------------------------------------------------
|
|
|
\newpage
|
|
|
\section*{Monographic publication -- @Book, @Booklet (brochure)}
|
|
|
\label{pr-monografie}
|
|
|
\noindent \textbf{Record items}
|
|
|
|
|
|
\medskip
|
|
|
|
|
|
\begin{tabularx}{0.95\linewidth}{>{\raggedright\arraybackslash}X X >{\raggedright\arraybackslash}X}
|
|
|
Element & BibTeX item & Example\\\hline
|
|
|
Author & author & John von Doe\\
|
|
|
Title & title & How to cite\\
|
|
|
\textcolor{blue}{Subtitle} & \textcolor{blue}{subtitle} & \textcolor{blue}{Monographic publication citation}\\
|
|
|
\textcolor{magenta}{Type of medium} & \textcolor{magenta}{howpublished} & \textcolor{magenta}{online}\\
|
|
|
Edition & edition & 1\\
|
|
|
\textcolor{blue}{Secondary author(s)} & \textcolor{blue}{contributory} & \textcolor{blue}{Translated by Jan NOVÁK}\\
|
|
|
Place of publication & address & Brno\\
|
|
|
Publisher & publisher & Brno University of Technology, Faculty of information technology\\
|
|
|
Month & month & 2\\
|
|
|
Year & year & 2020\\
|
|
|
Revision & revision & revised 12. 2. 2020\\
|
|
|
\textcolor{magenta}{Date of citation} & \textcolor{magenta}{cited} & \textcolor{magenta}{2020-02-12}\\
|
|
|
\textcolor{red}{Pages} & \textcolor{red}{pages} & \textcolor{red}{220}\\
|
|
|
Series title & series & Guidelines for writing theses and dissertations\\
|
|
|
Number in series & editionnumber & 2\\
|
|
|
Standard number & isbn & 01-234-5678-9\\
|
|
|
\textcolor{red}{Notes} & \textcolor{red}{note} & \textcolor{red}{This is a made up citation}\\
|
|
|
\textcolor{magenta}{Availability} & \textcolor{magenta}{url} & \textcolor{magenta}{https://merlin.fit.vutbr.cz}\\
|
|
|
\end{tabularx}
|
|
|
|
|
|
\bigskip
|
|
|
|
|
|
\noindent \textbf{Bibliographic citation}
|
|
|
|
|
|
\medskip
|
|
|
|
|
|
\noindent \textsc{von Doe}, J. \textit{How to cite: Monographic publication citation} [online]. 1st ed. Translated by Jan NOVÁK.
|
|
|
Brno: Brno University of Technology, Faculty of information technology, February 2020, revised 12. 2. 2020 [cit. 2020-02-12]. 220 p. Guidelines for writing theses an dissertations, no. 2. ISBN 01-234-5678-9. This is a made up citation. Available at: \url{https://merlin.fit.vutbr.cz}
|
|
|
%-------------------------------------------------------------------------------
|
|
|
\newpage
|
|
|
\section*{Conference proceedings -- @Proceedings}
|
|
|
\label{pr-sbornik}
|
|
|
\noindent \textbf{Record items}
|
|
|
|
|
|
\medskip
|
|
|
|
|
|
\begin{tabularx}{0.95\linewidth}{X X >{\raggedright\arraybackslash}X}
|
|
|
Element & BibTeX item & Example\\\hline
|
|
|
\textcolor{red}{Author*} & \textcolor{red}{author} & \textcolor{red}{Čechmánek, Jan}\\
|
|
|
\textcolor{red}{Editor*} & \textcolor{red}{editor} & \textcolor{red}{Čechmánek, Jan}\\
|
|
|
Title & title & How to cite\\
|
|
|
\textcolor{blue}{Subtitle} & \textcolor{blue}{subtitle} & \textcolor{blue}{Conference proceedings citation}\\
|
|
|
\textcolor{magenta}{Type of medium} & \textcolor{magenta}{howpublished} & \textcolor{magenta}{online}\\
|
|
|
Edition & edition & 1\\
|
|
|
\textcolor{blue}{Secondary author(s)} & \textcolor{blue}{contributory} & \textcolor{blue}{Translated by Jan NOVÁK}\\
|
|
|
Place of publication & address & Brno\\
|
|
|
Publisher & publisher & Brno University of Technology, Faculty of information technology\\
|
|
|
Month & month & 2\\
|
|
|
Year & year & 2020\\
|
|
|
Volume & volume & 4\\
|
|
|
Number & number & 24\\
|
|
|
Pages & pages & 8-21\\
|
|
|
\textcolor{magenta}{Revision} & \textcolor{magenta}{revised} & \textcolor{magenta}{revised 12. 2. 2020}\\
|
|
|
\textcolor{magenta}{Date of citation} & \textcolor{magenta}{cited} & \textcolor{magenta}{2020-02-12}\\
|
|
|
Series title & series & Guidelines for writing theses and dissertations\\
|
|
|
Number in series & editionnumber & 2\\
|
|
|
\textcolor{magenta}{Digital object identifier} & \textcolor{magenta}{doi} & \textcolor{magenta}{10.1000/BC1.0}\\
|
|
|
Standard number & isbn or issn & 01-234-5678-9\\
|
|
|
\textcolor{red}{Notes} & \textcolor{red}{note} & \textcolor{red}{This is a made up citation}\\
|
|
|
\textcolor{magenta}{Availability} & \textcolor{magenta}{url} & \textcolor{magenta}{https://merlin.fit.vutbr.cz}
|
|
|
\end{tabularx}
|
|
|
|
|
|
*Either author or editor is stated.
|
|
|
|
|
|
\bigskip
|
|
|
|
|
|
\noindent \textbf{Bibliographic citation}
|
|
|
|
|
|
\medskip
|
|
|
|
|
|
\noindent \textsc{Čechmánek}, J. \textit{How to cite: Conference proceedings citation} [online]. 1st ed. Translated by Jan NOVÁK.
|
|
|
Brno: Brno University of Technology, Faculty of information technology, February 2020, vol. 4, num. 24, p. 8–21, revised 12. 2. 2020 [cit. 2020-02-12]. Guidelines for writing theses and dissertations, no. 2. DOI: 10.1000/BC1.0. ISBN 01-234-5678-9. This is a made up citation. Available at: \url{https://merlin.fit.vutbr.cz}
|
|
|
%-------------------------------------------------------------------------------
|
|
|
\newpage
|
|
|
\section*{Conference proceedings entry or book chapter -- @InProceedings, @InCollection, @Conference, @InBook}
|
|
|
\label{pr-kapitola}
|
|
|
\noindent \textbf{Record items}
|
|
|
|
|
|
\medskip
|
|
|
|
|
|
\begin{tabularx}{0.95\linewidth}{>{\raggedright\arraybackslash}X X >{\raggedright\arraybackslash}X}
|
|
|
Element & BibTeX item & Example\\\hline
|
|
|
Author & author & John von Doe\\
|
|
|
Entry title & title & How to cite\\
|
|
|
\textcolor{blue}{Entry subtitle} & \textcolor{blue}{subtitle} & \textcolor{blue}{Article citation}\\
|
|
|
Parent document author & editor or organisation & Smith, Peter\\
|
|
|
Parent document title & booktitle & Conference proceedings on writing theses and dissertations\\
|
|
|
\textcolor{blue}{Parent document subtitle} & \textcolor{blue}{booksubtitle} & \textcolor{blue}{Formal aspects}\\
|
|
|
\textcolor{magenta}{Type of medium} & \textcolor{magenta}{howpublished} & \textcolor{magenta}{online}\\
|
|
|
Edition & edition & 1\\
|
|
|
Version & version & version 1.0\\
|
|
|
\textcolor{blue}{Parent document secondary author(s)} & \textcolor{blue}{contributory} & \textcolor{blue}{Translated by Jan NOVÁK}\\
|
|
|
Place of publication & address & Brno\\
|
|
|
Publisher & publisher & Brno University of Technology, Faculty of information technology\\
|
|
|
Month & month & 2\\
|
|
|
Year & year & 2020\\
|
|
|
Volume & volume & 4\\
|
|
|
Number & number & 24\\
|
|
|
\textcolor{blue}{Chapter} & \textcolor{blue}{chapter} & \textcolor{blue}{5}\\
|
|
|
Pages & pages & 8-21\\
|
|
|
Revision & revised & revised 12. 2. 2020\\
|
|
|
\textcolor{magenta}{Date of citation} & \textcolor{magenta}{cited} & \textcolor{magenta}{2020-02-12}\\
|
|
|
Series title & series & Guidelines for writing theses and dissertations\\
|
|
|
Number in series & editionnumber & 2\\
|
|
|
Standard number & isbn or issn & 1234-5678\\
|
|
|
\textcolor{red}{Notes} & \textcolor{red}{note} & \textcolor{red}{This is a made up citation}\\
|
|
|
\textcolor{magenta}{Availability} & \textcolor{magenta}{url} & \textcolor{magenta}{https://merlin.fit.vutbr.cz}\\
|
|
|
\end{tabularx}
|
|
|
|
|
|
\bigskip
|
|
|
|
|
|
\noindent \textbf{Bibliographic citation}
|
|
|
|
|
|
\medskip
|
|
|
|
|
|
\noindent \textsc{Doe}, J. How to cite: Article citation.
|
|
|
In: \textsc{Smith}, P., ed. \textit{Conference proceedings on writing theses and dissertations: Formal aspects} [online]. 1st ed., version 1.0. Translated by Jan NOVÁK. Brno: Brno University of Technology, Faculty of information technology, February 2020, vol. 4, num. 24, chap. 5, p. 8–21, revised 12. 2. 2020 [cit. 2020-02-12]. Guidelines for writing theses and dissertations, no. 2. ISSN 1234-5678. This is a made up citation. Available at: \url{https://merlin.fit.vutbr.cz}
|
|
|
%-------------------------------------------------------------------------------
|
|
|
\newpage
|
|
|
\section*{Manual, documentation, technical report and unpublished \\materials -- @Manual, @TechReport, @Unpublished}
|
|
|
\label{pr-manual}
|
|
|
\noindent \textbf{Record items}
|
|
|
|
|
|
\medskip
|
|
|
|
|
|
\begin{tabularx}{0.95\linewidth}{>{\raggedright\arraybackslash}X X >{\raggedright\arraybackslash}X}
|
|
|
Element & BibTeX item & Example\\\hline
|
|
|
Author (person or organisation) & author & Brno University of Technology, Faculty of information technology\\
|
|
|
Title & title & Manual for writing theses and dissertations\\
|
|
|
\textcolor{blue}{Subtitle} & \textcolor{blue}{subtitle} & \textcolor{blue}{Manual citation}\\
|
|
|
\textcolor{magenta}{Type of medium} & \textcolor{magenta}{howpublished} & \textcolor{magenta}{online}\\
|
|
|
\textcolor{red}{Document type} & \textcolor{red}{type} & \textcolor{red}{User manual}\\
|
|
|
\textcolor{red}{Document number} & \textcolor{red}{number} & \textcolor{red}{3}\\
|
|
|
Edition & edition & 1\\
|
|
|
\textcolor{blue}{Secondary author(s)} & \textcolor{blue}{contributory} & \textcolor{blue}{Edited by Jan NOVÁK}\\
|
|
|
Place of publication & address & Brno\\
|
|
|
Organisation or institution & organization or institution & Brno University of Technology, Faculty of information technology\\
|
|
|
Month & month & 2\\
|
|
|
Year & year & 2020\\
|
|
|
Revision & revised & revised 12. 2. 2020\\
|
|
|
\textcolor{magenta}{Date of citation} & \textcolor{magenta}{cited} & \textcolor{magenta}{2020-02-12}\\
|
|
|
\textcolor{red}{Pages} & \textcolor{red}{pages} & \textcolor{red}{220}\\
|
|
|
\textcolor{red}{Notes} & \textcolor{red}{note} & \textcolor{red}{This is a made up citation}\\
|
|
|
\textcolor{magenta}{Availability} & \textcolor{magenta}{url} & \textcolor{magenta}{https://merlin.fit.vutbr.cz}\\
|
|
|
\end{tabularx}
|
|
|
|
|
|
\bigskip
|
|
|
|
|
|
\noindent \textbf{Bibliographic citation}
|
|
|
|
|
|
\medskip
|
|
|
|
|
|
\noindent \textsc{Brno University of Technology, Faculty of information technology}. \textit{Manual for writing theses and dissertations: Manual citation} [online]. User manual 3, 1st ed. Edited by Jan NOVÁK.
|
|
|
Brno: Brno University of Technology, Faculty of information technology, February 2020, revised 12. 2. 2020 [cit. 2020-02-12]. 220 p. This is a made up citation. Available at: \url{https://merlin.fit.vutbr.cz}
|
|
|
%-------------------------------------------------------------------------------
|
|
|
\newpage
|
|
|
\section*{Academic work -- @BachelorsThesis, @MastersThesis, \\@PhdThesis, @Thesis}
|
|
|
\label{pr-thesis}
|
|
|
\noindent \textbf{Record items}
|
|
|
|
|
|
\medskip
|
|
|
|
|
|
\begin{tabularx}{0.95\linewidth}{X X >{\raggedright\arraybackslash}X}
|
|
|
Element & BibTeX item & Example\\\hline
|
|
|
Author & author & Brno University of Technology, Faculty of information technology\\
|
|
|
Title & title & BiBTeX style for ČSN ISO 690 and ČSN ISO 690-2\\
|
|
|
\textcolor{blue}{Subtitle} & \textcolor{blue}{subtitle} & \\
|
|
|
\textcolor{magenta}{Type of medium} & \textcolor{magenta}{howpublished} & \textcolor{magenta}{online}\\
|
|
|
\textcolor{red}{Document type} & \textcolor{red}{type} & \textcolor{red}{Dissertation}\\
|
|
|
Place of publication & address or location & Brno\\
|
|
|
School & school & Brno University of Technology, Faculty of information technology\\
|
|
|
Year & year & 2020\\
|
|
|
\textcolor{magenta}{Date of citation} & \textcolor{magenta}{cited} & \textcolor{magenta}{2020-02-12}\\
|
|
|
\textcolor{red}{Pages} & \textcolor{red}{pages} & \textcolor{red}{220}\\
|
|
|
\textcolor{red}{Appendices} & \textcolor{red}{inserts} & \textcolor{red}{20}\\
|
|
|
Standard number & isbn & 01-234-5678-9\\
|
|
|
\textcolor{red}{Supervisor} & \textcolor{red}{supervisor} & \textcolor{red}{Dytrych, Jaroslav}\\
|
|
|
\textcolor{red}{Notes} & \textcolor{red}{note} & \textcolor{red}{This is a made up citation}\\
|
|
|
\textcolor{magenta}{Availability} & \textcolor{magenta}{url} & \textcolor{magenta}{https://www.fit.vut.cz/\-study/theses}\\
|
|
|
\end{tabularx}
|
|
|
|
|
|
\bigskip
|
|
|
|
|
|
\noindent \textbf{Bibliographic citation}
|
|
|
|
|
|
\medskip
|
|
|
|
|
|
\noindent \textsc{Novák}, J. \textit{BiBTeX style for ČSN ISO 690 and ČSN ISO 690-2} [online]. Brno, CZ, 2020. [cit. 2020-02-12]. 80 p., 20. p. apps. Dissertation. Brno University of Technology, Faculty of information technology. ISBN 01-2345-678-9. Supervisor \textsc{Dytrych}, J. This is a made up citation. Available at: \url{https://www.fit.vut.cz/study/theses}
|
|
|
%-------------------------------------------------------------------------------
|
|
|
\newpage
|
|
|
\section*{Web page -- @Webpage}
|
|
|
\label{pr-webpage}
|
|
|
\noindent \textbf{Record items}
|
|
|
|
|
|
\medskip
|
|
|
|
|
|
\begin{tabularx}{0.95\linewidth}{X X >{\raggedright\arraybackslash}X}
|
|
|
Element & BibTeX item & Example\\\hline
|
|
|
Author & author & Nováková, Jana\\
|
|
|
Page title & secondarytitle & Post citation\\
|
|
|
Site title & title & Web on writing theses and dissertations\\
|
|
|
\textcolor{blue}{Site subtitle} & \textcolor{blue}{subtitle} & \\
|
|
|
\textcolor{magenta}{Type of medium} & \textcolor{magenta}{howpublished} & \textcolor{magenta}{online}\\
|
|
|
\textcolor{blue}{Secondary author(s)} & \textcolor{blue}{contributory} & \textcolor{blue}{Edited by Jan NOVÁK}\\
|
|
|
\textcolor{red}{Version} & \textcolor{red}{version} & \textcolor{red}{version 1.0}\\
|
|
|
\textcolor{red}{Place of publication} & \textcolor{red}{address} & \textcolor{red}{Brno}\\
|
|
|
\textcolor{red}{Publisher} & \textcolor{red}{publisher} & \textcolor{red}{Brno University of Technology, Faculty of information technology}\\
|
|
|
Day & day & 12\\
|
|
|
Month & month & 2\\
|
|
|
Year & year & 2020\\
|
|
|
\textcolor{blue}{Time of publication} & \textcolor{blue}{time} & \textcolor{blue}{14:00}\\
|
|
|
Revision & revised & revised 12. 2. 2020\\
|
|
|
\textcolor{magenta}{Digital object identifier} & \textcolor{magenta}{doi} & \textcolor{magenta}{10.1000/BC1.0}\\
|
|
|
Standard number & issn & 1234-5678\\
|
|
|
\textcolor{red}{Notes} & \textcolor{red}{note} & \textcolor{red}{This is a made up citation}\\
|
|
|
Availability & url & https://merlin.fit.vutbr.cz\\
|
|
|
Path & path & Home; Art; The art of citation
|
|
|
\end{tabularx}
|
|
|
|
|
|
\bigskip
|
|
|
|
|
|
\noindent \textbf{Bibliograpic citation}
|
|
|
|
|
|
\medskip
|
|
|
|
|
|
\noindent \textsc{Nováková}, J. Post citation. \textit{Web on writing theses and dissertations} [online]. Edited by Jan NOVÁK. version 1.0. Brno: Brno University of Technology, Faculty of information technology, 2. february 1998 14:10. revised 12. 2. 2020 [cit. 2020-02-12]. DOI: 10.1000/BC1.0. ISSN 1234-5678. This is a made up citation. Available at: \url{https://merlin.fit.vutbr.cz} Path: Home; Art; The Art of Citation.
|
|
|
%-------------------------------------------------------------------------------
|
|
|
\newpage
|
|
|
\section*{Web site -- @Website}
|
|
|
\label{pr-website}
|
|
|
\noindent \textbf{Record items}
|
|
|
|
|
|
\medskip
|
|
|
|
|
|
\begin{tabularx}{0.95\linewidth}{X X >{\raggedright\arraybackslash}X}
|
|
|
Element & BibTeX item & Example\\\hline
|
|
|
Author (person or organisation) & author & Nováková, Jana\\
|
|
|
Site title & title & Web on writing theses and citations\\
|
|
|
\textcolor{blue}{Site subtitle} & \textcolor{blue}{subtitle} & \\
|
|
|
\textcolor{magenta}{Type of medium} & \textcolor{magenta}{howpublished} & \textcolor{magenta}{online}\\
|
|
|
\textcolor{blue}{Secondary author(s)} & \textcolor{blue}{contributory} & \textcolor{blue}{Edited by Jan NOVÁK}\\
|
|
|
\textcolor{red}{Version} & \textcolor{red}{version} & \textcolor{red}{version 1.0}\\
|
|
|
\textcolor{red}{Place of publication} & \textcolor{red}{address} & \textcolor{red}{Brno}\\
|
|
|
\textcolor{red}{Publisher} & \textcolor{red}{publisher} & \textcolor{red}{Brno University of Technology, Faculty of information technology}\\
|
|
|
\textcolor{blue}{Day} & \textcolor{blue}{day} & \textcolor{blue}{12}\\
|
|
|
\textcolor{blue}{Month} & \textcolor{blue}{month} & \textcolor{blue}{2}\\
|
|
|
Year & year & 2020\\
|
|
|
\textcolor{blue}{Time of publication} & \textcolor{blue}{time} & \textcolor{blue}{14:00}\\
|
|
|
Revision & revised & revised 12. 2. 2020\\
|
|
|
Date of citation & cited & 2020-02-12\\
|
|
|
\textcolor{magenta}{Digital object identifier} & \textcolor{magenta}{doi} & \textcolor{magenta}{10.1000/BC1.0}\\
|
|
|
Standard number & issn & 1234-5678\\
|
|
|
\textcolor{red}{Notes} & \textcolor{red}{note} & \textcolor{red}{This is a made up citation}\\
|
|
|
Availability & url & https://merlin.fit.vutbr.cz
|
|
|
\end{tabularx}
|
|
|
|
|
|
\bigskip
|
|
|
|
|
|
\noindent \textbf{Bibliographic citation}
|
|
|
|
|
|
\medskip
|
|
|
|
|
|
\noindent \textsc{Nováková}, J. \textit{Web on writing theses and dissertations} [online]. Edited by Jan NOVÁK. version 1.0. Brno: Brno University of Technology, Faculty of information technology, 2. february 1998 14:10. revised 12. 2. 2020 [cit. 2020-02-12]. DOI: 10.1000/BC1.0. ISSN 1234-5678. This is a made up citation. Available at: \url{https://merlin.fit.vutbr.cz}.
|
|
|
|
|
|
% For compilation piecewise (see projekt.tex), it is necessary to uncomment it
|
|
|
%\end{document}
|
