diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/elpres/elpres-manual.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/elpres/elpres-manual.tex | 307 |
1 files changed, 230 insertions, 77 deletions
diff --git a/Master/texmf-dist/doc/latex/elpres/elpres-manual.tex b/Master/texmf-dist/doc/latex/elpres/elpres-manual.tex index 112ccc7ca73..3cbbd024ee1 100644 --- a/Master/texmf-dist/doc/latex/elpres/elpres-manual.tex +++ b/Master/texmf-dist/doc/latex/elpres/elpres-manual.tex @@ -2,24 +2,22 @@ \setlength{\parskip}{0.6ex} \setlength{\parindent}{0mm} -\usepackage{mathptmx,courier} -\usepackage[scaled=0.92]{helvet} -%\usepackage{german} \usepackage[latin1]{inputenc} \usepackage{textcomp} -%% \usepackage[a4paper,hmargin=2.4cm]{geometry} \usepackage[a4paper,hmargin=2.4cm,bottom=3.2cm]{geometry} \newcommand{\hoch}[1]{\raisebox{0.6ex}{#1}} \newcommand{\tief}[1]{\raisebox{-0.6ex}{#1}} \usepackage{url} -\title{\textsf{Elpres}: electronic presentations with (PDF)\LaTeX} -\author{Volker Kiefel\thanks{volker dot kiefel at freenet dot de}} -\date{v0.3} +\title{\textsf{elpres} --- electronic presentations \\ with (PDF)\LaTeX} +\author{Volker Kiefel\thanks{volker dot kiefel at freenet dot de, + http://vkiefel.de/elpres.html}} +\date{v0.4a\\[1.8ex] + January 24, 2018} \begin{document} \maketitle \thispagestyle{empty} - + { \setlength{\parskip}{0ex} \tableofcontents @@ -27,64 +25,73 @@ \section{Introduction} -\textsf{Elpres} is a simple class for presentations to be shown on -screen or beamer. It is derived from \LaTeX's \texttt{article} class. -\textsf{Elpres} is primarily intended to be used with PDF\LaTeX{} or with \LaTeX, -\texttt{dvips} and Ghostview/Ghostscript. The ``virtual paper -size'' of documents produced by this class: width=128mm, height=96mm. -\textsf{Elpres} requires that the \texttt{fancyhdr} and \texttt{geometry} -packages are available on the system. Enhancements to the elpres class are -easily made available by other packages, these include hypertext elements -(\texttt{hyperref} package) and slides with a background from a bitmap -(\texttt{wallpaper}, \texttt{eso-pic} packages). - +\textsf{Elpres} is a simple class for presentations to be shown on screen or +beamer. It is derived from \LaTeX's \texttt{article} class. \textsf{Elpres} +is primarily intended to be used with PDF\LaTeX{} or with \LaTeX, +\texttt{dvips} and Ghostview/Ghostscript. The default ``virtual paper size'' +of documents produced by this class: width=128mm, height=96mm corresponds to a +4:3 aspect ratio. Other aspect ratios for widescreen monitors may be selected +by class options. \textsf{Elpres} requires that the \texttt{ifthen}, +\texttt{fancyhdr} and \texttt{geometry} packages are available on the system. +Enhancements to \texttt{elpres} are easily made available by other packages, +these include overlay support for incremental slides (package +\texttt{overlays}) hypertext elements (\texttt{hyperref} package) and slides +with a background from a bitmap (\texttt{wallpaper}, \texttt{eso-pic} +packages). \section{Installation} Copy \texttt{elpres.cls} into a directory, where your \LaTeX-system can find -it. +it and update the files database\footnote{e.\,g. by using the +\texttt{mktexlsr} or \texttt{texhash} command (TeXlive)}. \section{Usage} +\label{secUsage} + The class is used with \begin{verbatim} \documentclass[options]{elpres} \end{verbatim} -\textbf{Options of the \texttt{article} class} are also available to elpres, -e.\,g. \texttt{10pt}, \texttt{11pt}, \texttt{12pt} for selection of font -size. \textbf{Elpres-specific options} allow selection of the font: -\texttt{tmrfont} (Times Roman), \texttt{helvetfont} (Helevetica), -\texttt{cmfont} (Computer Modern), \texttt{sansfont} (Sans Serif: default). -However, not all options of the \texttt{article} class will be appropriate for -a presentation class, e.\,g. \texttt{twocolumn}. +\textbf{Options of the \texttt{article} class} are also available to +\texttt{elpres}, e.\,g. \texttt{10pt}, \texttt{11pt}, \texttt{12pt} for +selection of font size. \textbf{\texttt{Elpres}-specific options} allow +selection of the font: \texttt{tmrfont} (Times Roman), \texttt{helvetfont} +(Helevetica), \texttt{cmfont} (Computer Modern), \texttt{sansfont} (Sans +Serif: default). Options for different screen aspect ratios: \texttt{4x3} +(default), \texttt{16x9}, \texttt{16x10}. A simple example document: - \begin{verbatim} - \documentclass[12pt,pdftex,helvetfont]{elpres} + \documentclass[12pt,pdftex,helvetfont,4x3]{elpres} \usepackage[latin1]{inputenc} \usepackage{color} \usepackage[document]{ragged2e} \RaggedRight - + \begin{document} \begin{titlepage} \centering \distance{1} { - \Huge \bfseries \textcolor{blue}{Title of the presentation} \par + \Huge \bfseries \textcolor{blue}{Title of the presentation} \par } \vspace{1.3ex} \large Author\\[2ex]Institution \distance{2} \end{titlepage} - + \begin{psli}[Title of Page] The first page + + \begin{itemize} + \item first line in an itemized list + \item second line in an itemized list + \end{itemize} \end{psli} - + \begin{rsli} The second page \end{rsli} @@ -112,7 +119,28 @@ slides constructed with the \texttt{rsli} and \texttt{titlepage} environments. You should use pairs of \verb+\distance{}+ commands with numbers indicating the relative height of empty space, see the titlepage in the example above. -The package provides a ``vertically compressed'' \texttt{itemize}-environment: +The use of footnotes on slides is often problematic, if they cannot be +avoided, the \texttt{footmisc} package is recommended: the \texttt{perpage} +option resets numbering for each new slide. For a presentation, the +\texttt{symbol} option allows to use symbols instead of numbers. +After inserting a new footnote, numbers or symbols are correctly +inserted only after a second run of \LaTeX. + +\subsection{Improving paragraph justification} + +By default, \LaTeX\ produces justified paragraphs with lines of equal length, +this may often not be appropriate for the usually very short lines of text +in presentations. The \LaTeX\ \verb+\raggedright+ command has its own +deficiencies: by inhibiting hypenation, the text at the right margin will +often look too +ragged. A solution is to use the \verb+\RaggedRight+ command of the +\texttt{ragged2e} package by Martin Schröder. + + +\subsection{Generate vertically compressed lists} + +The \texttt{elpres} package provides a ``vertically compressed'' +\texttt{itemize}-environment: \begin{verbatim} \begin{citemize} @@ -124,10 +152,38 @@ The package provides a ``vertically compressed'' \texttt{itemize}-environment: Similarly, a \texttt{cenumerate} and a \texttt{cdescription} environment may be used. -Pictures can be included with the \texttt{includegraphics}-command of the -\texttt{graphicx}-package. Please be aware that the dimensions of the pages -are 128mm \texttimes{} 96mm and therefore included graphics are scaled -appropriately. +% neu Dezember 2017 +Another solution for the customization of \texttt{itemize} +environments is given by the \texttt{enumitem} package. Therefore + +\begin{verbatim} + \usepackage{enumitem} +\end{verbatim} + +should be added to the preamble, and a comma-sperated list of parameters +parameters can be added in the format: + +\begin{verbatim} + \begin{itemize}[parameter-list] + ... + \end{itemize} +\end{verbatim} + +The ``vertically +compressed'' list can then be obtained with + +\begin{verbatim} + \begin{itemize}[nosep] + \item one + \item two + \end{itemize} +\end{verbatim} + +The \texttt{enumitem} package is also able to modify the \texttt{enumerate} and +description \texttt{environments}. + + + \section{Enhancements to elpres} @@ -135,21 +191,38 @@ appropriately. \subsection{Include graphics files} -\label{secInclGraphicsFiles} +Graphics files/pictures can be included with the +\texttt{includegraphics}-command of the \texttt{graphicx}-package. Please be +aware that the dimensions of the pages are 128mm \texttimes{} 96mm and +therefore included graphics are scaled appropriately. A safe way to generate a +page with a picture could be (with \texttt{pict.png} as the name of the +graphics file): + +\label{secUsageGraph} -Graphics files may be included with the \texttt{includegraphics} command of -the \texttt{graphicx} package. If you create pdf-files with \texttt{pdflatex}, -both .pdf and .png files can be included, if you create pdf files with -\LaTeX{} and \texttt{dvipdfm} or if you create ps files with \LaTeX{} and -\texttt{dvips} you may include .eps files: \begin{verbatim} - \usepackage{graphicx} % (in preamble) + \usepackage[pdftex]{graphicx} % (in preamble) ... - \includegraphics[width=0.9\textwidth]{graphics-file.png} - + \begin{rsli} + \centering + \distance{1} + \includegraphics[width=0.9\textwidth,% + height=0.9\textheight,% + keepaspectratio=true]{pict.png} + \distance{1} + \end{rsli} \end{verbatim} + +The \verb+\includegraphics[]{}+ comannd requires to select the correct device +driver related option (e.\,g. \texttt{pdftex} or \texttt{dvips}) +(documentclass). + + +\label{secInclGraphicsFiles} + + \subsection{Arrange text and pictures in two (or more) columns} \label{secTwoColumns} @@ -175,36 +248,107 @@ Text and graphics may be arranged in two or more columns with Details on the minipage environment may be found in the \LaTeX{} documentation. -\subsection{Create a ``handout'' from a presentation} -\label{secHandout} +\subsection{Incremental slides (overlays)} + +\label{secOverlay} + +If the contents of slides are to be made visible step +by step this can be achieved by a series of output PDF or (PS) files (carrying +the same page number) usually called \emph{overlays}. It may also be of +interest to change a highlighting color in a series of overlays. This is most +easily done by using the \texttt{overlays} package written by Andreas Nolda +together with \texttt{elpres}. -If you wish to create a handout from your presentation, you should create a -PostScipt version of your presentation and convert ot with the -\texttt{psnup}-tool. This is possible, if you create your presentation as -\texttt{.ps} file from a \texttt{.dvi}-file with \texttt{dvips}. If your -primary version is a pdf-file, e.\,g. created by pdf\LaTeX, either +To generate a series of four overlays sequentially showing four lines of a +list: \begin{enumerate} - \item convert the pdf-file with the command \texttt{pdf2ps} (part of the - ghostscript package) - \item or convert it with Acrobat. + \item load the \texttt{overlays} package in the preamble + \item put a \texttt{psli} or \texttt{rsli} slide environment into an + \texttt{overlays} (or \texttt{fragileoverlays}) environment + \item enter the number of overlays as the first parameter to the + \texttt{overlays} environment + \item enter text contents with the \texttt{visible} command with the range + of overlays showing this text content \end{enumerate} +A simple example: + +\begin{verbatim} + % to be added in preamble + \usepackage{overlays} + ... + \begin{overlays}{4} + \begin{psli}[Title of slide] + \begin{itemize} + \visible{1-4}{\item first item of list} + \visible{2-4}{\item second list item} + \visible{3-4}{\item 3rd list item} + \visible{4}{\item final list item} + \end{itemize} + \end{psli} + \end{overlays} + ... +\end{verbatim} + +The following example uses the \texttt{alert} command to highlight lines +sequentially: -The following command creates a handout with four slides on one page with the -\texttt{psnup}-command line program% -\footnote{A win32-version of this tool can be obtained from the website -\url{http://people.freenet.de/vkiefel/compiled-SW.html}. \texttt{Psnup} may -be bundled to your \TeX/\LaTeX{} distribution}. +\begin{verbatim} + \begin{overlays}{4} + \begin{psli}[Title of slide] + \begin{itemize} + \alert{1}{\item first item of list} + \alert{2}{\item second list item} + \alert{3}{\item 3rd list item} + \alert{4}{\item final list item} + \end{itemize} + \end{psli} + \end{overlays} +\end{verbatim} + +The ``hidden'' text contents are written by \texttt{overlays} in the same +color as the background, default is white. If you use a different background +color, you have to change the color of the hidden text as well by assigning the +background color to the color name \texttt{background} (understood by the +\texttt{overlays} package). In the following example you define a light +yellow as background: \begin{verbatim} - psnup -4 -H96mm -W128mm -m15mm -b6mm old.ps new.ps + % (in the preamble) + \definecolor{myyellow}{rgb}{0.96,0.98,0.72} % define color + \definecolor{background}{named}{myyellow} % color assigned to + % hidden text + \pagecolor{myyellow} % color of slide background \end{verbatim} -Details of the command line options can -be found in the short documentation of \texttt{psnup}. You may print -\texttt{new.ps} with \texttt{ghostview} or \texttt{gsview32/ghostview}. + +For more details on \texttt{overlays}, see the documentation of the package. + +\subsection{Create a ``handout'' from a presentation} + +\label{secHandout} + +If you wish to generate a handout from your presentation with more than one +pages on a printed page, you may process a PDF presentation file with +\texttt{pdfjam}\footnote{which regerettably is only available on +Linux or other Unix-like systems}. + +The following command: + +\begin{verbatim} + pdfjam --nup 2x3 --scale 0.9 -o new.pdf presentation.pdf '1-4,7-17,22' +\end{verbatim} + +\begin{sloppypar} +creates a ``handout'' PDF document (\texttt{new.pdf}) with the slides 1-4,7-17 +and 22 of \texttt{presentation.pdf} arranged in two columns and three rows. +With the additional option \texttt{--frame~true}, \texttt{pdfjam} draws a box +around each slide. More details can be found in the \texttt{pdfjam} +man page. On Windows systems Acrobat reader may be helpful to print +handout documents with more than one slide per printed page. +\end{sloppypar} \subsection{Create presentations with hypertext elements} @@ -235,8 +379,8 @@ the warning you can use the \texttt{rsli}-environment for the titlepage and use \subsubsection{\texttt{Wallpaper} package} -To create a background with color gradient, with pictures or with a ``tiled'' -background using bitmaps you may use the \texttt{wallpaper} +To create a slide background with a graphical wallpaper +background using bitmap files you may use the \texttt{wallpaper} package\footnote{written by Michael H.F. Wilkinson and available on CTAN}. Load the \texttt{wallpaper} package with @@ -245,24 +389,23 @@ Load the \texttt{wallpaper} package with \end{verbatim} \begin{sloppypar} -in the preamble. In order to generate a background gradient on the basis of the bitmap -file \texttt{gradient2.png}\footnote{included in this -\texttt{elpres}-distribution} enter +in the preamble. In order to generate a background based on bitmap +file \texttt{background.png}, enter \end{sloppypar} \begin{verbatim} - \CenterWallPaper{1}{gradient2} + \CenterWallPaper{1}{background.png} \end{verbatim} before the contents of the presentation\footnote{i.\,e. following \texttt{\textbackslash begin\{document\}}}. -This works best with bitmaps with a width:size ratio of 4:3, the included -bitmap files have a size of 640:480 pixel. -Similarly bitmap files may be +This works best with bitmaps with an appropriate aspect ratio, in the case of +an 4x3 screen format a bitmap picture of 640x480 pixel would fit perfectly. +Moreover bitmap files may be used as tiles as described in the \texttt{wallpaper} documentation like \begin{verbatim} - \TileSquareWallPaper{4}{TGTamber} + \TileSquareWallPaper{4}{background.png} \end{verbatim} More details on this topic may be found in the \texttt{wallpaper} @@ -280,7 +423,7 @@ Another package which allows you to paint the background with a picture is ... \AddToShipoutPicture{ - \includegraphics[height=\paperheight]{gradient2.png} + \includegraphics[height=\paperheight]{background.png} } \end{verbatim} @@ -319,4 +462,14 @@ added). \texttt{cmfont} (Computer Modern), \texttt{sansfont} (Sans Serif: default). Documentation updated, sections \ref{secInclGraphicsFiles} and \ref{secTwoColumns} added. +\textbf{v0.4} (20.01.2018): New class options for different screen aspect +ratios \texttt{4x3}, \texttt{16x9}, \texttt{16x10}; ``compressed'' list +environments modified; documentation completed: +packages for use with \texttt{elpres}: \texttt{enumitem} (alternative list +environments), \texttt{overlays} (overlay support: incremental slides); +section \ref{secHandout} was completely rewritten. +\textbf{v0.4a} (24.01.2018): Documentation completed \end{document} + + +% vim:set spell:set fileencoding=latin1: |