diff options
author | Karl Berry <karl@freefriends.org> | 2007-04-13 00:07:17 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2007-04-13 00:07:17 +0000 |
commit | 9f9c13f3e8d249b1d4c7b782cee4eee8ef847a9a (patch) | |
tree | a6ddb5de114b603b85708f8f41164b7bac0961a0 /Master/texmf-dist/doc/latex | |
parent | a5e58f206441c527c0aaa500f7f17d788fbd97b2 (diff) |
new latex package bookest (12apr07)
git-svn-id: svn://tug.org/texlive/trunk@4158 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex')
-rw-r--r-- | Master/texmf-dist/doc/latex/bookest/README | 55 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/bookest/bookestdoc-en.pdf | bin | 0 -> 123459 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/bookest/bookestdoc-en.tex | 180 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/bookest/bookestdoc-it.pdf | bin | 0 -> 123418 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/bookest/bookestdoc-it.tex | 178 |
5 files changed, 413 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/bookest/README b/Master/texmf-dist/doc/latex/bookest/README new file mode 100644 index 00000000000..b333b2f9349 --- /dev/null +++ b/Master/texmf-dist/doc/latex/bookest/README @@ -0,0 +1,55 @@ +La classe bookest e' un'estensione della classe standard book, classe alla +quale si appoggia e che viene caricata con le opzioni di default. + +Le estensioni fornite dalla classe riguardano: +1. colori; +2. layout del documento; +3. testatine e pie' di pagina; +4. layout della copertina; +5. ... + + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +The bookest class in an extension of the standard book class, which it relies +on and that is loaded with the default options. + +The extensions provided by the class involve: +1. colors; +2. document layout; +3. headings and footers; +4. title page layout; +5. ... + + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + + +Version 1.0 - 2007/04/12 +# First public release + + + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + %% %% + %% Package name: bookest %% + %% Author: Riccardo Bresciani - bresciani(at)sssup.it %% + %% %% + %% Description: This package provides an extension to the %% + %% book class %% + %% %% + %% Copyright 2007 Riccardo Bresciani %% + %% %% + %% This work may be distributed and/or modified under the %% + %% conditions of the LaTeX Project Public License, either %% + %% version 1.3c of this license or (at your option) any %% + %% later version. %% + %% The latest version of the license is in %% + %% http://www.latex-project.org/lppl.txt %% + %% and version 1.3c or later is part of all distributions of LaTeX %% + %% version 2005/12/01 or later. %% + %% %% + %% This work has the LPPL maintenance status "author-maintained". %% + %% %% + %% This work consists of the files: README, bookest.cls, %% + %% bookestdoc-it.tex, bookestdoc-it.pdf, bookestdoc-en.tex, %% + %% bookestdoc-en.pdf %% + %% %% + %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% diff --git a/Master/texmf-dist/doc/latex/bookest/bookestdoc-en.pdf b/Master/texmf-dist/doc/latex/bookest/bookestdoc-en.pdf Binary files differnew file mode 100644 index 00000000000..84f53f30120 --- /dev/null +++ b/Master/texmf-dist/doc/latex/bookest/bookestdoc-en.pdf diff --git a/Master/texmf-dist/doc/latex/bookest/bookestdoc-en.tex b/Master/texmf-dist/doc/latex/bookest/bookestdoc-en.tex new file mode 100644 index 00000000000..fe7a1df0803 --- /dev/null +++ b/Master/texmf-dist/doc/latex/bookest/bookestdoc-en.tex @@ -0,0 +1,180 @@ +\documentclass[a4paper,oneside,centered,noparindent,noparskip]{bookest} + +\usepackage[utf8x]{inputenc} +%\usepackage[italian]{babel} +\usepackage{palatino} +\usepackage{guit} + +\hyphenation{Su-pe-rio-re} + +\hypersetup{ +pdftitle={The bookest class}, +pdfsubject={An extension for the book class}, +pdfauthor={Riccardo Bresciani}, +pdfkeywords={TeX, LaTeX, pdfLaTeX, book, bookest}, +pdfstartview=FitV, +%colorlinks +} + +\setoddheadtext{{\colorA The \texttt{bookest} class --- Version 1.0\hfill Riccardo Bresciani}} +\setoddfoot{\hfill{\colorA\thepage}\hfill} + +\makeatletter +\renewcommand \thesection{\@arabic\c@section.} +\renewcommand\thesubsection{\thesection\@arabic\c@subsection} +\makeatother + +\newcommand{\tA}[1]{\texttt{\colorA #1}} + +\begin{document} + \chapter*{The \texttt{bookest} class\\{\Large Version 1.0 --- \today}\\{\Large Riccardo Bresciani}} +The \texttt{bookest} class in an extension of the standard \texttt{book} class, which it relies on and that is loaded with the default options. + +\ppar +The extensions provided by the class involve: +\begin{enumerate} + \item colors; + \item document layout; + \item headings and footers; + \item title page layout; + \item \dots +\end{enumerate} + +\section{Colors} +\texttt{bookest} requires the \texttt{color} and the \texttt{pdfcolmk}\footnote{This package, reported by Massimiliano Dominici (\GuIT), allows to bypass some of the limitations that pdf\TeX\ has up to version 1.30, mainly the unsupported \emph{colorstack}. Currently the package is loaded by default, but as soon as the main ditributions (MiK\TeX, te\TeX, \dots) will have pdf\TeX\ versione 1.40 this package will be removed from the class.} packages to provide color support to the document. + +\ppar +Specifically, colors \texttt{A} and \texttt{B} are defined: they will be used in the definition of the sectioning commands and in coloring of some text elements --- e.g. the \texttt{footnote} rules or the list labels in \texttt{itemize}, \texttt{enumerate} e \texttt{description}. + +\ppar +The default document is black and white, the user can anyway define the colors accordingly to his taste by using the commands listed in \ref{coloricomandi}. + +\ppar +\texttt{bookest} provides some preset color combinations, that can be activated with the corresponding class options listed in \ref{coloriopzioni}. Using these options requires the \texttt{hyperref} package, as link and anchor colors (color \texttt{A}) and citation color (color \texttt{B}) are set. + +\subsection{Commands}\label{coloricomandi} +\begin{description} + \item[\texttt{\textbackslash colorA}, \texttt{\textbackslash colorB}, \texttt{\textbackslash black}] declare the colors used by the class (\texttt{A} and \texttt{B} empty by default and user-definable, plus black); + \item[\texttt{\textbackslash setcolorA\{\textit{<R> <G> <B>}\}}, \texttt{\textbackslash setcolorB\{\textit{<R> <G> <B>}\}}] specify color \texttt{A} and \texttt{B} in RGB format; + \item[\texttt{\textbackslash SETcolorA\{\textit{<command>}\}}, \texttt{\textbackslash SETcolorB\{\textit{<command>}\}}] redefine the commands \texttt{\textbackslash colorA} and \texttt{\textbackslash colorB} in \texttt{\textit{<command>}}; +\end{description} + +\subsection{Options}\label{coloriopzioni} +\begin{description} + \item[\texttt{noitemcolor}] cancels the list coloration in \texttt{itemize}, \texttt{enumerate} and \texttt{description}; +\end{description} +\ppar +\begin{description} + \item[\texttt{blue}, \texttt{green}, \texttt{red}] are generic color themes; + \item[\texttt{guitgreen}] is a color theme using the colors of the Gruppo Utilizzatori Italiani di \TeX\ (\GuIT). + \item[\texttt{sssupcolor1}, \texttt{sssupcolor2}, \texttt{sssupcolor3}] are color themes using the colors of the Scuola Superiore Sant'Anna logo; + \item[\texttt{enscblue}] is a color theme using the colors of the École Normale Supérieure de Cachan logo. +\end{description} + +\section{Document layout} +\texttt{bookest} provides options to control: +\begin{itemize} + \item doubleside (inherets that ones of \texttt{book}); + \item margins; + \item line spacing; + \item paragraph indentation and spacing. +\end{itemize} + +\subsection{Options} +\begin{description} + \item[\texttt{oneside}, \texttt{twoside}] toggles duplex options (default: \texttt{twoside}); +\end{description} +\ppar +\begin{description} + \item[\texttt{centered}] sets page margins (2.5 cm horizontal, 3 cm above and below) --- requires the \texttt{geometry} package; + \item[\texttt{left5mm}] sets page margins allowing 5 mm for binding (3 cm left, 2 cm right and 3 cm above and below) requires the \texttt{geometry} package; + \item[\texttt{left8mm}] sets page margins allowing 8 mm for binding (3.3 cm left, 1.7 cm right and 3 cm above and below) --- requires the \texttt{geometry} package; +\end{description} +\ppar +\begin{description} + \item[\texttt{onehalfspacing}] line spacing to 1.5 --- requires the \texttt{setspace} package; + \item[\texttt{doublespacing}] line spacing to 2 --- requires the \texttt{setspace} package; +\end{description} +\ppar +\begin{description} + \item[\texttt{noparindent}] sets paragraph indentation to 0; + \item[\texttt{noparskip}] sets paragraph spacing to 0. +\end{description} + +\section{Headings and footers} +\texttt{bookest} provides commands to allow the user to set easily headings and footers. Moreover it provides a default setting that is different from \texttt{book}\footnote{To use the default \texttt{book} styles one has to simply use the command \texttt{\textbackslash pagestyle\{\textit{<style>}\}}.}. + +\ppar +It also redefines chapter headings and the \texttt{plain} style to include colors. + +\subsection{Commands} +\begin{description} + \item[\texttt{\textbackslash setoddhead}, \texttt{\textbackslash setevenhead}] define odd and even page headings; + \item[\texttt{\textbackslash oddheadtext}] is the text to be used in odd page headings (default: \texttt{\{\textbackslash colorA\{ \textbackslash slshape\textbackslash rightmark\}\textbackslash hfill\textbackslash thepage\}}); + \item[\texttt{\textbackslash evenheadtext}] is the text to be used in even page headings (default in the \texttt{oneside} case: \texttt{\textbackslash oddheadtext}; in the \texttt{twoside} case: \texttt{\{\textbackslash colorA\textbackslash thepage\textbackslash hfill\textbackslash slshape\textbackslash leftmark\}}); + \item[\texttt{\textbackslash setoddheadtext}, \texttt{\textbackslash setevenheadtext}] set the text in \texttt{\textbackslash oddheadtext} e \texttt{\textbackslash evenheadtext}; + \item[\texttt{\textbackslash setoddfoot}, \texttt{\textbackslash setevenfoot}] define odd and even page footers; + \item[\texttt{\textbackslash oddfoottext}, \texttt{\textbackslash evenfoottext}] is the text to be used in odd and even page headings (default: (default: empty); + \item[\texttt{\textbackslash setoddfoottext}, \texttt{\textbackslash setevenfoottext}] set the text in \texttt{\textbackslash oddfoottext} e \texttt{\textbackslash evenfoottext}; + \item[\texttt{\textbackslash setleftmark}, \texttt{\textbackslash setrightmark}] sets the text in \texttt{\textbackslash leftmark} e \texttt{\textbackslash rightmark}; + \item[\texttt{\textbackslash makeheadrule}] defines the horizontal rule in headings (default: \texttt{\{\textbackslash colorB\textbackslash hrule \textbackslash @width \textbackslash textwidth \textbackslash @height 0.4pt \textbackslash vskip-0.4pt\}}); + \item[\texttt{\textbackslash makefootrule}] defines the horizontal rule in headings (default: \texttt{\textbackslash makeheadrule}); +\end{description} + +\section{Title page layout} +\texttt{bookest} provides commands to allow the user to customize easily the title page of his document, especially starting from preset layouts that can be activated by the options in \ref{copertinaopzioni}. + +\ppar +The default layout has author and title centered at top of the page and to the bottom of the page is a footer made by the content of \texttt{\textbackslash titlingpageprefooter} and of \texttt{\textbackslash titlingpagefooter} divided by a horizontal line. Between title and footer is the content of \texttt{\textbackslash titlingpagemiddle}. + +The different options allow to vary the logo position; for each option \texttt{\textit{<optlogo>}} in \ref{copertinaopzioni} exists a variant \texttt{\textit{<optlogo>}-nofooter} where no footer is present. + +\subsection{Commands} +\begin{description} + \item[\texttt{\textbackslash inslogo\{\textit{<file>}\}}] inserts the image \texttt{\textit{<file>}} with \texttt{\textbackslash includegraphics} options previously defined and used for the logo (default: \texttt{width=0.6\textbackslash paperwidth}); + \item[\texttt{\textbackslash setlogooptions\{\textit{<options>}\}}] defines \texttt{\textit{<options>}} as the \texttt{\textbackslash includegraphics} options to be used by \texttt{\textbackslash inslogo}; + \item[\texttt{\textbackslash logo}, \texttt{\textbackslash leftlogo}, \texttt{\textbackslash rightlogo}] are the path (relative or absolute) of the image to be used as logo depending on the chosen options (default for all three is the relative path \texttt{logo}); + \item[\texttt{\textbackslash setlogo\{\textit{<path>}\}}, \texttt{\textbackslash setleftlogo\{\textit{<path>}\}}, \texttt{\textbackslash setrightlogo\{\textit{<path>}\}}] set to \texttt{\textit{<path>}} the content of \texttt{\textbackslash logo}, \texttt{\textbackslash leftlogo}, \texttt{\textbackslash rightlogo}; + \item[\texttt{\textbackslash titlingpagemiddle}] is the text to be put in the middle of the \emph{titling page}; + \item[\texttt{\textbackslash settitlingpagemiddle}] sets the text in \texttt{\textbackslash titlingpagemiddle}; + \item[\texttt{\textbackslash titlingpageprefooter}] is the text to be put before the footer in the \emph{titling page}; + \item[\texttt{\textbackslash settitlingpageprefooter}] sets the text in \texttt{\textbackslash titlingpageprefooter}; + \item[\texttt{\textbackslash titlingpagefooter}] is the text to be used as footer in the \emph{titling page} (default: \texttt{\textbackslash today}); + \item[\texttt{\textbackslash settitlingpagefooter}] sets the text in \texttt{\textbackslash titlingpagefooter}; + \item[\texttt{\textbackslash settitlingpagetitle}] defines the format of the title in the \emph{titling page}; + \item[\texttt{\textbackslash titling}] inserts the \emph{titling page}. +\end{description} + +\subsection{Options}\label{copertinaopzioni} +\begin{description} + \item[\texttt{nofooter}] variant without footer of the default layout; + \item[\texttt{logo}, \texttt{logo-nofooter}] adds to the default layout the logo in \texttt{\textbackslash logo} under the title (and matching \texttt{nofooter} variant) --- requires the \texttt{graphicx} package; + \item[\texttt{logo-bg}, \texttt{logo-bg-nofooter}] adds to the default layout the logo in \texttt{\textbackslash logo} in the background (and matching \texttt{nofooter} variant) --- requires the \texttt{graphicx} package; + \item[\texttt{logo-topl}, \texttt{logo-topl-nofooter}] adds to the default layout the logo in \texttt{\textbackslash leftlogo} at top left of the page before the title (and matching \texttt{nofooter} variant) --- requires the \texttt{graphicx} package; + \item[\texttt{logo-topc}, \texttt{logo-topc-nofooter}] adds to the default layout the logo in \texttt{\textbackslash logo} at top center of the page before the title (and matching \texttt{nofooter} variant) --- requires the \texttt{graphicx} package; + \item[\texttt{logo-topr}, \texttt{logo-topr-nofooter}] adds to the default layout the logo in \texttt{\textbackslash rightlogo} at top left of the page before the title (and matching \texttt{nofooter} variant) --- requires the \texttt{graphicx} package; + \item[\texttt{logo-toplr}, \texttt{logo-toplr-nofooter}] adds to the default layout the logo in \texttt{\textbackslash leftlogo} at top left of the page and \texttt{\textbackslash rightlogo} at top right of the page before the title (and matching \texttt{nofooter} variant) --- requires the \texttt{graphicx} package; +\end{description} + +\section{Miscellanea} +\texttt{bookest} provides also other little shortcuts, which can be useful when using the class and that are hereby listed: + +\subsection{Commands} +\begin{description} + \item[\texttt{\textbackslash setbibname\{\textit{<name>}\}}] renames the bibliography title to \texttt{\textit{<name>}}; + \item[\texttt{\textbackslash setcontentsname\{\textit{<name>}\}}] renames the contents title to \texttt{\textit{<name>}}; + \item[\texttt{\textbackslash ppar}] inserts a vertical space of \texttt{1.5ex} --- useful for example with the \texttt{noparskip} option; + \item[\texttt{\textbackslash dimstleftskip}] sets \texttt{\textbackslash leftskip} to \texttt{1cm}; + \item[\texttt{\textbackslash UCase}] provides the command \texttt{\textbackslash MakeUppercase}, that is instead redefined as a null command to make heading and footer commands more flexible; + \item[\texttt{\textbackslash epigraph\{\textit{<text1>}\}\{\textit{<text2>}\}\{\textit{<environment>}\}\{\textit{<l>}\}}] makes an epigraph, where \texttt{\textit{<text1>}} is divided from \texttt{\textit{<text2>}} by a horizontal line of color \texttt{B}. The epigraph has length \texttt{\textit{<l>}} and is contained in the environment \texttt{\textit{<environment>}}. +\end{description} + +\subsection{Environments} +\begin{description} + \item[\texttt{dimst}] is an environment where the text is in \texttt{slshape} and with 1 cm extra for the left margin. +\end{description} + +\section{Contacts} +For comments, suggestions or bug reports, you can reach me at the address \href{mailto:bresciani@sssup.it}{\textit{bresciani@sssup.it}}. + +\end{document} diff --git a/Master/texmf-dist/doc/latex/bookest/bookestdoc-it.pdf b/Master/texmf-dist/doc/latex/bookest/bookestdoc-it.pdf Binary files differnew file mode 100644 index 00000000000..7827eddba36 --- /dev/null +++ b/Master/texmf-dist/doc/latex/bookest/bookestdoc-it.pdf diff --git a/Master/texmf-dist/doc/latex/bookest/bookestdoc-it.tex b/Master/texmf-dist/doc/latex/bookest/bookestdoc-it.tex new file mode 100644 index 00000000000..5a9fbe3a33c --- /dev/null +++ b/Master/texmf-dist/doc/latex/bookest/bookestdoc-it.tex @@ -0,0 +1,178 @@ +\documentclass[a4paper,oneside,centered,noparindent,noparskip]{bookest} + +\usepackage[utf8x]{inputenc} +\usepackage[italian]{babel} +\usepackage{palatino} +\usepackage{guit} + +\hypersetup{ +pdftitle={The bookest class}, +pdfsubject={Un'estensione per la classe book}, +pdfauthor={Riccardo Bresciani}, +pdfkeywords={TeX, LaTeX, pdfLaTeX, book, bookest}, +pdfstartview=FitV, +%colorlinks +} + +\setoddheadtext{{\colorA The \texttt{bookest} class --- Versione 1.0\hfill Riccardo Bresciani}} +\setoddfoot{\hfill{\colorA\thepage}\hfill} + +\makeatletter +\renewcommand \thesection{\@arabic\c@section.} +\renewcommand\thesubsection{\thesection\@arabic\c@subsection} +\makeatother + +\newcommand{\tA}[1]{\texttt{\colorA #1}} + +\begin{document} + \chapter*{The \texttt{bookest} class\\{\Large Versione 1.0 --- \today}\\{\Large Riccardo Bresciani}} +La classe \texttt{bookest} è un'estensione della classe standard \texttt{book}, classe alla quale si appoggia e che viene caricata con le opzioni di default. + +\ppar +Le estensioni fornite dalla classe riguardano: +\begin{enumerate} + \item colori; + \item layout del documento; + \item testatine e pie' di pagina; + \item layout della copertina; + \item \dots +\end{enumerate} + +\section{Colori} +\texttt{bookest} richiede i pacchetti \texttt{color} e \texttt{pdfcolmk}\footnote{Questo pacchetto, segnalato da Massimiliano Dominici (\GuIT), permette di ovviare ad alcune limitazioni che pdf\TeX\ ha fino alla versione 1.30, in particolare al fatto che non sia supportato il \emph{colorstack}. Attualmente il pacchetto viene caricato di default, ma non appena le principali distribuzioni (MiK\TeX, te\TeX, \dots) avranno pdf\TeX\ versione 1.40 questo pacchetto verrà eliminato dalla classe.} per fornire il supporto del colore al documento. + +\ppar +Vengono definiti in particolare i colori \texttt{A} e \texttt{B}, che vengono utilizzati nella definizione dei comandi di sezionamento e nella colorazione di alcuni elementi del testo --- per esempio i righelli di \texttt{footnote} o le \emph{label} degli elenchi \texttt{itemize}, \texttt{enumerate} e \texttt{description}. + +\ppar +Di default il documento è in bianco e nero, l'utente può però definire i colori a proprio piacimento utilizzando i comandi elencati di seguito in \ref{coloricomandi}. + +\ppar +\texttt{bookest} fornisce delle combinazioni predefinite di colori, attivabili con le relative opzioni della classe elencate in \ref{coloriopzioni}. L'utilizzo di queste opzioni richiede il pacchetto \texttt{hyperref} dal momento che vengono settati i colori per i link ed i riferimenti (colore \texttt{A}) e per le citazioni (colore \texttt{B}). + +\subsection{Comandi}\label{coloricomandi} +\begin{description} + \item[\texttt{\textbackslash colorA}, \texttt{\textbackslash colorB}, \texttt{\textbackslash black}] dichiarano i colori utilizzati dalla classe (\texttt{A} e \texttt{B} vuoti di default e definibili dall'utente, più il nero); + \item[\texttt{\textbackslash setcolorA\{\textit{<R> <G> <B>}\}}, \texttt{\textbackslash setcolorB\{\textit{<R> <G> <B>}\}}] specificano i colori \texttt{A} e \texttt{B} in formato RGB; + \item[\texttt{\textbackslash SETcolorA\{\textit{<comando>}\}}, \texttt{\textbackslash SETcolorB\{\textit{<comando>}\}}] ridefiniscono i comandi \texttt{\textbackslash colorA} e \texttt{\textbackslash colorB} in \texttt{\textit{<comando>}}; +\end{description} + +\subsection{Opzioni}\label{coloriopzioni} +\begin{description} + \item[\texttt{noitemcolor}] annulla la colorazione degli elenchi \texttt{itemize}, \texttt{enumerate} e \texttt{description}; +\end{description} +\ppar +\begin{description} + \item[\texttt{blue}, \texttt{green}, \texttt{red}] sono temi di colore generici; + \item[\texttt{guitgreen}] è un tema di colore che riprende i colori del Gruppo Utilizzatori Italiani di \TeX\ (\GuIT). + \item[\texttt{sssupcolor1}, \texttt{sssupcolor2}, \texttt{sssupcolor3}] sono temi di colore che riprendono i colori del logo della Scuola Superiore Sant'Anna; + \item[\texttt{enscblue}] è un tema di colore che riprende il colore del logo dell'École Normale Supérieure di Cachan. +\end{description} + +\section{Layout del documento} +\texttt{bookest} fornisce opzioni per controllare: +\begin{itemize} + \item il fronte-retro (eredita quelle di \texttt{book}); + \item i margini; + \item l'interlinea; + \item l'indentazione nei paragrafi e la loro spaziatura reciproca. +\end{itemize} + +\subsection{Opzioni} +\begin{description} + \item[\texttt{oneside}, \texttt{twoside}] abilita o disabilita il fronte-retro (default: \texttt{twoside}); +\end{description} +\ppar +\begin{description} + \item[\texttt{centered}] imposta i margini della pagina (2.5 cm ai lati, 3 cm sopra e sotto) --- richiede il pacchetto \texttt{geometry}; + \item[\texttt{left5mm}] imposta i margini della pagina considerando 5 mm per la rilegatura (3 cm a sinistra, 2 cm a destra e 3 cm sopra e sotto) --- richiede il pacchetto \texttt{geometry}; + \item[\texttt{left8mm}] imposta i margini della pagina considerando 8 mm per la rilegatura (3.3 cm a sinistra, 1.7 cm a destra e 3 cm sopra e sotto) --- richiede il pacchetto \texttt{geometry}; +\end{description} +\ppar +\begin{description} + \item[\texttt{onehalfspacing}] imposta l'interlinea a 1.5 --- richiede il pacchetto \texttt{setspace}; + \item[\texttt{doublespacing}] imposta l'interlinea a 2 --- richiede il pacchetto \texttt{setspace}; +\end{description} +\ppar +\begin{description} + \item[\texttt{noparindent}] annulla l'indentazione dei paragrafi; + \item[\texttt{noparskip}] annulla lo spazio verticale tra i paragrafi. +\end{description} + +\section{Testatine e pie' di pagina} +\texttt{bookest} fornisce dei comandi per permettere all'utente di impostare agevolmente testatine e pie' di pagina, nonché un'impostazione predefinita diversa da quella di \texttt{book}\footnote{Per utilizzare gli stili predefiniti di \texttt{book} è sufficiente utilizzare il comando \texttt{\textbackslash pagestyle\{\textit{<stile>}\}}.}. + +\ppar +Ridefinisce inoltre l'intestazione dei capitoli e lo stile \texttt{plain} per integrarvi i colori. + +\subsection{Comandi} +\begin{description} + \item[\texttt{\textbackslash setoddhead}, \texttt{\textbackslash setevenhead}] definiscono le testatine delle pagine dispari e pari; + \item[\texttt{\textbackslash oddheadtext}] è il testo che verrà utilizzato nelle testatine delle pagine dispari (default: \texttt{\{\textbackslash colorA\{ \textbackslash slshape\textbackslash rightmark\}\textbackslash hfill\textbackslash thepage\}}); + \item[\texttt{\textbackslash evenheadtext}] è il testo che verrà utilizzato nelle testatine delle pagine pari (default nel caso \texttt{oneside}: \texttt{\textbackslash oddheadtext}; nel caso \texttt{twoside}: \texttt{\{\textbackslash colorA\textbackslash thepage\textbackslash hfill\textbackslash slshape\textbackslash leftmark\}}); + \item[\texttt{\textbackslash setoddheadtext}, \texttt{\textbackslash setevenheadtext}] settano il testo in \texttt{\textbackslash oddheadtext} e \texttt{\textbackslash evenheadtext}; + \item[\texttt{\textbackslash setoddfoot}, \texttt{\textbackslash setevenfoot}] definiscono i pie' di pagina delle pagine dispari e pari; + \item[\texttt{\textbackslash oddfoottext}, \texttt{\textbackslash evenfoottext}] sono i testi che verranno utilizzati nei pie' di pagina dispari e pari (default: vuoto); + \item[\texttt{\textbackslash setoddfoottext}, \texttt{\textbackslash setevenfoottext}] settano il testo in \texttt{\textbackslash oddfoottext} e \texttt{\textbackslash evenfoottext}; + \item[\texttt{\textbackslash setleftmark}, \texttt{\textbackslash setrightmark}] settano il testo in \texttt{\textbackslash leftmark} e \texttt{\textbackslash rightmark}; + \item[\texttt{\textbackslash makeheadrule}] definisce la linea orizzontale utilizzata nelle testatine (default: \texttt{\{\textbackslash colorB\textbackslash hrule \textbackslash @width \textbackslash textwidth \textbackslash @height 0.4pt \textbackslash vskip-0.4pt\}}); + \item[\texttt{\textbackslash makefootrule}] definisce la linea orizzontale utilizzata nei pie' di pagina (default: \texttt{\textbackslash makeheadrule}); +\end{description} + +\section{Layout della copertina} +\texttt{bookest} fornisce comandi per permettere all'utente di personalizzare con facilità la copertina del proprio documento, in particolare a partire da layout predefiniti che possono essere attivati con le opzioni in \ref{copertinaopzioni}. + +\ppar +Il layout predefinito ha autore e titolo in alto al centro e a pie' di pagina viene posizionato un \emph{footer} composto dal contenuto di \texttt{\textbackslash titlingpageprefooter} e quello di \texttt{\textbackslash titlingpagefooter} separati da una linea orizzontale. Tra il titolo ed il \emph{footer} viene posizionato il contenuto di \texttt{\textbackslash titlingpagemiddle}. + +Le varie opzioni permettono di variare il posizionamento del logo; per ciascuna opzione \texttt{\textit{<optlogo>}} in \ref{copertinaopzioni} esiste una variante \texttt{\textit{<optlogo>}-nofooter} in cui il \emph{footer} non è presente. + +\subsection{Comandi} +\begin{description} + \item[\texttt{\textbackslash inslogo\{\textit{<file>}\}}] inserisce l'immagine \texttt{\textit{<file>}} con opzioni \texttt{\textbackslash includegraphics} definite in precedenza e usate per il logo (default: \texttt{width=0.6\textbackslash paperwidth}); + \item[\texttt{\textbackslash setlogooptions\{\textit{<opzioni>}\}}] definisce \texttt{\textit{<opzioni>}} come le opzioni di \texttt{\textbackslash includegraphics} che verranno usate da \texttt{\textbackslash inslogo}; + \item[\texttt{\textbackslash logo}, \texttt{\textbackslash leftlogo}, \texttt{\textbackslash rightlogo}] sono il percorso (relativo o assoluto) dell'immagine che verrà utilizzata come logo a seconda delle opzioni scelte (default per tutti e tre è il percorso relativo \texttt{logo}); + \item[\texttt{\textbackslash setlogo\{\textit{<percorso>}\}}, \texttt{\textbackslash setleftlogo\{\textit{<percorso>}\}}, \texttt{\textbackslash setrightlogo\{\textit{<percorso>}\}}] settano a \texttt{\textit{<percorso>}} il contenuto di \texttt{\textbackslash logo}, \texttt{\textbackslash leftlogo}, \texttt{\textbackslash rightlogo}; + \item[\texttt{\textbackslash titlingpagemiddle}] è il testo che verrà posizionato a metà della \emph{titling page}; + \item[\texttt{\textbackslash settitlingpagemiddle}] setta il testo in \texttt{\textbackslash titlingpagemiddle}; + \item[\texttt{\textbackslash titlingpageprefooter}] è il testo che verrà posizionato prima del \emph{footer} nella \emph{titling page}; + \item[\texttt{\textbackslash settitlingpageprefooter}] setta il testo in \texttt{\textbackslash titlingpageprefooter}; + \item[\texttt{\textbackslash titlingpagefooter}] è il testo che verrà utilizzato come \emph{footer} nella \emph{titling page} (default: \texttt{\textbackslash today}); + \item[\texttt{\textbackslash settitlingpagefooter}] setta il testo in \texttt{\textbackslash titlingpagefooter}; + \item[\texttt{\textbackslash settitlingpagetitle}] definisce il formato del titolo all'interno della \emph{titling page}; + \item[\texttt{\textbackslash titling}] inserisce la \emph{titling page}. +\end{description} + +\subsection{Opzioni}\label{copertinaopzioni} +\begin{description} + \item[\texttt{nofooter}] variante senza \emph{footer} del layout predefinito; + \item[\texttt{logo}, \texttt{logo-nofooter}] aggiunge al layout predefinito il logo in \texttt{\textbackslash logo} sotto il titolo (e relativa variante \texttt{nofooter}) --- richiede il pacchetto \texttt{graphicx}; + \item[\texttt{logo-bg}, \texttt{logo-bg-nofooter}] aggiunge al layout predefinito il logo in \texttt{\textbackslash logo} in background (e relativa variante \texttt{nofooter}) --- richiede i pacchetti \texttt{graphicx} ed \texttt{eso-pic}; + \item[\texttt{logo-topl}, \texttt{logo-topl-nofooter}] aggiunge al layout predefinito il logo in \texttt{\textbackslash leftlogo} prima del titolo in alto a sinistra (e relativa variante \texttt{nofooter}) --- richiede il pacchetto \texttt{graphicx}; + \item[\texttt{logo-topc}, \texttt{logo-topc-nofooter}] aggiunge al layout predefinito il logo in \texttt{\textbackslash logo} prima del titolo in alto al centro (e relativa variante \texttt{nofooter}) --- richiede il pacchetto \texttt{graphicx}; + \item[\texttt{logo-topr}, \texttt{logo-topr-nofooter}] aggiunge al layout predefinito il logo in \texttt{\textbackslash rightlogo} prima del titolo in alto a destra (e relativa variante \texttt{nofooter}) --- richiede il pacchetto \texttt{graphicx}; + \item[\texttt{logo-toplr}, \texttt{logo-toplr-nofooter}] aggiunge al layout predefinito il logo in \texttt{\textbackslash leftlogo} in alto a sinistra ed il logo in \texttt{\textbackslash rightlogo} in alto a destra prima del titolo (e relativa variante \texttt{nofooter}) --- richiede il pacchetto \texttt{graphicx}. +\end{description} + +\section{Miscellanea} +\texttt{bookest} fornisce anche altre piccole scorciatoie, che possono essere utili nell'utilizzo della classe e che vengono elencate qui di seguito: + +\subsection{Comandi} +\begin{description} + \item[\texttt{\textbackslash setbibname\{\textit{<nome>}\}}] rinomina il titolo della bibliografia in \texttt{\textit{<nome>}}; + \item[\texttt{\textbackslash setcontentsname\{\textit{<nome>}\}}] rinomina il titolo dell'indice in \texttt{\textit{<nome>}}; + \item[\texttt{\textbackslash ppar}] inserisce uno spazio verticale di \texttt{1.5ex} --- utile per esempio con l'opzione \texttt{noparskip}; + \item[\texttt{\textbackslash dimstleftskip}] setta \texttt{\textbackslash leftskip} a \texttt{1cm}; + \item[\texttt{\textbackslash UCase}] fornisce il comando \texttt{\textbackslash MakeUppercase}, che viene invece ridefinito come comando vuoto per dare maggiore flessibilità ai comandi per testatine e pie' di pagina; + \item[\texttt{\textbackslash epigraph\{\textit{<testo1>}\}\{\textit{<testo2>}\}\{\textit{<ambiente>}\}\{\textit{<l>}\}}] crea un epigrafe, in cui \texttt{\textit{<testo1>}} viene separato da \texttt{\textit{<testo2>}} da una linea orizzontale di colore \texttt{B}. Il tutto ha larghezza \texttt{\textit{<l>}} ed è contenuto nell'ambiente \texttt{\textit{<ambiente>}}. +\end{description} + +\subsection{Ambienti} +\begin{description} + \item[\texttt{dimst}] è un ambiente in cui il testo è in \texttt{slshape} e con il margine sinistro maggiorato di 1 cm. +\end{description} + +\section{Contatti} +Per commenti, suggerimenti o segnalazione bugs potete contattarmi all'indirizzo \href{mailto:bresciani@sssup.it}{\textit{bresciani@sssup.it}}. + +\end{document} |