diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/bookest/bookestdoc-en.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/bookest/bookestdoc-en.tex | 29 |
1 files changed, 20 insertions, 9 deletions
diff --git a/Master/texmf-dist/doc/latex/bookest/bookestdoc-en.tex b/Master/texmf-dist/doc/latex/bookest/bookestdoc-en.tex index fe7a1df0803..bd6c2b2e2be 100644 --- a/Master/texmf-dist/doc/latex/bookest/bookestdoc-en.tex +++ b/Master/texmf-dist/doc/latex/bookest/bookestdoc-en.tex @@ -16,7 +16,7 @@ pdfstartview=FitV, %colorlinks } -\setoddheadtext{{\colorA The \texttt{bookest} class --- Version 1.0\hfill Riccardo Bresciani}} +\setoddheadtext{{\colorA The \texttt{bookest} class --- Version 1.0.4\hfill Riccardo Bresciani}} \setoddfoot{\hfill{\colorA\thepage}\hfill} \makeatletter @@ -27,8 +27,8 @@ pdfstartview=FitV, \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. + \chapter*{The \texttt{bookest} class\\{\Large Version 1.0.4 --- \today}\\{\Large Riccardo Bresciani}} +The \texttt{bookest} class in an extension of the standard \texttt{book} class, on which it relies and that is loaded with the default options. \ppar The extensions provided by the class involve: @@ -40,6 +40,8 @@ The extensions provided by the class involve: \item \dots \end{enumerate} +The \texttt{bookest} web page is \url{http://tex.boris-web.net/bookest}. + \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. @@ -47,10 +49,10 @@ The extensions provided by the class involve: 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}. +The default document is black and white, the user can anyway define the colors according 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. +\texttt{bookest} provides some preset color combinations that can be activated with the corresponding class options listed in \ref{coloriopzioni}. For these options to be used the \texttt{hyperref} package is required, as link and anchor colors (color \texttt{A}) and citation color (color \texttt{B}) are set. \subsection{Commands}\label{coloricomandi} \begin{description} @@ -80,6 +82,8 @@ The default document is black and white, the user can anyway define the colors a \item paragraph indentation and spacing. \end{itemize} +Moreover, \texttt{bookest} provides two commands to insert an image or a text as shipout picture. + \subsection{Options} \begin{description} \item[\texttt{oneside}, \texttt{twoside}] toggles duplex options (default: \texttt{twoside}); @@ -101,6 +105,12 @@ The default document is black and white, the user can anyway define the colors a \item[\texttt{noparskip}] sets paragraph spacing to 0. \end{description} +\subsection{Commands} +\begin{description} + \item [\texttt{\textbackslash shipouttext\{\textit{<rot>}\}\{\textit{<sc>}\}\{\textit{<text>}\}}] puts in every page the text \texttt{\textit{<text>}} as shipout picture, rotating it counterclockwise by \texttt{\textit{<rot>}} degrees and applying a scale factor \texttt{\textit{<sc>}}. The default color is gray 5\% --- requires the \texttt{setspace} package --- requires the \texttt{everyshi} and \texttt{color} packages; + \item [\texttt{\textbackslash shipoutimage\{\textit{<options>}\}\{\textit{<file>}\}}] puts in everypage the image \texttt{\textit{<file>}} as shipout picture, using \texttt{\textit{<options>}} as \texttt{\textbackslash includegraphics} options --- requires the \texttt{everyshi} and \texttt{graphicx} packages. +\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>}\}}.}. @@ -127,13 +137,13 @@ It also redefines chapter headings and the \texttt{plain} style to include color \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. +The different options allow to vary the logo position; for each option \texttt{\textit{<optlogo>}} in \ref{copertinaopzioni} there 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 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 \texttt{\textbackslash logo} is the relative path \texttt{logo}, default for the others is \texttt{\textbackslash 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}; @@ -149,7 +159,7 @@ The different options allow to vary the logo position; for each option \texttt{\ \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-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} and the \texttt{eso-pic} packages; \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; @@ -171,10 +181,11 @@ The different options allow to vary the logo position; for each option \texttt{\ \subsection{Environments} \begin{description} + \item[\texttt{abstract}] is an environment of width \texttt{0.9\textbackslash textwidth}, with a parameter \texttt{\textit{<title>}} to be written in bold series before the text contained in the environment; \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}}. +For comments, suggestions or bug reports, you can contact me at the address \href{mailto:bresciani@sssup.it}{\textit{bresciani@sssup.it}}. \end{document} |