diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/unifith')
-rw-r--r-- | Master/texmf-dist/doc/latex/unifith/README | 50 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/unifith/README.TEXLIVE | 7 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/unifith/examples/Dottorato.tex | 222 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/unifith/examples/Laurea.tex | 221 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/unifith/unifith-doc.pdf | bin | 0 -> 211454 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/unifith/unifith-doc.tex | 539 |
6 files changed, 1039 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/unifith/README b/Master/texmf-dist/doc/latex/unifith/README new file mode 100644 index 00000000000..f7e485de8b6 --- /dev/null +++ b/Master/texmf-dist/doc/latex/unifith/README @@ -0,0 +1,50 @@ +********************************************************************* +* UniFiTh class * +********************************************************************* + + This is the README file of the "unifith" LaTeX class. + Official web page: + http://biccari.altervista.org/c/informatica/latex/unifith.php + + + +** License ********************************************************** + + Copyright (c) 2019 Francesco Biccari. + + This work (specified below) may be distributed and/or + modified under the conditions of the + LaTeX Project Public License, + either version 1.3 of this license or any later version. + The latest version of this license is in + http://www.latex-project.org/lppl.txt + and version 1.3 or later is part of all distributions of + LaTeX version 2005/12/01 or later. + + This work has the LPPL maintenance status 'maintained'. + The Current Maintainer of this work is Francesco Biccari. + + The "University of Florence" logo is a registered + EU trademark of the "University of Florence" university. + The logo can be used only according to the "Il logo di Ateneo, + linee guida per l’uso corretto" document available, with + other information, at the following link (in italian): + https://www.unifi.it/upload/sub/comunicazione/piano/3_logo.pdf + In particular it can be used in the theses of + "University of Florence" without explicit authorization. + + + +** Class information ************************************************ + + UniFiTh is a LaTeX class to typeset theses that adhere to + "University of Florence"'s guidelines for publishing. + + It is compatible with two compilation methods: + pdflatex and xelatex. + + The documentation is provided in the file unifith-doc.pdf. + + The version number of this class is reported at the top of the + class file unifith.cls and in the pdf manual + unifith-doc.pdf. diff --git a/Master/texmf-dist/doc/latex/unifith/README.TEXLIVE b/Master/texmf-dist/doc/latex/unifith/README.TEXLIVE new file mode 100644 index 00000000000..1938796b214 --- /dev/null +++ b/Master/texmf-dist/doc/latex/unifith/README.TEXLIVE @@ -0,0 +1,7 @@ +The following files have been removed in the TeX Live installation of +the current package, typically due to duplication, lack of space, or +missing source code. You can find these files on CTAN at + http://mirror.ctan.org/macros/latex/contrib/unifith +If questions or concerns, email tex-live@tug.org. + + unifilogo.pdf diff --git a/Master/texmf-dist/doc/latex/unifith/examples/Dottorato.tex b/Master/texmf-dist/doc/latex/unifith/examples/Dottorato.tex new file mode 100644 index 00000000000..26d86075094 --- /dev/null +++ b/Master/texmf-dist/doc/latex/unifith/examples/Dottorato.tex @@ -0,0 +1,222 @@ +% !TeX encoding = UTF-8 +% !TeX program = pdflatex +% !TeX spellcheck = en_US + +\documentclass[binding=0.6cm]{../unifith} + +\usepackage{microtype} +\usepackage[english]{babel} +\usepackage[utf8]{inputenc} + +\usepackage{hyperref} +\hypersetup{pdftitle={Usage example of the UniFiTh class for a PhD thesis},pdfauthor={Francesco Biccari}} + +% Remove in a normal thesis +\usepackage{lipsum} +\usepackage{curve2e} +\definecolor{gray}{gray}{0.4} +\newcommand{\bs}{\textbackslash} + +% Commands for the titlepage +\title{Esempio d'uso della classe UniFiTh\\ + per una tesi di Dottorato} +\alttitle{Titolo alternativo opzionale, di solito in inglese nelle facoltà scientifiche} +\author{Francesco Biccari} +\IDnumber{1234567} +\course{Corso di Dottorato\\ in Fisica e Astronomia} +\courseorganizer{Dipartimento di Fisica e Astronomia} +\cycle{Ciclo XXXV} +\AcademicYear{2018/2019} +\thesistype{PhD thesis} +\copyyear{2018} +\advisor{Prof. Nome Cognome} +\advisor{Dr. Nome Cognome} +\coadvisor{Dr. Nome Cognome} +\authoremail{biccari@email.com} + +\examdate{16 Febbraio 2018} +\examiner{Prof. Nome Cognome} +\examiner{Prof. Nome Cognome} +\examiner{Dr. Nome Cognome} +\versiondate{\today} +\ISBN{000000000-0} + + + +\begin{document} + +\frontmatter + +\maketitle + +\dedication{Dedicated to\\ Donald Knuth} + +\begin{abstract} +This document is an example which shows the main features of +the \LaTeXe\ class \texttt{UniFiTh.cls} developed by Francesco Biccari +with the help of GuIT (Gruppo Utilizzatori Italiani di \TeX). +\end{abstract} + +\begin{acknowledgments}[Ringraziamenti] +Ho deciso di scrivere i ringraziamenti in italiano +per dimostrare la mia gratitudine verso i membri +del GuIT, il Gruppo Utilizzatori Italiani di \TeX, e, in particolare, +verso il prof. Enrico Gregorio. +\end{acknowledgments} + +\tableofcontents + +% Do not use the starred version of the chapter command! +\chapter{Non numbered chapter} + +In this manual you can skip the gray text because it is just dummy text.% +\footnote{This is a footnote.} + +\textcolor{gray}{\lipsum[1-22]} + + +\section*{Non numbered section} + +In this manual you can skip the gray text because it is just dummy text. + +\textcolor{gray}{\lipsum[1-22]} + + + + +\mainmatter + +\chapter{Style features of \textsf{UniFiTh}} + +In this chapter I will discuss my stylistic choices of \textsf{UniFiTh}. +I will show the page layout geometry and I will describe the page style. + +\section{Page layout} + +The page is fixed at the dimensions of an A4 paper, therefore you have to print your thesis on A4 paper to obtain the best results. The font dimension is fixed at 11\, pt. The text column and the margins are chosen to fill to the best an A4 paper while keeping a reasonable line length (396\, pt) for a good readability. The text height and the text width are in golden ratio (\textasciitilde 1.6180) as well as the outer and inner margins in a two-side document after binding margin removal. Also the top margin (excluding the header) and bottom margin are in the golden ratio. In Fig.~\ref{layout} a sketch of the \textsf{UniFiTh} page layout is shown. + +\begin{figure}[h] +\centering +\setlength{\unitlength}{0.27mm} +\begin{picture}(420,297)(-210,0) +\polyline(-210,0)(210,0)(210,297)(-210,297)(-210,0) +\Line(0,0)(0,297) +\put(27.05,37.4){\polygon(0,0)(139.2,0)(139.2,223.8)(0,223.8)} +\put(-27.05,37.4){\polygon(0,0)(-139.2,0)(-139.2,223.8)(0,223.8)} +\put(27.05,268.16){\polygon(0,0)(139.2,0)(139.2,4.22)(0,4.22)} +\put(-27.05,268.16){\polygon(0,0)(-139.2,0)(-139.2,4.22)(0,4.22)} +\end{picture} +\caption{Page layout scheme of \textsf{UniFiTh class} using a zero binding margin.} +\label{layout} +\end{figure} + + +\section{Page style} + +The captions have a smaller font respect to the text and the label is in boldface. The appearance of the margin notes has been improved. +They have the same font dimension of the footnotes and are typed in italics. +Moreover I defined a new command to typeset margin note aligned to the left on the right page and vice versa on the left page. +Notice that if a binding margin greater than 1.5\, cm is used, the dimensions of the margin notes become too small and very ugly. +Do not use them in this case. + +The mathematical objects, figures and tables are numbered within the chapters (e.g. 1.1, 1.2,\ldots for the first chapter, 2.1, 2.2 for the second one and so on\ldots). See for example the number of this simple equation +\begin{equation} +x_{1,2}=\frac{-b\pm\sqrt{b^2-4ac}}{2a} +\end{equation} + + +The title page is automatically composed when the \texttt{\bs maketitle} command is given. +The parameters needed for the title page, author, title, etc\ldots , are supplied by dedicated commands explained in the next section. +Two copies of the university logo in \texttt{pdf} format, one for color printing and the other one for black and white printing, are supplied in the \textsf{UniFiTh} package. They are shown in Fig.~\ref{fig:largenenough}. + +\begin{figure} +\centering +\includegraphics[width=0.5\textwidth]{unifilogo} +\caption{Logo of the University of Florence.} +\label{fig:largenenough} +\end{figure} + + + +\section{About figures and tables} + +As regards the image formats, please use vector images as much as possible! Use jpg images only for photographs! pdf\LaTeX\ supports the pdf, jpg and png formats. + +A very simple table is show in Tab.~\ref{tab:letters}. Remember to typeset +always the table caption above the table. Do not use vertical lines. + +\begin{table}[b] +\caption{This is a simple table.} +\label{tab:letters} +\centering +\begin{tabular}{lcc} +\toprule +Letter & Test & Test \\ +\midrule +A & C & E \\ +B & D & F \\ +\bottomrule +\end{tabular} +\end{table} + + +\section{A section} + +In this manual you can skip the gray text because it is just dummy text. + +\textcolor{gray}{\lipsum[1-10]} + + + +\section{Another section} + +In this manual you can skip the gray text because it is just dummy text. + +\textcolor{gray}{\lipsum} + + +\appendix +\chapter{Special commands provided by \textsf{UniFiTh}} + +\textsf{UniFiTh} provides some special commands, particularly useful for scientific works. You can use for example the roman shape, instead of the italic, for the imaginary unit (\texttt{\bs iu}) and Napier's number (\texttt{\bs eu}): +\begin{equation} +\eu^{\iu\pi}+1=0 +\end{equation} + +There are also two commands to speed up the writing of derivatives. In the following example we have used the commands \texttt{\bs der} and \texttt{\bs pder}): +\begin{equation} +\der{f}{x} \qquad \pder{f}{*{2}{y}} +\end{equation} + + +\textsf{UniFiTh} provides also 4 commands to improve the writing of subscripts, \texttt{\bs rb} and \texttt{\bs tb}, and superscripts, \texttt{\bs rp} and \texttt{\bs tp}. Two of these commands, \texttt{\bs rb} and \texttt{\bs rp}, can be used both in text and in math mode and compose their argument in roman. The other two, \texttt{\bs tb} and \texttt{\bs tp}, can be used only in text mode and compose their argument as are. Here it is an usage example of \texttt{\bs rb} and \texttt{\bs rp}: +\[ +a_b \neq a\rb{b}\qquad a^b \neq a\rp{b} +\] +And here it is an usage example of \texttt{\bs tb}: \emph{Cu\tb{It} indicates copper bought in Italy}. And a usage example of \texttt{\bs ts}: \emph{Cher G\tp{le} Napol\'eon}. + + +Then several commands for the correct typesetting of unit of measurements are provided. For example the command \texttt{\bs un} typesets its argument in roman and leaves a thin space between the number and the unit: $25\un{m}$, $3.5\un{m/s}$. Other commands are: (\texttt{\bs g}) 45\g, (\texttt{\bs C}) 30\,\C, (\texttt{\bs A}) 12\,\A, (\texttt{\bs micro}) 40\,\micro m, (\texttt{\bs ohm}) 27\,\ohm. + +We have also \texttt{\bs x} as abbreviation of \texttt{\bs times}: \texttt{\$7 \bs x 10\^{}5\$} gives $7 \x 10^5$. Then \texttt{\bs di} is the differential symbol which automatically insert the correct spacing. +\[ +\int x \di x +\] + +Finally we have defined the color \textsf{unifiblue} which is the official color +of University of Florence. It is defined as RGB(0,82.12,146.88). \textcolor{unifiblue}{This text is written with the color \textsf{unifiblue}.} + +In the following dummy text you can observe the usage of \texttt{\bs mnote} command which typesets fancy margin notes. + +\textcolor{gray}{\lipsum} +\marginpar{This is a fancy margin note!} +\textcolor{gray}{\lipsum} + +\backmatter +% bibliography +%\cleardoublepage +%\phantomsection +%\bibliographystyle{UniFiTh} % BibTeX style +%\bibliography{bibliography} % BibTeX database without .bib extension + +\end{document} diff --git a/Master/texmf-dist/doc/latex/unifith/examples/Laurea.tex b/Master/texmf-dist/doc/latex/unifith/examples/Laurea.tex new file mode 100644 index 00000000000..fb120a16f18 --- /dev/null +++ b/Master/texmf-dist/doc/latex/unifith/examples/Laurea.tex @@ -0,0 +1,221 @@ +% !TeX encoding = UTF-8 +% !TeX program = pdflatex +% !TeX spellcheck = it_IT + +\documentclass[binding=0.6cm]{../unifith} + +\usepackage{microtype} +\usepackage[italian]{babel} +\usepackage[utf8]{inputenc} + +\usepackage{hyperref} +\hypersetup{pdftitle={Esempio d'uso della classe UniFiTh per una tesi di Laurea Magistrale},pdfauthor={Francesco Biccari}} + +% Remove in a normal thesis +\usepackage{lipsum} +\usepackage{curve2e} +\definecolor{gray}{gray}{0.4} +\newcommand{\bs}{\textbackslash} + +% Commands for the titlepage +\title{Esempio d'uso della classe UniFiTh\\ +per una tesi di Laurea Magistrale} +%\subtitle{Esempio di sottotitolo} +\alttitle{Titolo alternativo opzionale, di solito in inglese nelle facoltà scientifiche} +\author{Francesco Biccari} +\IDnumber{1234567} +\course{Corso di Laurea Magistrale\\ in Fisica} +\courseorganizer{Scuola di Scienze Matematiche,\\ Fisiche e Naturali} +\AcademicYear{Anna Accademico 2018/2019} +\copyyear{2019} +\advisor{Prof. Nome Cognome} +\advisor{Dr. Nome Cognome (corr. interno)} +\advisor{Dr. Nome Cognome (corr. esterno)} +\authoremail{biccari@email.com} + +\examdate{16 Aprile 2019} +\examiner{Prof. Nome Cognome} +\examiner{Prof. Nome Cognome} +\examiner{Dr. Nome Cognome} +\versiondate{\today} + + + +\begin{document} + +\frontmatter + +\maketitle + +\dedication{Dedicato a\\ Donald Knuth} + +\begin{abstract} +This document is an example which shows the main features of +the \LaTeXe\ class \texttt{unifith.cls} developed by Francesco Biccari +with the help of GuIT (Gruppo Utilizzatori Italiani di \TeX). +\end{abstract} + +\begin{acknowledgments} +Ho deciso di scrivere i ringraziamenti in italiano +per dimostrare la mia gratitudine verso i membri +del GuIT, il Gruppo Utilizzatori Italiani di \TeX, e, in particolare, +verso il prof. Enrico Gregorio. +\end{acknowledgments} + +\tableofcontents + +% Do not use the starred version of the chapter command! +\chapter{Capitolo non numerato} + +In this manual you can skip the gray text because it is just dummy text.% +\footnote{This is a footnote.} + +\textcolor{gray}{\lipsum[1-22]} + + +\section*{Paragrafo non numerato} + +In this manual you can skip the gray text because it is just dummy text. + +\textcolor{gray}{\lipsum[1-22]} + + + + +\mainmatter + +\chapter{Style features of \textsf{unifith}} + +In this chapter I will discuss my stylistic choices of \textsf{unifith}. +I will show the page layout geometry and I will describe the page style. + +\section{Page layout} + +The page is fixed at the dimensions of an A4 paper, therefore you have to print your thesis on A4 paper to obtain the best results. The font dimension is fixed at 11\,pt. The text column and the margins are chosen to fill to the best an A4 paper while keeping a reasonable line length (396\, pt) for a good readability. The text height and the text width are in golden ratio (\textasciitilde 1.6180) as well as the outer and inner margins in a two-side document after binding margin removal. Also the top margin (excluding the header) and bottom margin are in the golden ratio. In Fig.~\ref{layout} a sketch of the \textsf{unifith} page layout is shown. + +\begin{figure}[h] +\centering +\setlength{\unitlength}{0.27mm} +\begin{picture}(420,297)(-210,0) +\polyline(-210,0)(210,0)(210,297)(-210,297)(-210,0) +\Line(0,0)(0,297) +\put(27.05,37.4){\polygon(0,0)(139.2,0)(139.2,223.8)(0,223.8)} +\put(-27.05,37.4){\polygon(0,0)(-139.2,0)(-139.2,223.8)(0,223.8)} +\put(27.05,268.16){\polygon(0,0)(139.2,0)(139.2,4.22)(0,4.22)} +\put(-27.05,268.16){\polygon(0,0)(-139.2,0)(-139.2,4.22)(0,4.22)} +\end{picture} +\caption{Page layout scheme of \textsf{unifith class} using a zero binding margin.} +\label{layout} +\end{figure} + + +\section{Page style} + +The captions have a smaller font respect to the text and the label is in boldface. The appearance of the margin notes has been improved. +They have the same font dimension of the footnotes and are typed in italics. +Moreover I defined a new command to typeset margin note aligned to the left on the right page and vice versa on the left page. +Notice that if a binding margin greater than 1.5\,cm is used, the dimensions of the margin notes become too small and very ugly. +Do not use them in this case. + +The mathematical objects, figures and tables are numbered within the chapters (e.g. 1.1, 1.2,\ldots for the first chapter, 2.1, 2.2 for the second one and so on\ldots). See for example the number of this simple equation +\begin{equation} +x_{1,2}=\frac{-b\pm\sqrt{b^2-4ac}}{2a} +\end{equation} + +\begin{figure}[b] + \centering + \includegraphics[width=0.7\textwidth]{unifilogo} + \caption{Logo of the University of Florence.} + \label{fig:largenenough} +\end{figure} + +The title page is automatically composed when the \texttt{\bs maketitle} command is given. +The parameters needed for the title page, author, title, etc\ldots , are supplied by dedicated commands explained in the next section. +A copy of the university logo in \texttt{pdf} format is supplied in the \textsf{unifith} package. It is shown in Fig.~\ref{fig:largenenough}. + + + + + +\section{About figures and tables} + +As regards the image formats, please use vector images as much as possible! Use jpg images only for photographs! pdf\LaTeX\ supports the pdf, jpg and png formats. + +A very simple table is show in Tab.~\ref{tab:letters}. Remember to typeset +always the table caption above the table. Do not use vertical lines. + +\begin{table} +\caption{This is a simple table.} +\label{tab:letters} +\centering +\begin{tabular}{lcc} +\toprule +Letter & Test & Test \\ +\midrule +A & C & E \\ +B & D & F \\ +\bottomrule +\end{tabular} +\end{table} + + +\section{A section} + +In this manual you can skip the gray text because it is just dummy text. + +\textcolor{gray}{\lipsum[1-10]} + + + +\section{Another section} + +In this manual you can skip the gray text because it is just dummy text. + +\textcolor{gray}{\lipsum} + + +\appendix +\chapter{Special commands provided by \textsf{unifith}} + +\textsf{Unifith} provides some special commands, particularly useful for scientific works. You can use for example the roman shape, instead of the italic, for the imaginary unit (\texttt{\bs iu}) and Napier's number (\texttt{\bs eu}): +\begin{equation} +\eu^{\iu\pi}+1=0 +\end{equation} + +There are also two commands to speed up the writing of derivatives. In the following example we have used the commands \texttt{\bs der} and \texttt{\bs pder}): +\begin{equation} +\der{f}{x} \qquad \pder{f}{*{2}{y}} +\end{equation} + + +\textsf{Unifith} provides also 4 commands to improve the writing of subscripts, \texttt{\bs rb} and \texttt{\bs tb}, and superscripts, \texttt{\bs rp} and \texttt{\bs tp}. Two of these commands, \texttt{\bs rb} and \texttt{\bs rp}, can be used both in text and in math mode and compose their argument in roman. The other two, \texttt{\bs tb} and \texttt{\bs tp}, can be used only in text mode and compose their argument as are. Here it is an usage example of \texttt{\bs rb} and \texttt{\bs rp}: +\[ +a_b \neq a\rb{b}\qquad a^b \neq a\rp{b} +\] +And here it is an usage example of \texttt{\bs tb}: \emph{Cu\tb{It} indicates copper bought in Italy}. And a usage example of \texttt{\bs ts}: \emph{Cher G\tp{le} Napol\'eon}. + + +Then several commands for the correct typesetting of unit of measurements are provided. For example the command \texttt{\bs un} typesets its argument in roman and leaves a thin space between the number and the unit: $25\un{m}$, $3.5\un{m/s}$. Other commands are: (\texttt{\bs g}) 45\g, (\texttt{\bs C}) 30\,\C, (\texttt{\bs A}) 12\,\A, (\texttt{\bs micro}) 40\,\micro m, (\texttt{\bs ohm}) 27\,\ohm. + +We have also \texttt{\bs x} as abbreviation of \texttt{\bs times}: \texttt{\$7 \bs x 10\^{}5\$} gives $7 \x 10^5$. Then \texttt{\bs di} is the differential symbol which automatically insert the correct spacing. +\[ +\int x \di x +\] + +Finally we have defined the color \textsf{unifiblue} which is the official color +of the University of Florence. It is defined as RGB(0,82,147). \textcolor{unifiblue}{This text is written with the color \textsf{unifiblue}.} + +In the following dummy text you can observe the usage of \texttt{\bs mnote} command which typesets fancy margin notes. + +\textcolor{gray}{\lipsum} +\marginpar{This is a fancy margin note!} +\textcolor{gray}{\lipsum} + +\backmatter +% bibliography +%\cleardoublepage +%\phantomsection +%\bibliographystyle{sapthesis} % BibTeX style +%\bibliography{bibliography} % BibTeX database without .bib extension + +\end{document} diff --git a/Master/texmf-dist/doc/latex/unifith/unifith-doc.pdf b/Master/texmf-dist/doc/latex/unifith/unifith-doc.pdf Binary files differnew file mode 100644 index 00000000000..9edf73ff768 --- /dev/null +++ b/Master/texmf-dist/doc/latex/unifith/unifith-doc.pdf diff --git a/Master/texmf-dist/doc/latex/unifith/unifith-doc.tex b/Master/texmf-dist/doc/latex/unifith/unifith-doc.tex new file mode 100644 index 00000000000..332ef0c2536 --- /dev/null +++ b/Master/texmf-dist/doc/latex/unifith/unifith-doc.tex @@ -0,0 +1,539 @@ +% !TeX encoding = UTF-8 +% !TeX program = pdflatex +% !TeX spellcheck = en_US + + +\documentclass[a5paper,11pt]{article} + +\usepackage[scale=0.85, footskip=0.8cm,heightrounded]{geometry} +\usepackage[T1]{fontenc} +\usepackage[helvratio=0.88]{newtxtext} +\usepackage{textcomp} +\usepackage{amsmath} +\usepackage[varg,cmintegrals,cmbraces]{newtxmath} +\usepackage{microtype} +\usepackage{graphicx} +\usepackage{color} +\definecolor{gray}{gray}{0.4} +\definecolor{sfondoblu}{rgb}{0.94,0.97,1} +\usepackage{listings} +\lstset{language=[LaTeX]TeX, + basicstyle=\scriptsize\ttfamily, + keywordstyle=\color{blue}\bfseries, + commentstyle=\color{gray}, + backgroundcolor=\color{sfondoblu}, + frameround=tttt, + frame=tlrb, + escapechar=|, + morekeywords={submitdate, cycle, courseorganizer, AcademicYear, copyyear, Faculty, course, PhDorganizer, IDnumber, advisor, examdate, examiner, authoremail, frontmatter, mainmatter, maketitle, tableofcontents, chapter, appendix, backmatter, dedication, selectlanguage,alttitle,thesistype}, + columns=flexible +} + +\usepackage{multicol} + +% eliminate dots in the table of contents +\makeatletter +\renewcommand{\@dotsep}{10000} +\makeatother + +\usepackage[bookmarks=false,hyperfootnotes=false]{hyperref} +\hypersetup{ + colorlinks=true, + linkcolor=blue, + anchorcolor=blue, + citecolor=blue, + urlcolor=blue, + pdftitle={unifith.cls documentation}, + pdfauthor={Francesco Biccari} +} + +\newcommand{\bs}{\textbackslash} +\newcommand{\sq}{\textquotesingle} + +\author{\small Francesco Biccari\thanks{\href{mailto:biccari@gmail.com}{biccari@gmail.com}}} +\title{\small Documentation of the \LaTeX\ class\\ + \Large \textbf{\texttt{unifith.cls}}\\ + \small \vspace{0.2cm} Version 1.0, 2019-08-07 +} +\date{} + +% degree + \providecommand{\degree}{\mbox{\textdegree}} + \providecommand{\g}{\degree} + + % gradi Celsius + \providecommand{\celsius}{\ensuremath{\textrm{\upshape\textdegree}\kern-\scriptspace\mathrm{C}}} + \providecommand{\C}{\celsius} + + % Angstrom + \providecommand{\angstrom}{\mbox{\AA}} + \providecommand{\A}{\angstrom} + + % micro + \providecommand{\micro}{\mbox{\textmu}} + + % Ohm + \providecommand{\ohm}{\ensuremath{\mbox{\textohm}}} + + % Napier's number + \providecommand{\eu}{\ensuremath{\mathrm{e}}} + + % imaginary unit + \providecommand{\iu}{\ensuremath{\mathrm{i}}} + + % roman subscript + \providecommand*{\rb}[1]{\ensuremath{_\mathrm{#1}}} + + % roman superscript + \providecommand*{\rp}[1]{\ensuremath{^\mathrm{#1}}} + + % differential (only math) + \providecommand{\di}{\mathop{}\!d} + + % derivative and partial derivative (only math) + \providecommand*{\der}[3][]{\frac{d^{#1}#2}{d #3^{#1}}} + \providecommand*{\pder}[3][]{% + \frac{\partial^{#1}#2}{\partial #3^{#1}}% + } + + % measurement unit + \providecommand*{\un}[1]{\ensuremath{\mathrm{\,#1}}} + + +\begin{document} +\maketitle + +\begin{abstract}\noindent +This document describes how to use \texttt{unifith.cls}, a \LaTeX\ document class for the typesetting of the theses of the ``University of Florence''. The official web page of \textsf{UniFiTh} is {\footnotesize\url{http://biccari.altervista.org/c/informatica/latex/unifith.php}}. +\end{abstract} + +\setcounter{tocdepth}{2} +\renewcommand{\columnseprule}{0.4pt} +\setlength{\columnsep}{1.5cm} + +\addtocontents{toc}{\protect\begin{multicols}{2}} +{\small +\tableofcontents} + +\clearpage + +\section{Introduction} + +After several years in my faculty I noticed that usually students spend a lot of time to refine the aesthetic aspect of their \LaTeX\ documents instead of focusing on the content. +This is against the philosophy of \LaTeX, which was created to relieve the writer from the typesetter's work. +Apart from the time spent, the resulting documents are obviously all different from each other and good aesthetic results are not always achieved. +This has a negative impact both on the student's work and on the university. +For these reasons I thought that a \LaTeX\ class for the theses of my +university would have been a good idea. +\textsf{UniFiTh} is the result of my work. +It has been developed starting from \textsf{Sapthesis} class of the same author. \textsf{UniFiTh} follows the rules of the Communication Plan of the University of Florence: {\footnotesize\url{https://www.unifi.it/ls-36-unifi-comunica.html}}. At that link you can find the guidelines for the preparation of the documents, the files of the logo and some examples. + +To give a look to a document composed by \textsf{UniFiTh} class, compile one of the several examples in the \texttt{examples} directory. +In those files the page layout and the layout choices are explained. +\textsf{UniFiTh} is released under the terms of the latest version of the +\href{http://www.latex-project.org/lppl/}{\LaTeX\ Project Public License}. + +I would like to thank the Italian \TeX\ user group (\href{http://www.guitex.org/}{GuIT}) for the help provided. I would like to thank also Giacomo Mazzamuto and Lorenzo Pattelli and all the users who reported bugs and suggestions. + +\section[Requirements\\ and installation]{Requirements and installation} +\label{requirements_installation} + +The simplest way to install \textsf{UniFiTh} is by the package manager of +your \TeX\ distribution (\TeX\ Live or MiK\TeX). For manual installation see +the \texttt{README} file. + +The \textsf{UniFiTh} package provides: the +\texttt{unifith.cls} class file; the documentation +\texttt{unifith-doc.pdf} (this file) and its source code; the logo of the +University of Florence; several usage examples. + + +\textsf{UniFiTh} explicitely loads the packages \textsf{xkeyval}, \textsf{etoolbox}, \textsf{geometry}, \textsf{ifxetex}, \textsf{xltxtra}, \textsf{fontenc}, \textsf{textcomp}, \textsf{lmodern}, \textsf{caption}, \textsf{graphicx}, \textsf{color}, \textsf{booktabs}, \textsf{amsmath}, \textsf{fancyhdr}. +Do \textbf{not} include these packages in the preamble of your document! + + + + + +\section{Usage} + +A \LaTeX\ document based on \textsf{UniFiTh} can be compiled only by the commands +\texttt{pdflatex} and \texttt{xelatex}. In this manual only \texttt{pdflatex} will be considered. + + +As usual, in order to use this class, you need to call it by +\begin{lstlisting} +\documentclass[|\textit{\texttt{options}}|]{unifith} +\end{lstlisting} +You have to specify the class options for your case (see Sec.~\ref{class_options}). Then you have to provide some fundamental information (title, author, etc\ldots) by specific commands in the preamble (see Sec.~\ref{commands_titlepage}). Finally, remember to follow a source code structure similar to those of the examples given in App.~\ref{sec:PhDexample} and~\ref{sec:LaMexample}. +Especially the usage of the commands \texttt{\bs frontmatter}, \texttt{\bs mainmatter} and \texttt{\bs backmatter} is mandatory, otherwise the page style of the document will be wrong! + +This class supports, at the moment, two languages: Italian and English. English is the default. +If your thesis contains only English or very few paragraphs in another language, do not use the \texttt{babel} package because completely useless. Instead, if you write in Italian, load the \texttt{babel} package with the +\texttt{italian} option: \texttt{\bs usepackage[italian]\{babel\}}. + +\subsection{Class options} +\label{class_options} +The following options can be passed to the \texttt{\bs documentclass} command. + +\begin{description} + +\item[\texttt{draft}] The usual \texttt{draft} option of the \LaTeX\ Standard Classes. +\item[\texttt{oneside}] The usual \texttt{oneside} option of the \LaTeX\ Standard Classes. +\item[\texttt{twoside}] (default) The usual \texttt{twoside} option of the \LaTeX\ Standard Classes. + +\item[\texttt{binding=\textsl{length}}] (zero default binding) +The value of this option is an offset of the text column. +It is useful to take into account the margin for the binding (ask to your bookbinder for information). +\item[\texttt{noexaminfo}] Suppress all the final exam informations. Indeed, by default, \textsf{UniFiTh} shows some information about the final thesis discussion on the back of the title page. By default it shows the phrase ``Thesis not yet defended''. Otherwise, as explained later, giving the commands +\texttt{\bs examdate\{\dots\}} and \texttt{\bs examiner\{\dots\}} the date and +the examiners list are shown. +\item[\texttt{nodefaultfont}] Avoid the loading of packages \textsf{fontenc}, \textsf{textcomp} and \textsf{lmodern}. +\item[\texttt{romandiff}] See App.~\ref{sec:usefulcommands}. +\item[\texttt{fem}] Use the feminine (only Italian): shows ``candidata'' instead of ``candidato''. +\end{description} + +\subsection[Commands for the\\ title page]{Commands for the title page} +\label{commands_titlepage} + +As usual, the title page is generated by the \texttt{\bs maketitle} command. +It needs some information that you can supply by the following commands +in the preamble. +\begin{description} +\item[\texttt{\bs title\{\dots\}}] Mandatory. Title. + +\item[\texttt{\bs subtitle\{\dots\}}] Optional. Subtitle (try to avoid a subtitle). + +\item[\texttt{\bs author\{\dots\}}] Mandatory. Author (student's name). + +\item[\texttt{\bs IDnumber\{\dots\}}] Mandatory. ID number (\textit{matricola} in Italian). + +\item[\texttt{\bs course\{\dots\}}] Mandatory. Use the official Italian name of the course. + +\item[\texttt{\bs courseorganizer\{\dots\}}] Mandatory. Course organizer. + +\item[\texttt{\bs AcademicYear\{\dots\}}] Academic Year. + +\item[\texttt{\bs copyyear\{\dots\}}] Mandatory. Copyright year (usually the +graduation year). + +\item[\texttt{\bs thesistype\{\dots\}}] Optional. Type of thesis (usually PhD thesis, Master thesis, and so on.). + +\item[\texttt{\bs advisor\{\dots\}}] You must specify at least one advisor. +If you have more than one advisor, put several advisor commands in the correct order:\\ +\texttt{\bs advisor\{Prof.~Pippo\}} \texttt{\bs advisor\{Dr.~Pluto\}} + +\item[\texttt{\bs coadvisor[\dots]\{\dots\}}] Optional. Co-advisors of the thesis. +Same syntax of the \texttt{\bs advisor} command. If the optional argument \texttt{ext} is specified, ``External advisor'' will be printed instead of ``Co-Advisor''. + +\item[\texttt{\bs reviewer\{\dots\}}] Optional. Reviewers of the thesis. +Same syntax of the \texttt{\bs advisor} command. The list of the reviewer is preceded by the a text which can be specified by the \texttt{\bs reviewerlabel\{\dots\}} command. + +\item[\texttt{\bs authoremail\{\dots\}}] Mandatory. Email of the thesis author. +It is automatically hyper-linked if \textsf{hyperref} package is loaded. + +\item[\texttt{\bs versiondate\{\dots\}}] Optional. Date version of the thesis. + +\item[\texttt{\bs website\{\dots\}}] Optional. Thesis website. Automatically +hyper-linked if \textsf{hyperref} package is loaded. + +\item[\texttt{\bs ISBN\{\dots\}}] Optional. ISBN + +\item[\texttt{\bs copyrightstatement\{\dots\}}] Optional. Specify a copyright statement that will be printed in place of the default one. + + +\item[\texttt{\bs examdate\{\dots\}}] Optional. Date of the final exam.\\ +Example: \texttt{\bs examdate\{16 February 2010\}}. + +\item[\texttt{\bs examiner[\dots]\{\dots\}}] Optional. Specifies the members of the +board of examiners of the final exam. Usage similar to \texttt{\bs advisor} command. The optional argument can be used to specify the role of that examiner in the commission. + +\item[\texttt{\bs cycle\{\dots\}}] Mandatory only for PhD's. Use the form: \texttt{\bs cycle\{XXII\}} + +\item[\texttt{\bs director\{\dots\}}] Only for Specialization. Mandatory. + + +\end{description} + + + +\subsection[Other commands\\ and environments]{Other commands and environments} + +\begin{description} + +\item[\texttt{\bs dedication\{\dots\}}] A command to compose the dedication. + +\item[\texttt{abstract}] An environment to compose the abstract of your document. This environment has an optional parameter to choose the title of the abstract section. +If you use a language for the abstract different from that of the thesis, consider the \texttt{\bs selectlanguage\{\dots\}} command provided by the \texttt{babel} package. + +\item[\texttt{acknowledgments}] An environment to compose the acknowledgments of your document. This environment has an optional parameter to choose the title of the acknowledgments section. +If you use a language for the acknowledgments different from that of the thesis, consider the \texttt{\bs selectlanguage\{\dots\}} command provided by the \texttt{babel} package. + + +\end{description} + +The \textsf{UniFiTh} class defines also the color \texttt{unifiblue} which is the \emph{UniFi blue}: RGB(0,82,147). +Example of usage: \texttt{\bs textcolor\{unifiblue\}\{blah blah\}} + + +\section{Recommendations} + +\begin{itemize} + +\item Do \textbf{not} change the default layout. If you want to change the interline spacing, do not use the \texttt{\bs linespread} command. Load instead the \textsf{setspace} package and use, for example, the \texttt{\bs onehalfspacing} command. + +\item Do \textbf{not} load the packages already loaded by \textsf{UniFiTh} (see Sec.~\ref{requirements_installation}). + +\item As you already should know, \LaTeX\ can process only documents +in pure ASCII. If you want to insert \emph{directly} other characters, not included in the 128 ASCII characters (for example accented letters), you have to use a particular text encoding for your source file. Then you have to ``tell'' to \LaTeX\ which encoding you have chosen by the packages \texttt{inputenc}. It is always recommended to use UTF-8 character encoding and specify this choice also by the \emph{magic lines} at the beginning of the source code (see the examples in App.~\ref{sec:PhDexample} and~\ref{sec:LaMexample}). + +\item Respect the following thesis structure: + +\begin{itemize} +\item Title page (\texttt{\bs maketitle} command) +\item Dedication (\texttt{\bs dedication} command) +\item Abstract (\texttt{abstract} environment) +\item Acknowledgements (\texttt{acknowledgments} environment) +\item Table of contents (\texttt{\bs tableofcontens} command) +\item Chapters +\item Appendices +\item Bibliography +\end{itemize} + +\item It is recommended to avoid or limit the acknowledgments in a thesis, it +is not very professional. The dedication should be enough. + +\item Do not put any preface in your thesis. The preface should be written only by an eminent expert in the field to comment exceptionally important results of the student. + +\item Usually tables and figures are centered. Remember that, according to the typographic rules, the table captions should be placed \textbf{above} the table, whereas the figure caption should be placed \textbf{below} the figure. + +\item If the figure has a small width, it is possible to put the figure caption +aside the figure using the \texttt{sidecap} package (not preloaded by \textsf{UniFiTh}). + +\item Avoid the use of colors unless really necessary. Remember that the figures should be readable even if they are printed in gray scale! + +\item Subscripts and superscripts should be in italic if they represent variable quantities, whereas should be in roman if they are simply labels. + +\item The name of operators should be typed in roman. Example: use $\sin$ (\texttt{\$\bs sin\$}) instead of $sin$ (\texttt{\$sin\$}). + +\item The margin notes are rarely used in scientific documents and should \textbf{not} be used in a scientific thesis. + +\item Do not divide the bibliography per chapter unless it is \textbf{really} necessary. +This will save you from wasting a lot of time to prepare your \LaTeX\ source code. +Order your bibliography alphabetically according to the +first author surname: this order is very useful, contrary to the other typical order, the citation order. + +\end{itemize} + + +\appendix + +\section{A very brief introduction to the \TeX\ world} + +Many people want to (or are compelled to) write in \LaTeX\ without studying +a basic manual. Here follows a very brief introduction to the \TeX\ world. + +\TeX, the document preparation system designed by Donald Knuth in 1978, is a program to typeset documents. +It is a mark-up language: you write a simple text decorated with \TeX\ commands (source code) which is then compiled to obtain the final product, a document in pdf format. +\LaTeX\ is just a set of macros, written in \TeX, to simplify the writing of the source code: it can be thought as a simpler programming language with respect to \TeX. A source code written in \LaTeX\ can be compiled by several ``compilers'': \texttt{pdflatex} (the most common), or \texttt{xelatex}, or others. + +The following list of \LaTeX\ manuals, may be especially useful for Italian authors. + +\begin{itemize} +\item \href{http://www.lorenzopantieri.net/LaTeX_files/ArteLaTeX.pdf}{\textsc{L. +Pantieri \& T. Gordini}, \textit{L'arte di scrivere con} \LaTeX, (2017)} + +\item \href{http://mirror.ctan.org/info/symbols/comprehensive/symbols-a4.pdf}{\textsc{S. Pakin}, \textit{The comprehensive} \LaTeX\ \textit{symbol list}, (2017)} + +\item \href{http://profs.sci.univr.it/~gregorio/breveguida.pdf}{\textsc{E. Gregorio}, \LaTeX\textit{: breve guida ai pacchetti di uso pi\`u comune}, (2010)} +\end{itemize} + +In order to use \LaTeX, you have to install a \TeX\ distribution. It contains the compilers, several fonts and other files needed by the compilers and also many \emph{packages}, which can be thought as libraries or extensions of \LaTeX. The most famous distributions are \href{http://miktex.org/}{MiKTeX} (available only for Windows), \href{http://www.tug.org/texlive/}{TeX Live} (available both for Windows and Linux) and \href{http://www.tug.org/mactex/2011/}{MacTeX} (available only for Mac OS). + +Finally we discuss the editor, that is the program used to write your source file. Since a source file written in \LaTeX, like in any other programming language, is a simple text file, you can write your code with any text editor you want (for example Notepad in Windows). However the suggested editors are: +\begin{itemize} +\item \href{http://tug.org/texworks/}{TeXworks}. Already installed with any \TeX\ distribution. Very simple and powerful. Use TeXworks if you are not an expert. Enrico Gregorio has written a very good and brief TeXworks manual in Italian, which can be found at: {\small \url{http://profs.sci.univr.it/~gregorio/introtexworks.pdf}}. + +\item \href{http://texstudio.sourceforge.net/}{TeXstudio} (cross-platform), \href{http://www.xm1math.net/texmaker/}{TeXmaker} (cross-platform), \href{http://pages.uoregon.edu/koch/texshop/}{TeXshop} (only for Mac), \href{http://kile.sourceforge.net/}{Kile} (only for Linux). Powerful editors. + +\item \textbf{Avoid} other editors unless you know what you are doing! + +\end{itemize} + +Finally we explain how to compile the example documents provided in the \textsf{UniFiTh} package. Double click on one of the \texttt{.tex} file in the \texttt{examples} folder. +TeXworks should start showing the content of that file. +The \texttt{pdflatex} compiler should be automatically selected thanks to the \emph{magic lines} placed at the beginning of the file. +Now, in order to compile, press the green button. +At the end of the compilation the resulting pdf appears in a separate window. Remember to compile at least three times, because \LaTeX\ needs more than one compilation to correctly resolve the internal cross references (for example for the table of contents composition, or when you refer to a figure by the \texttt{\bs label}\,--\,\texttt{\bs ref}\,/\,\texttt{\bs pageref} mechanism). + + +\clearpage +\section{PhD thesis example} +\label{sec:PhDexample} + +\begin{lstlisting} +% !TeX encoding = UTF-8 +% !TeX program = pdflatex +% !TeX spellcheck = en_US + +\documentclass[binding=0.6cm]{unifith} + +\usepackage{microtype} +\usepackage[english]{babel} +\usepackage[utf8]{inputenc} +\usepackage{hyperref} +\hypersetup{pdftitle={My thesis},pdfauthor={Francesco Biccari}} + +\title{My thesis} +\alttitle{Optional anternative title (for example different language)} +\author{Francesco Biccari} +\IDnumber{166350} +\course{Corso di Dottorato in Fisica e Astronomia} +\courseorganizer{Dipartimento di Fisica e Astronomia} +\cycle{Ciclo XXXII} +\AcademicYear{2018/2019} + +\thesistype{PhD thesis} +\copyyear{2020} +\advisor{Prof. Caio} +\advisor{Dr. Sempronio} +\authoremail{pippo@pippo.com} + +\begin{document} + +\frontmatter +\maketitle +\dedication{Dedicated to\\ Donald Knuth} + +\begin{abstract} +This thesis deals with myself. +\end{abstract} + +\tableofcontents + +\mainmatter +\chapter{Introduction} +... + +\backmatter +\cleardoublepage +\phantomsection % Give this command only if hyperref is loaded +\addcontentsline{toc}{chapter}{\bibname} +% Here put the code for the bibliography. You can use BibTeX or +% the BibLaTeX package or the simple environment thebibliography. +\end{document} +\end{lstlisting} + + +\clearpage +\section[Laurea (Magistrale)\\ thesis example]{Laurea (Magistrale) thesis example} +\label{sec:LaMexample} + +\begin{lstlisting} +% !TeX encoding = UTF-8 +% !TeX program = pdflatex +% !TeX spellcheck = en_US + +\documentclass[binding=0.6cm]{unifith} + +\usepackage{microtype} +\usepackage[italian]{babel} +\usepackage[utf8]{inputenc} +\usepackage{hyperref} +\hypersetup{pdftitle={La mia tesi},pdfauthor={Francesco Biccari}} + +\title{La mia tesi} +\alttitle{Titolo alternativo opzionale (tipicamente in inglese)} +\author{Francesco Biccari} +\IDnumber{166350} +\course{Corso di Laurea Magistrale in Fisica e Astronomia} +\courseorganizer{Scuola di Scienze Matematiche, Fisiche e Naturali} +\AcademicYear{2018/2019} + +\thesistype{Master thesis} +\copyyear{2020} +\advisor{Prof. Caio} +\advisor{Dr. Sempronio} +\authoremail{pippo@pippo.com} + +\begin{document} + +\frontmatter +\maketitle +\dedication{Dedicato a\\ Donald Knuth} + +\begin{abstract} +Questa tesi parla di me. +\end{abstract} + +\tableofcontents + +\mainmatter +\chapter{Introduzione} +... + +\backmatter +\cleardoublepage +\phantomsection % Give this command only if hyperref is loaded +\addcontentsline{toc}{chapter}{\bibname} +% Here put the code for the bibliography. You can use BibTeX or +% the BibLaTeX package or the simple environment thebibliography. +\end{document} +\end{lstlisting} + + + +\clearpage +\section{Other useful commands} +\label{sec:usefulcommands} + +\begin{description} +\item[\texttt{\bs eu}] Napier's number, $\mathrm{e}$, in roman. + +\item[\texttt{\bs iu}] Imaginary unit, $\mathrm{i}$, in roman. + +\item[\texttt{\bs der\{\dots\}\{\dots\}}] Derivative. The first argument represents the function to derive while the second the variables separated by commas. The differential symbol is automatically inserted. Examples: +\texttt{\bs der\{f\}\{x\}}, \texttt{\bs der\{f\}\{x,y\}}, \texttt{\bs der\{f\}\{*\{3\}\{x\}\}}, +\texttt{\bs der\{f\}\{*\{2\}\{x\},*\{2\}\{y\},z\}}. + +\item[\texttt{\bs pder\{\dots\}\{\dots\}}] Partial derivative. Same syntax of the \texttt{\bs der} command. + +\item[\texttt{\bs rb\{\dots\}}] Roman suBscript + +\item[\texttt{\bs rp\{\dots\}}] Roman suPerscript + +\item[\texttt{\bs tb\{\dots\}}] Text suBscript + +\item[\texttt{\bs tp\{\dots\}}] Text suPerscript + +\item[\texttt{\bs un\{\dots\}}] Useful command to typeset measurement units in the correct way, e.g. \texttt{25\bs un\{m/s\}}, +\texttt{13\bs un\{kg\bs ,cm\^{}\{-3\}\}}. It can be used both inside or outside the math environment. +For heavy usage of measurement units and to insert numbers in the form +\texttt{1.4e-5}, the package \textsf{siunitx} is recommended. + +\item[\texttt{\bs mnote\{\dots\}}] Fancy margin notes + +\item[\texttt{\bs g}] Shortcut for the \texttt{\bs degree} command. Example: \texttt{45\bs g} produces 45\g. + +\item[\texttt{\bs C}] Shortcut for the \texttt{\bs celsius} command. Example: \texttt{37\bs ,\bs C} produces 37\,\C. (Not available in math mode compiling with \texttt{xelatex}). + +\item[\texttt{\bs A}] Angstrom. Example: \texttt{10\bs ,\bs A} produces 10\,\A. + +\item[\texttt{\bs micro}] Micro prefix. Example: \texttt{7\bs ,\bs micro m} produces 7\,\micro m. + +\item[\texttt{\bs ohm}] Ohm. Example: \texttt{100\bs ,\bs ohm} produces 100\,\ohm. + +\item[\texttt{\bs di}] Differential symbol with automatic spacing.\\ Example: +\texttt{\$\bs int x \bs di x\$} produces $\int x \di x$. If you prefer the differential symbol in roman ($\mathrm{d}$) you can give the option \texttt{romandiff} in the document class options. + +\item[\texttt{\bs x}] Shortcut for the \texttt{\bs times} command. E.g.: \texttt{\$7 \bs x 10\^{}5\$} produces $7 \times 10^5$. + +\end{description} + + + + + + +\addtocontents{toc}{\protect\end{multicols}} +\end{document} |