summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2013-08-21 22:07:40 +0000
committerKarl Berry <karl@freefriends.org>2013-08-21 22:07:40 +0000
commit60db445b187defd29b9b812162d897c90425b092 (patch)
tree1c7f653011a8356138ee6584d36ab93bb45f2268 /Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex
parent74d27605eb40aa659c59e19d5dbee6bc13935397 (diff)
sapthesis (21aug13)
git-svn-id: svn://tug.org/texlive/trunk@31487 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex')
-rw-r--r--Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex147
1 files changed, 115 insertions, 32 deletions
diff --git a/Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex b/Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex
index c6164d6830d..d5e21735c79 100644
--- a/Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex
+++ b/Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex
@@ -6,8 +6,10 @@
\usepackage[scale=0.85, footskip=0.8cm,heightrounded]{geometry}
\usepackage[T1]{fontenc}
-\usepackage{txfonts}
-\usepackage[warn]{textcomp}
+\usepackage[scaled=1]{newtxtext}
+\usepackage{textcomp}
+\usepackage{amsmath}
+\usepackage[varg,cmintegrals,cmbraces]{newtxmath}
\usepackage{microtype}
\usepackage{graphicx}
\usepackage{color}
@@ -15,14 +17,14 @@
\definecolor{sfondoblu}{rgb}{0.94,0.97,1}
\usepackage{listings}
\lstset{language=[LaTeX]TeX,
- basicstyle=\footnotesize\ttfamily,
+ 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},
+ morekeywords={submitdate, cycle, courseorganizer, AcademicYear, copyyear, Faculty, course, PhDorganizer, IDnumber, advisor, examdate, examiner, authoremail, frontmatter, mainmatter, maketitle, tableofcontents, chapter, appendix, backmatter, dedication, selectlanguage, tutor, tutorcoord, schoolname, schooladdress, schoolwebsite, schoolprincipal},
columns=flexible
}
@@ -50,7 +52,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.2, 2012-08-15
+ \small \vspace{0.2cm} Version 3.7, 2013-07-20
}
\date{}
@@ -126,19 +128,17 @@ 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/ufficiostampa/identita.php}{Identit\`a visiva}.}
+\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}.}
For these reasons I thought that a \LaTeX\ class for the theses of my
university would have been a good idea.
\textsf{Sapthesis} is the result of my work.
-To give a look to a document composed by \textsf{sapthesis} class see the file
-\texttt{sapthesis-example.pdf}.
-In that file the page layout and the layout choices are explained.
+To give a look to a document composed by \textsf{sapthesis} 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{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 Enrico Gregorio.
-I would thank also (alphabetically) Claudio Beccari, Davide Di Bucchianico, Gabriele Di Segni, Matteo Ipri, Giovanni Nuccetelli, Davide Paltrinieri, Francesco Pannarale and Matteo Siccardi.
+I would like to thank the Italian \TeX\ user group (\href{http://www.guitex.org/}{GuIT}) for the help provided, in particular Enrico Gregorio and Claudio Beccari. I would also thank all the users who reported bugs and suggestions.
\section[Requirements\\ and installation]{Requirements and installation}
@@ -149,8 +149,7 @@ the \texttt{README} file.
The \textsf{sapthesis} package provides: the
\texttt{sapthesis.cls} class file; the documentation
\texttt{sapthesis-doc.pdf} (this file) and its source code; the logos of
-Sapienza university; \texttt{sapthesis-example.pdf}, an usage example of
-the class and its source code; an English Bib\TeX\ style, called
+Sapienza university; several usage examples; an English Bib\TeX\ style, called
\texttt{sapthesis.bst}, which can be used, obviously, only if you use the
Bib\TeX\ way to compose your bibliography and if your thesis is written in
English (its usage is not mandatory).
@@ -182,7 +181,7 @@ If your thesis contains only English or very few paragraphs in another language,
\subsection{Class options}
\label{class_options}
-The following options can be passed in the documentclass command.
+The following options can be passed to the documentclass command.
\begin{description}
\item[\texttt{PhD}] Option to typeset a \textit{Dottorato di Ricerca} (PhD) thesis.
@@ -190,6 +189,9 @@ The following options can be passed in the documentclass command.
\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{TFA}] Option to typeset the final report for a \textit{Tirocinio Formativo Attivo}.
+\item[\texttt{Specialization}] Option to typeset a thesis for a \textit{Specializzazione}.
+
\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.
@@ -215,7 +217,7 @@ and the thesis in a different language.
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.
+in the preamble.
\begin{description}
\item[\texttt{\bs title\{\dots\}}] Mandatory.
@@ -231,6 +233,8 @@ in the preamble of the document.
\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 copyyear\{\dots\}}] Mandatory. Copyright year (usually the
graduation year).
@@ -241,6 +245,10 @@ If you have more than one advisor, put several advisor commands in the correct o
\item[\texttt{\bs coadvisor\{\dots\}}] Optional. Co-advisors of the thesis.
Same syntax of the \texttt{\bs advisor} command.
+\item[\texttt{\bs tutor\{\dots\}} and \texttt{\bs tutorcoord\{\dots\}}] Only for TFA. Mandatory.
+
+\item[\texttt{\bs director\{\dots\}}] Only for Specialization. Mandatory.
+
\item[\texttt{\bs authoremail\{\dots\}}] Mandatory. Email of the thesis author.
It is automatically hyper-linked if \textsf{hyperref} package is loaded.
@@ -250,6 +258,11 @@ Use the form\\ \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 schoolname\{\dots\}}] Only for TFA. Mandatory. Name of the school.
+\item[\texttt{\bs schooladdress\{\dots\}}] Only for TFA. Mandatory. School's address.
+\item[\texttt{\bs schoolwebsite\{\dots\}}] Only for TFA. Optional. School's website.
+\item[\texttt{\bs schoolprincipal\{\dots\}}] Only for TFA. Mandatory. School's principal.
+
\item[\texttt{\bs versiondate\{\dots\}}] Optional. Date version of the thesis.
\item[\texttt{\bs website\{\dots\}}] Optional. Thesis website. Automatically
@@ -283,7 +296,7 @@ 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.
+\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} 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}.
@@ -347,7 +360,7 @@ italian students.
\medskip
\bibitem{Pantieri_Arte}
\href{http://www.lorenzopantieri.net/LaTeX_files/ArteLaTeX.pdf}{\textsc{L.
-Pantieri \& T. Gordini}, \textit{L'arte di scrivere con \LaTeX}, (2011)}
+Pantieri \& T. Gordini}, \textit{L'arte di scrivere con \LaTeX}, (2012)}
\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}, (2009)}
@@ -364,6 +377,10 @@ Pantieri \& T. Gordini}, \textit{L'arte di scrivere con \LaTeX}, (2011)}
\label{sec:PhDexample}
\begin{lstlisting}
+% !TEX encoding = UTF-8
+% !TEX program = pdflatex
+% !TEX spellcheck = en_US
+
\documentclass[binding=0.6cm,PhD]{sapthesis}
\usepackage{microtype}
@@ -414,6 +431,10 @@ This thesis deals with myself.
\label{sec:LaMexample}
\begin{lstlisting}
+% !TEX encoding = UTF-8
+% !TEX program = pdflatex
+% !TEX spellcheck = it_IT
+
\documentclass[binding=0.6cm,Lau]{sapthesis} % LaM for a Laurea Magistrale
\usepackage{microtype}
@@ -427,7 +448,7 @@ This thesis deals with myself.
\IDnumber{123456}
\course{Fisica}
\courseorganizer{Facolt|\`a| di Scienze Matematiche, Fisiche e Naturali}
-\submitdate{2011/2012}
+\AcademicYear{2011/2012}
\copyyear{2012}
\advisor{Prof. Caio}
\advisor{Dr. Sempronio}
@@ -459,6 +480,63 @@ Questa tesi parla di me.
\end{document}
\end{lstlisting}
+
+\clearpage
+\section{TFA thesis example}
+\label{sec:TFAexample}
+
+\begin{lstlisting}
+% !TEX encoding = UTF-8
+% !TEX program = pdflatex
+% !TEX spellcheck = it_IT
+
+\documentclass[binding=0.6cm,TFA]{sapthesis}
+
+\usepackage{microtype}
+\usepackage[italian]{babel}
+\usepackage[utf8]{inputenx}
+\usepackage{hyperref}
+\hypersetup{pdftitle={La mia tesi},pdfauthor={Francesco Biccari}}
+
+\title{La mia tesi}
+\author{Francesco Biccari}
+\IDnumber{123456}
+\course{A049 Matematica e Fisica}
+\courseorganizer{Facolt|\`a| di Scienze Matematiche, Fisiche e Naturali}
+\AcademicYear{2012/2013}
+\copyyear{2013}
+\advisor{Prof. Caio}
+\tutor{Dr. Sempronio}
+\tutorcoord{Dr. Sempronio}
+\authoremail{pippo@pippo.com}
+
+\schoolname{Liceo Scientifico Louis Pasteur}
+\schooladdress{Via G. Barellai 130, 00135 Roma}
+\schoolwebsite{http://www.liceopasteur.it/}
+\schoolprincipal{Prof. Diego Armando Maradona}
+
+\begin{document}
+
+\frontmatter
+\maketitle
+\dedication{Dedicato a\\ Donald Knuth}
+
+\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}
@@ -507,31 +585,36 @@ For heavy usage of measurement units and to insert numbers in the form
\section{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 macro language: you write a source code decorated with \TeX\ commands, which is then compiled to obtain the final product, a document in pdf format in our case. \LaTeX\ is just a set of macros written in \TeX\ to simplify the writing of the source code: you can think about it 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.
+\TeX, the document preparation system designed by Donald Knuth in 1978, is a program to typeset documents.
+It is a mark-up macro language: you write a source text decorated with \TeX\ commands, which is then compiled to obtain the final product, a document in pdf format in our case.
+\LaTeX\ is just a set of macros written in \TeX\ to simplify the writing of the source text: you can think about it 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}, (2012)}
+Pantieri \& T. Gordini}, \textit{L'arte di scrivere con} \LaTeX, (2012)}
-\item \href{http://www.ctan.org/tex-archive/info/symbols/comprehensive/symbols-a4.pdf}{\textsc{S. Pakin}, \textit{The comprehensive \LaTeX\ symbol list}, (2009)}
+\item \href{http://www.ctan.org/tex-archive/info/symbols/comprehensive/symbols-a4.pdf}{\textsc{S. Pakin}, \textit{The comprehensive} \LaTeX\ \textit{symbol list}, (2009)}
-\item \href{http://profs.sci.univr.it/~gregorio/breveguida.pdf}{\textsc{E. Gregorio}, \textit{\LaTeX: breve guida ai pacchetti di uso pi\`u comune}, (2010)}
+\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 will discuss about the editor, that is the program used to write your source code. Since a source code 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:
+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 this page: {\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/egtex.html}}.
-\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. Not for beginners.
+\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! (For example do not use TeXnicCenter!)
+\item \textbf{Avoid} other editors unless you know what you are doing!
\end{itemize}
-Now we will explain how to compile the example document provided in the \textsf{sapthesis} package. Double click on the file \texttt{sapthesis-example.tex}. TeXworks should start showing the source code. 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} mechanism).
+Finally we explain how to compile the example document provided in the \textsf{sapthesis} package. Double click on the file \texttt{sapthesis-example.tex}.
+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).
@@ -545,16 +628,16 @@ Using \textsf{sapthesis} with LyX is quite straightforward.
Install \textsf{sapthesis} by the package manager of your \TeX\ distribution or manually.
\item
-First of all go in \textsf{Tools > Preferences > Language Settings > Language} and choose "none" in Language package. This step is necessary because LyX not only loads babel with the desired language, but it passes the language also as an option for the class! This triggers an error in many classes.
+In LyX, first of all, go in \textsf{Tools > Preferences > Language Settings > Language} and choose "none" in Language package. This step is necessary because LyX not only loads babel with the desired language, but it passes the language also as an option for the class! This triggers an error in many classes.
\item
-Go in \textsf{View > View Source}. This step is not necessary but it is very useful to observe the \LaTeX\ code produced by LyX (on the right choose ``Complete source'').
+In LyX, go in \textsf{View > View Source}. This step is not necessary but it is very useful to observe the \LaTeX\ code produced by LyX (on the right choose ``Complete source'').
\item
-Copy the file \texttt{sapthesis.layout} in the directory\\ \texttt{C:\bs Program Files\bs Lyx20\bs Resources\bs layouts\bs}\\ and then click on \textsf{Tools > Reconfigure}.
+Copy the file \texttt{sapthesis.layout} in the directory\\ \texttt{C:\bs Program Files\bs Lyx20\bs Resources\bs layouts\bs}\\ and then, in LyX, click on \textsf{Tools > Reconfigure}.
\end{itemize}
-Now you are ready to use \textsf{sapthesis}.
+Now you are ready to use \textsf{sapthesis} in LyX.
Create a new document and go in \textsf{Document > Settings > Document Class}. Here you can choose \textsf{sapthesis} as the class for the document and write the class options. Then you have to write the preamble of the document in \textsf{Document > Settings > LaTeX Preamble}.