diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/overlays/overlays.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/overlays/overlays.tex | 87 |
1 files changed, 87 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/overlays/overlays.tex b/Master/texmf-dist/doc/latex/overlays/overlays.tex new file mode 100644 index 00000000000..1698f2f8b9e --- /dev/null +++ b/Master/texmf-dist/doc/latex/overlays/overlays.tex @@ -0,0 +1,87 @@ +\documentclass[a4paper]{ltxdoc} +\usepackage[breaklinks,hidelinks]{hyperref} +\usepackage{polyglossia} +\setdefaultlanguage{english} +\setlength{\leftmargini}{\parindent} +\frenchspacing +\sloppy + +\begin{document} +\title{\textsf{overlays} -- incremental slides} +\author{Andreas Nolda} +\date{2016/09/30 (v.\,2.0)} +\maketitle + +\noindent The \textsf{overlay} package allows to write presentations with +incremental slides. It does not presuppose any specific document class. Rather, +it is a lightweight alternative to full-fledged presentation classes like +\textsf{beamer}. + +In the following, every single state of a incremental slide will be called an +\emph{overlay} of that slide. + +\section{User interface} + +\DescribeMacro{overlays} +\DescribeMacro{fragileoverlays} +For incremental slides, the following environments are provided: +\begin{quote} +|\begin{overlays}{|\meta{total overlay number}|}| \\ +\meta{slide content} \\ +|\end{overlays}| +\end{quote} +\begin{quote} +|\begin{fragileoverlays}{|\meta{total overlay number}|}| \\ +\meta{slide content} \\ +|\end{fragileoverlays}| +\end{quote} +The |fragileoverlays| environment should be used for incremental slides with +verbatim content. + +Note that the slide content should fit on a single page. + +\DescribeMacro{\alert} +\DescribeMacro{\visible} +\DescribeMacro{\only} +In the slide content, the following commands can be used in order +to specify the content of the overlays: +\begin{quote} +|\alert{|\meta{overlay specification}|}{|\meta{content}|}| +\end{quote} +\begin{quote} +|\visible{|\meta{overlay specification}|}{|\meta{content}|}| +\end{quote} +\begin{quote} +|\only{|\meta{overlay specification}|}{|\meta{content}|}| +\end{quote} Overlay specifications are either single numbers like |1|, sequences +of numbers like |1,4|, or ranges of numbers like |1-4| or |1-|. + +The |\alert| command highlights its content on the specified overlays with the +|alert| color, which may be redefined by means of the |\definecolor| command. + +The |\visible| command uncovers its content on the overlays which are specified +in the overlay specification. On unspecified overlays, the content still takes +up space, being rendered in the |background| color, which, by default, is white. + +The content of the |\only| command is also uncovered on the overlays specified +in the overlay specification, but is absent from unspecified overlays and does +not take up space there. + +\section{Known limitations} + +The |\alert|, |\visible|, and |\only| commands must not contain verbatim +commands or environments. They may be used in the content of the |alltt| +environment, though. + +\section{Credits} + +The code of the \textsf{overlays} package is inspired by Matthias Meister's +\textsf{present} package. + +In addition, it uses an algorithm by Martin Scharrer for testing numbers in +numerical ranges (cf. \url{http://tex.stackexchange.com/q/19000/}). + +The code for processing overlays with verbatim content is taken from the +\textsf{texpower} package, which in turn took it from Till Tantau's +\textsf{beamer} package. +\end{document} |