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.tex80
1 files changed, 43 insertions, 37 deletions
diff --git a/Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex b/Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex
index ef416cff199..6273b65ac42 100644
--- a/Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex
+++ b/Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex
@@ -1,3 +1,7 @@
+% !TEX encoding = UTF-8
+% !TEX program = pdflatex
+% !TEX spellcheck = en_US
+
\documentclass[a5paper,11pt]{article}
\usepackage[scale=0.85, footskip=0.8cm,heightrounded]{geometry}
@@ -51,7 +55,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 2.8, 2011-09-13
+ \small \vspace{0.2cm} Version 3.0, 2012-01-05
}
\date{}
@@ -138,8 +142,8 @@ In that file the page layout and the layout choices are explained.
\textsf{Sapthesis} is released under the terms of the latest version of the
\href{http://www.latex-project.org/lppl/}{\LaTeX\ Project Public License}.
-I would thank the Italian \TeX\ user group (\href{http://www.guitex.org/}{GuIT}) for the help provided, in particular Prof.~Enrico Gregorio.
-I would thank also Dr.~Gabriele Di Segni and Dr.~Matteo Siccardi.
+I would thank the Italian \TeX\ user group (\href{http://www.guitex.org/}{GuIT}) for the help provided, in particular Enrico Gregorio.
+I would thank also (alphabetically) Claudio Beccari, Davide Di Bucchianico, Gabriele Di Segni, Giovanni Nuccetelli, Davide Paltrinieri, Francesco Pannarale and Matteo Siccardi.
\section[Requirements\\ and installation]{Requirements and installation}
@@ -157,8 +161,8 @@ 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{emptypage}.
-It is highly recommended to not include these packages in the preamble of your document because already loaded by \textsf{sapthesis}.
+\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}.
+Do \textbf{not} include these packages in the preamble of your document!
@@ -170,12 +174,12 @@ A \LaTeX\ document based on \textsf{sapthesis} can be compiled only by the comma
\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
+As usual, in order to use this class, you need to call it by
\begin{lstlisting}
\documentclass[|\textit{\texttt{options}}|]{sapthesis}
\end{lstlisting}
-You have to specify the correct options for your case (see Sec.~\ref{class_options}). Then you have to provide some fundamental information (title, author, etc\ldots) by specific commands (see Sec.~\ref{commands_titlepage}). Finally remember that it is important to follow a source code structure similar to those of the examples given in Sec.~\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.
+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 (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
@@ -183,37 +187,37 @@ If your thesis contains only English or very few paragraphs in another language,
\subsection{Class options}
\label{class_options}
-These options can be passed in the documentclass command.
+The following options can be passed in the documentclass command.
\begin{description}
-\item[\texttt{PhD}, \texttt{PhDA}, \texttt{PhDB}] The last two options are respectively for PhD theses in Physics and Mathematics. If your PhD is not in Physics or Mathematics, use the simple \texttt{PhD} option. (``Dottorato di ricerca'')
-\item[\texttt{LaM}] Option to typeset a Laurea Magistrale thesis. (``Laurea Specialistica'')
-\item[\texttt{Lau}] Option to typeset a Laurea thesis. (``Laurea Triennale'')
-\item[\texttt{MasterP}, \texttt{MasterS}] Options to typeset a thesis for a
-First level master (``Master di primo livello'') and a Second level master (``Master di secondo livello'') respectively.
-\item[\texttt{draft}] This is the usual draft option of the \LaTeX\ Standard Classes
-\item[\texttt{oneside}] The usual oneside option of the \LaTeX\ Standard Classes
-\item[\texttt{twoside}] (default) The usual twoside option of the \LaTeX\ Standard Classes
-
-\item[\texttt{bn}] This option typesets the frontispiece in black and white
-(using the b/w logo, \texttt{marchiologo\_nero\_positivo.pdf}, instead of the colored one) and passes the \texttt{monochrome} option to \textsf{color} and
+\item[\texttt{PhD}] Option to typeset a \textit{Dottorato di Ricerca} (PhD) thesis.
+\item[\texttt{LaM}] Option to typeset a \textit{Laurea Magistrale} (Master's degree) thesis.
+\item[\texttt{Lau}] Option to typeset a \textit{Laurea} (Bachelor's degree) thesis.
+\item[\texttt{MasterP}] Option to typeset a thesis for a \textit{Master di primo livello} (First level master).
+\item[\texttt{MasterS}] Option to typeset a thesis for a \textit{Master di secondo livello} (Second level master).
+\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{bn}] This option typesets the title page in black and white
+(using the b/w logo, \texttt{sapienza-MLblack-pos.pdf}, instead of the colored one) and passes the \texttt{monochrome} option to \textsf{color} and
\textsf{xcolor} packages.
\item[\texttt{binding=\textsl{length}}] (zero default binding)
-The value of this option is an offset of the the text column.
-It is useful to take in account the margin for the binding (ask to your bookbinder for information).
+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}] Remove the final exam informations.
\item[\texttt{italian} or \texttt{english}] Explicitly declare the language of
-the frontispiece. Useful when you want to write the frontispiece in a language
+the title page. Useful when you want to write the title page in a language
and the thesis in a different language.
-\item[\texttt{nodefaultfont}] To be documented.
+\item[\texttt{nodefaultfont}] Avoid the loading of packages \textsf{fontenc}, \textsf{textcomp} and \textsf{lmodern}.
\item[\texttt{romandiff}] See App.~\ref{sec:usefulcommands}.
\end{description}
-\subsection[Commands for the\\ titlepage]{Commands for the titlepage}
+\subsection[Commands for the\\ title page]{Commands for the title page}
\label{commands_titlepage}
-As usual, the titlepage is generated by the \texttt{\bs maketitle} command.
+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 of the document.
\begin{description}
@@ -221,11 +225,11 @@ in the preamble of the document.
\item[\texttt{\bs author\{\dots\}}] Mandatory
-\item[\texttt{\bs IDnumber\{\dots\}}] Mandatory. Your ID number (\textit{matricola} in italian)
+\item[\texttt{\bs IDnumber\{\dots\}}] Mandatory. Your ID number (\textit{matricola} in Italian)
-\item[\texttt{\bs course[\dots]\{\dots\}}] Use Italian. Mandatory except for PhDA and PhDB options. The optional argument specifies the course name in another language, which is needed only in the case of PhD's.
+\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 courseorganizer\{\dots\}}] Mandatory except for PhDA and PhDB options.
+\item[\texttt{\bs courseorganizer\{\dots\}}] Mandatory.
\item[\texttt{\bs cycle\{\dots\}}] Mandatory only for PhD's. Use the form: \texttt{\bs cycle\{XXII\}}
@@ -266,7 +270,8 @@ hyper-linked if \textsf{hyperref} package is loaded.
\item[\texttt{\bs dedication\{\dots\}}] A command to compose the dedication.
-\item[\texttt{abstract}] An environment to compose the abstract of your document.
+\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.
@@ -284,9 +289,10 @@ This color is switched to black if the \texttt{bn} option is in use. Example of
\item Do \textbf{not} change the default layout and do \textbf{not} use packages which can modify the layout of your thesis.
+\item Do \textbf{not} load the following packages in the preamble of your document because already loaded by \textsf{sapthesis}: \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}.
-\item As you already should know, \LaTeX\ can process only document
-in pure ASCII. If you want to insert \emph{directly} other characters, non included in the 128 ASCII
+\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.
@@ -309,7 +315,7 @@ 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, \emph{the table captions should be placed above the table}, whereas the figure caption should be placed below the figure.
+\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 in \texttt{sapthesis.cls}).
@@ -320,9 +326,9 @@ aside the figure using the \texttt{sidecap} package (not preloaded in \texttt{sa
\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 \emph{should not be used in a thesis}.
+\item The margin notes are rarely used in scientific documents and should \textbf{not} be used in a thesis.
-\item Do not divide the bibliography per chapter unless it is really necessary.
+\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. In this regard
@@ -348,10 +354,10 @@ italian students.
Pantieri \& T. Gordini}, \textit{L'arte di scrivere con \LaTeX}, (2011)}
\bibitem{Pakin_Symbol}
-\href{http://www.ctan.org/tex-archive/info/symbols/comprehensive/symbols-a4.pdf}{\textsc{S. Pakin}, \textit{The comprehensive \LaTeX\ symbol list}, (2008)}
+\href{http://www.ctan.org/tex-archive/info/symbols/comprehensive/symbols-a4.pdf}{\textsc{S. Pakin}, \textit{The comprehensive \LaTeX\ symbol list}, (2009)}
\bibitem{Gregorio_Pacchetti}
-\href{http://profs.sci.univr.it/~gregorio/breveguida.pdf}{\textsc{E. Gregorio}, \textit{\LaTeX: breve guida ai pacchetti di uso pi\`u comune}, (2009)}
+\href{http://profs.sci.univr.it/~gregorio/breveguida.pdf}{\textsc{E. Gregorio}, \textit{\LaTeX: breve guida ai pacchetti di uso pi\`u comune}, (2010)}
\end{thebibliography}