summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex')
-rw-r--r--Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex51
1 files changed, 28 insertions, 23 deletions
diff --git a/Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex b/Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex
index 9afe86e72c7..67c736eceb6 100644
--- a/Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex
+++ b/Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex
@@ -53,7 +53,7 @@
\author{\small Francesco Biccari\thanks{\href{mailto:biccari@gmail.com}{biccari@gmail.com}}}
\title{\small Documentation of the \LaTeX\ class\\
\Large \textbf{\texttt{sapthesis.cls}}\\
- \small \vspace{0.2cm} Version 3.8, 2015-12-04
+ \small \vspace{0.2cm} Version 4.1, 2018-08-07
}
\date{}
@@ -129,7 +129,7 @@ logo and a lot of strict graphic rules for official documents were introduced.%
\footnote{A thesis is not an official document and therefore these guidelines can not be applied (private communication with Laura Gobbo, Ufficio Stampa e Comunicazione Sapienza -- Universit\`a di Roma).
However some Microsoft Word templates, with a completely different style, are provided.
To give a look to the new Sapienza style see
-\href{http://www.uniroma1.it/ateneo/chi-siamo/identit\%C3\%A0-visiva-e-marchio}{Identit\`a visiva e marchio} and \href{http://www.uniroma1.it/logotesi}{Template tesi}.}
+\href{https://www.uniroma1.it/it/pagina/marchio-identita-visiva-e-sistema-grafico}{Marchio, identità visiva e sistema grafico} and \href{https://www.uniroma1.it/it/pagina/impaginazione-della-tesi-e-logo}{Template tesi}.}
For these reasons I thought that a \LaTeX\ class for the theses of my
university would have been a good idea.
@@ -157,7 +157,7 @@ Bib\TeX\ way to compose your bibliography and if your thesis is written in
English (its usage is not mandatory).
-\textsf{Sapthesis} explicitely loads the packages \textsf{xkeyval}, \textsf{geometry}, \textsf{ifxetex}, \textsf{xltxtra}, \textsf{fontenc}, \textsf{textcomp}, \textsf{lmodern}, \textsf{caption}, \textsf{graphicx}, \textsf{color}, \textsf{booktabs}, \textsf{amsmath}, \textsf{fancyhdr}.
+\textsf{Sapthesis} 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!
@@ -223,19 +223,21 @@ 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.
+\item[\texttt{\bs title\{\dots\}}] Mandatory. Title.
-\item[\texttt{\bs author\{\dots\}}] Mandatory
+\item[\texttt{\bs subtitle\{\dots\}}] Optional. Subtitle (try to avoid a subtitle).
-\item[\texttt{\bs IDnumber\{\dots\}}] Mandatory. Your ID number (\textit{matricola} in Italian)
+\item[\texttt{\bs author\{\dots\}}] Mandatory. Author (student's name).
-\item[\texttt{\bs course[\dots]\{\dots\}}] Mandatory. Use the official Italian name of the course. The optional argument specifies the course name in another language, which is needed in the case of PhD's theses because of the ``requirements'' declaration.
+\item[\texttt{\bs IDnumber\{\dots\}}] Mandatory. ID number (\textit{matricola} in Italian).
-\item[\texttt{\bs courseorganizer\{\dots\}}] Mandatory.
+\item[\texttt{\bs course[\dots]\{\dots\}}] Mandatory. Use the official Italian name of the course. If the optional argument \texttt{override} is specified, the mandatory argument is used to specify the entire course line in the frontispiece. In this way it is possible to override the behavior of the class (not recommended!).
+
+\item[\texttt{\bs courseorganizer\{\dots\}}] Mandatory. Course organizer.
\item[\texttt{\bs submitdate\{\dots\}}] Mandatory. Use the form \texttt{\bs submitdate\{April 2009\}} for PhD's and the form \texttt{\bs submitdate\{2009/2010\}} for Laurea theses.
-\item[\texttt{\bs AcademicYear\{\dots\}}] Alias for \texttt{\bs submitdate}.
+\item[\texttt{\bs AcademicYear\{\dots\}}] Alias for \texttt{\bs submitdate}. Academic Year.
\item[\texttt{\bs copyyear\{\dots\}}] Mandatory. Copyright year (usually the
graduation year).
@@ -244,8 +246,11 @@ graduation year).
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\}}] Optional. Co-advisors of the thesis.
-Same syntax of the \texttt{\bs advisor} command.
+\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.
@@ -257,11 +262,14 @@ 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\}}] Optional. Specifies the members of the
-board of examiners of the final exam. Usage similar to \texttt{\bs advisor} command.
+\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\}}
@@ -301,15 +309,12 @@ This color is switched to black if the \texttt{bn} option is in use. Example of
\begin{itemize}
-\item Do \textbf{not} change the default layout and do \textbf{not} use packages which can modify the layout of your thesis. However if you want to change the interline spacing, do not use the \texttt{\bs linespread} command. Load instead the \textsf{setspace} package and use the \texttt{\bs onehalfspacing} command.
+\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{sapthesis} (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} or \texttt{inputenx}.
-
-However, if your thesis is in English, I suggest to avoid the use of a particular text encoding for the source code because you will insert non ASCII characters very seldom. For this reason it is better to write these characters by the usage of the \LaTeX\ commands (for example \texttt{\bs\sq e} for the \'e letter), avoiding to load \texttt{inputenc} or \texttt{inputenx} package. This has another advantage, in fact your source file will be very portable.
+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:
@@ -365,9 +370,9 @@ The following list of \LaTeX\ manuals, may be especially useful for Italian auth
\begin{itemize}
\item \href{http://www.lorenzopantieri.net/LaTeX_files/ArteLaTeX.pdf}{\textsc{L.
-Pantieri \& T. Gordini}, \textit{L'arte di scrivere con} \LaTeX, (2012)}
+Pantieri \& T. Gordini}, \textit{L'arte di scrivere con} \LaTeX, (2017)}
-\item \href{http://www.ctan.org/tex-archive/info/symbols/comprehensive/symbols-a4.pdf}{\textsc{S. Pakin}, \textit{The comprehensive} \LaTeX\ \textit{symbol list}, (2015)}
+\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}
@@ -376,7 +381,7 @@ In order to use \LaTeX, you have to install a \TeX\ distribution. It contains th
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/egtex.html}}.
+\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.
@@ -490,7 +495,7 @@ This thesis deals with myself.
\usepackage{microtype}
\usepackage[italian]{babel}
-\usepackage[utf8]{inputenx}
+\usepackage[utf8]{inputenc}
\usepackage{hyperref}
\hypersetup{pdftitle={La mia tesi},pdfauthor={Francesco Biccari}}
@@ -545,7 +550,7 @@ Questa tesi parla di me.
\usepackage{microtype}
\usepackage[italian]{babel}
-\usepackage[utf8]{inputenx}
+\usepackage[utf8]{inputenc}
\usepackage{hyperref}
\hypersetup{pdftitle={La mia tesi},pdfauthor={Francesco Biccari}}