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.tex66
1 files changed, 59 insertions, 7 deletions
diff --git a/Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex b/Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex
index c76b1de0123..c6164d6830d 100644
--- a/Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex
+++ b/Master/texmf-dist/doc/latex/sapthesis/sapthesis-doc.tex
@@ -6,12 +6,7 @@
\usepackage[scale=0.85, footskip=0.8cm,heightrounded]{geometry}
\usepackage[T1]{fontenc}
-%txfonts 137 kB
\usepackage{txfonts}
-%mathptmx 169 kB [warn] in textcomp
-%times 203 kB [warn] in textcomp
-%tgtermes 251 kB
-%lmodern 433 kB
\usepackage[warn]{textcomp}
\usepackage{microtype}
\usepackage{graphicx}
@@ -55,7 +50,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.1.1, 2012-03-02
+ \small \vspace{0.2cm} Version 3.2, 2012-08-15
}
\date{}
@@ -212,6 +207,7 @@ 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}] 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): ``candidata'' instead of ``candidato''.
\end{description}
\subsection[Commands for the\\ title page]{Commands for the title page}
@@ -236,7 +232,7 @@ 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 copyyear\{\dots\}}] Mandatory. Copyright year (usually the
-year of your graduation).
+graduation year).
\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:\\
@@ -508,5 +504,61 @@ For heavy usage of measurement units and to insert numbers in the form
\end{description}
+
+\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.
+
+\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)}
+
+\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://profs.sci.univr.it/~gregorio/breveguida.pdf}{\textsc{E. Gregorio}, \textit{\LaTeX: 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:
+\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://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 \textbf{Avoid} other editors unless you know what you are doing! (For example do not use TeXnicCenter!)
+
+\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).
+
+
+
+\section{Using LyX}
+
+LyX is an advanced \LaTeX\ editor which does not simply show the source code like any text editor, but instead it renders maths, images, tables and some text formatting commands. However this ``layer'' between the writer and the real source code is sometimes frustrating and many authors discourage the usage of LyX.
+
+Using \textsf{sapthesis} with LyX is quite straightforward.
+\begin{itemize}
+\item
+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.
+
+\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'').
+
+\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}.
+\end{itemize}
+
+Now you are ready to use \textsf{sapthesis}.
+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}.
+
+
+
+
\addtocontents{toc}{\protect\end{multicols}}
\end{document}