diff options
author | Karl Berry <karl@freefriends.org> | 2020-07-14 21:01:45 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2020-07-14 21:01:45 +0000 |
commit | 37fceda406fdeb36413fb4476c13fae49738705a (patch) | |
tree | 40a3919169d17d3d5791cfe1f5cdf2cb0e12595a /Master/texmf-dist/doc/latex/elpres/elpres-manual.tex | |
parent | 488533e5de8e29b1cbb633e54230d9352fc1ade7 (diff) |
elpres (14jul20)
git-svn-id: svn://tug.org/texlive/trunk@55834 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/elpres/elpres-manual.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/elpres/elpres-manual.tex | 317 |
1 files changed, 251 insertions, 66 deletions
diff --git a/Master/texmf-dist/doc/latex/elpres/elpres-manual.tex b/Master/texmf-dist/doc/latex/elpres/elpres-manual.tex index 3cbbd024ee1..1fb50dddb6f 100644 --- a/Master/texmf-dist/doc/latex/elpres/elpres-manual.tex +++ b/Master/texmf-dist/doc/latex/elpres/elpres-manual.tex @@ -8,12 +8,14 @@ \newcommand{\hoch}[1]{\raisebox{0.6ex}{#1}} \newcommand{\tief}[1]{\raisebox{-0.6ex}{#1}} \usepackage{url} +\usepackage{framed} +\usepackage{xcolor} -\title{\textsf{elpres} --- electronic presentations \\ with (PDF)\LaTeX} +\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} +\date{v0.5\\[1.8ex] + July 12, 2020} \begin{document} \maketitle \thispagestyle{empty} @@ -25,25 +27,31 @@ \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 default ``virtual paper size'' +The \textsf{elpres} class can be used for presentations on a screen, a +beamer or projector. It is derived from \LaTeX's \texttt{article} class and +may be used with \LaTeX{}, pdf\LaTeX{} (and Lua\LaTeX ). +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. +4:3 (width:height) aspect ratio. Other aspect ratios for widescreen monitors +may be selected +by class options. The \textsf{elpres} class requires that the \texttt{ifthen}, +\texttt{fancyhdr}, +\texttt{hyperref}, +\texttt{graphicx}, +\texttt{xcolor} +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 +\texttt{overlays}) and slides with a background from a bitmap (\texttt{wallpaper}, \texttt{eso-pic} -packages). +packages). + \section{Installation} -Copy \texttt{elpres.cls} into a directory, where your \LaTeX-system can find -it and update the files database\footnote{e.\,g. by using the -\texttt{mktexlsr} or \texttt{texhash} command (TeXlive)}. +Copy \texttt{elpres.cls} into a directory, where +your \LaTeX-system can find it and update the files database\footnote{e.\,g. +by using the \texttt{mktexlsr} or \texttt{texhash} command (TeXlive)}. \section{Usage} @@ -54,13 +62,33 @@ The class is used with \documentclass[options]{elpres} \end{verbatim} -\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}. +\textbf{\texttt{Elpres}-specific options}: for font selection + \texttt{tmrfont} (Times Roman), \texttt{helvetfont} +(Helvetica), \texttt{cmfont} (Computer Modern), \texttt{sansfont} (Sans +Serif: default) and \texttt{nofonts} (no font selection, +intended for use of \texttt{elpres} with Lua\LaTeX\ +with is own font selection mechanisms) are used. +Options for different screen aspect ratios: \texttt{4x3} +(default), \texttt{16x9}, \texttt{16x10}. The option \texttt{navisymb} +adds symbols for navigation to the presentation. +Options of the \texttt{article} class are also available for +\texttt{elpres} presentations, +e.\,g. \texttt{10pt}, \texttt{11pt}, \texttt{12pt} for +selection of font size. + +{ \sloppy +\textbf{\texttt{Elpres}-specific commands}: +\verb+\distance+ vertically adjusts text on a slide. +The \verb+\auvimm+\footnote{for \textbf{au}dio \textbf{vi}deo \textbf{m}edia} +command inserts a link to an external audio or video file. +Two commands: \verb+\fromlinktext+ and \verb+\totargettext+ +can be used for internal links within a presentation. + + +\textbf{\texttt{Elpres}-specific environments}: +the environments \texttt{psli} and \texttt{rsli} define ``slides'' in +\texttt{elpres}; \texttt{citemize}, \texttt{cenumerate} and +\texttt{cdescription} provide vertically compressed lists. A simple example document: @@ -98,19 +126,22 @@ A simple example document: \end{document} \end{verbatim} -%% Options to be used are \texttt{10pt}, \texttt{11pt}, \texttt{12pt} (font size), -%% \texttt{pdftex}, \texttt{dvips} -%% (if you use \texttt{graphicx} and/or \texttt{color} packages). -The title page can be created within the \texttt{titlepage} environment, the +%% Here a minimalistic example + +\subsection{Essential elements of an \texttt{elpres} presentation} + +The \textbf{title page} can be created within the \texttt{titlepage} environment, the \verb+\maketitle+ command is not available. -Slides may be created with the -\texttt{psli}-environment\footnote{\texttt{psli}: plain slide}, you may add +\textbf{Slides} may be created with the +\texttt{psli}-environment\footnote{\texttt{psli}: \textbf{pl}ain + \textbf{sl}ide}, you may add the title of the slide with the optional parameter. The contents of the slide are centered vertically. -Another environment generating a slide is -\texttt{rsli}\footnote{\texttt{rsli}: raw slide}: slides are written +Another environment generating a \textbf{slide} is +\texttt{rsli}\footnote{\texttt{rsli}: \textbf{ra}w \textbf{sl}ide}: +slides are written without title, contents are not vertically centered. @@ -126,21 +157,23 @@ option resets numbering for each new slide. For a presentation, the After inserting a new footnote, numbers or symbols are correctly inserted only after a second run of \LaTeX. -\subsection{Improving paragraph justification} +\subsection{Alternatives to \TeX's justified paragraphs} 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 +deficiencies: by inhibiting hypenation in texts with rather short lines, +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. +\texttt{ragged2e} package. -\subsection{Generate vertically compressed lists} +\subsection{Vertically compressed lists} -The \texttt{elpres} package provides a ``vertically compressed'' -\texttt{itemize}-environment: +As the spaces between lines may be too great with the \texttt{itemize} +environment, +the \texttt{elpres} package provides a ``vertically compressed'' +\texttt{citemize}-environment: \begin{verbatim} \begin{citemize} @@ -169,8 +202,7 @@ parameters can be added in the format: \end{itemize} \end{verbatim} -The ``vertically -compressed'' list can then be obtained with +The ``vertically compressed'' list can then be obtained with \begin{verbatim} \begin{itemize}[nosep] @@ -179,8 +211,8 @@ compressed'' list can then be obtained with \end{itemize} \end{verbatim} -The \texttt{enumitem} package is also able to modify the \texttt{enumerate} and -description \texttt{environments}. +Similarly, the \texttt{enumitem} package is also able to modify the +\texttt{enumerate} and description \texttt{environments}. @@ -326,54 +358,200 @@ yellow as background: For more details on \texttt{overlays}, see the documentation of the package. -\subsection{Create a ``handout'' from a presentation} + +\subsection{Navigation symbols} +\label{sec:NavigationSymbols} + +With the \texttt{navisymb} option a panel with navigation symbols +(colored in light gray) appears +in the right lower corner of the presentation:\\ + + +{ \setlength{\parindent}{2em} + \indent + \textbf{\texttt{$\ll$ $<$ $>$ $\gg$ $\leftarrow$ $\rightarrow$ [n]}} +}\\ + +These commands ($\ll$: jump to the first page, +$<$: go to the previous page, $>$: go to the next page, +$\gg$: jump to the last page, $\leftarrow$: +go back in history, $\rightarrow$: go forward in history, +\texttt{[n]}: prompt for a +page number) +work with Adobe Acrobat Reader (Windows), and (with the exception of +\texttt{$\leftarrow$}, \texttt{$\rightarrow$} and \verb+[n]+) +with \texttt{evince} (Linux). +Some of these functions also work in presentation-mode +of the ``internal'' PDF-viewer in recent versions of the +\texttt{Firefox}-browser (Linux, Windows). + + +\subsection{Call multimedia content from a presentation} +\label{sec:MultimediaContent} + + +The command \verb+\auvimm{text}{media-file}+ inserts \texttt{text} with +a link, which calls the default application for audio or video media files +\texttt{media-file}. +This seems to work with Adobe Acrobat Reader (Windows) and with +\texttt{evince} (Linux). +An example for using this command: + +\begin{verbatim} + \auvimm{[sound-file]}{./audiofile.mp3} +\end{verbatim} + +This produces the (text-based) ``button'' \texttt{[sound-file]}. If you +hit it with the mouse pointer it will call the default application for +audio files. This approach requires that you keep the presentation file +together with the multimedia files in the same folder, \textbf{also at + the time of + the presentation}. On an unknown computer system (where you have to show +your presentation) you should test this aspect of your presentation. Sometimes +a call to an external program might be blocked due security reasons in Acrobat +Reader. + +\begin{leftbar} +This \texttt{elpres}-command should be considered experimental. +Its behavior depends on the pdf-reader and the configuration of the OS. +\end{leftbar} +\subsection{Prepare 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: + +In advance of a lecture it is often expected that you +prepare a ``handout'' from your presentation with more than one +pages on a printed page. Therefore +you have several options, two of them are described +here. + +\subsubsection{\LaTeX\ article document with a series of single-page pdf-files included} + +One solution to this problem is (1) to generate a series of single-page +pdf-files and (2) to create a pdf\LaTeX\ document with the single +pages included. + +\textbf{(1)} can be done with \texttt{gs} (the Ghostscript program): + +\begin{verbatim} + gs -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=page_%03d.pdf in.pdf +\end{verbatim} + +with \texttt{in.pdf} as the initial presentation. The syntax of \texttt{gs} +is described in detail on the ghostscript +website\footnote{\url{https://www.ghostscript.com/doc/current/Use.htm}}. +An alternative to \texttt{gs} is \texttt{pdftk} tool: \begin{verbatim} - pdfjam --nup 2x3 --scale 0.9 -o new.pdf presentation.pdf '1-4,7-17,22' + pdftk in.pdf burst output page_%02d.pdf +\end{verbatim} + +The syntax of \texttt{pdftk} is explained in the documentation +(\texttt{pdftk~--help}). + +\textbf{(2)} an example for a \LaTeX\ document which can serve as handout: + +\begin{verbatim} + \documentclass[12pt]{article} + \usepackage[pdftex]{graphicx} + \usepackage[latin1]{inputenc} + \usepackage[a4paper,hmargin=2.4cm,top=24mm,bottom=28mm]{geometry} + \newcommand{\PictScaleFact}{0.45} + + \begin{document} + \centering + \fbox{\includegraphics[width=\PictScaleFact\textwidth]{page_001.pdf}} + \hspace{5mm} + \fbox{\includegraphics[width=\PictScaleFact\textwidth]{page_002.pdf}} + \\[2ex] + \fbox{\includegraphics[width=\PictScaleFact\textwidth]{page_003.pdf}} + \hspace{5mm} + % ... + \fbox{\includegraphics[width=\PictScaleFact\textwidth]{page_008.pdf}} + % ... + \end{document} +\end{verbatim} + +\subsubsection{Convert presentation pdf-file directly into handout file with \texttt{pdfjam}} + +With the following command: + +\begin{verbatim} + pdfjam --nup 2x4 --frame true --scale 0.9 -o new.pdf in.pdf '1-4,6-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 +\texttt{pdfjam}\footnote{which regerettably is only available on +Linux or other Unix-like systems} +creates a ``handout'' PDF document (\texttt{new.pdf}) fom +\texttt{in.pdf} with the slides nr. 1-4,6-22 +arranged in two columns and four 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. +man page and the project +website\footnote{https://github.com/DavidFirth/pdfjam/blob/master/README.md}. \end{sloppypar} + + \subsection{Create presentations with hypertext elements} \label{secHypertext} -You may use the hyperref package. As you normally will not insert -\verb+\section{}+-like commands, it is easier to define links with +You may use two commands \verb+\fromlinktext{}{}+ and \verb+\totargettext{}{}+ +for ``hypertext features''. As an example: as you normally will not insert +\verb+\section{}+-like commands and therefore do not generate a ``table of +contents''-like page or a menu in \texttt{elpres}-presentations, you are able +define links with: \begin{verbatim} - \hypertarget{target-name}{text} + \totargettext{text}{link-label} \end{verbatim} +% \hypertarget{target-name}{text} + which can be addressed by \begin{verbatim} - \hyperlink{target-name}{text} + \fromlinktext{text}{link-label} \end{verbatim} -The hyperref package will produce a warning message, if you use the -titlepage-environment (this is inherited from the article class). To avoid -the warning you can use the \texttt{rsli}-environment for the titlepage and use -\verb+\thispagestyle{empty}+ to suppress the page number on the title. +% \hyperlink{target-name}{text} + +If you use these commands to generate a \textbf{menu page} (as a hyperlinked +table of contents) with items pointing to +specific slides: +\texttt{link-label} acts as label, \texttt{text} in the +\verb+\fromlinktext+ command is converted to a link (e.\,g. on a menu-page). +If you click on this text ``button'', you jump to +the \texttt{text} labelled with +\verb+\totargettext+; \texttt{link-label} has to be identical in a +\verb+\fromlinktext+ and \verb+\totargettext+ pair, +\texttt{text} in the link +and the target, of course need not to be identical. + +The default for the link border color is red, it may be changed with +\verb+\hypersetup{}+, a command from the \texttt{hyperref} +package\footnote{both, \texttt{\textbackslash totargettext} and +\texttt{\textbackslash fromlinktext} are +are redefinitions of commands from the \texttt{hyperref} package}. +The option for the color of the frame around the link is +\texttt{linkbordercolor}, +colors must be defined whith three figures \texttt{[0..1]} according to the RGB +color model: -\subsection{Fill background of a presentation with bitmaps} +\begin{verbatim} + \hypersetup{linkbordercolor={0.6 0.6 0.6}} +\end{verbatim} +This defines a light gray color for the link border, more details on +\verb+\hypersetup{}+ are +described in the documentation of the \texttt{hyperref} package. + +\subsection{Fill background of a presentation with bitmaps} \label{secBackgroundWallpaper} @@ -441,7 +619,7 @@ This class is distributed under the \textsl{\LaTeX{} Project Public License} \url{http://www.latex-project.org/lppl.txt}. No warranty is provided for this work (as stated in the LPPL). -\section{Versions} +\section{Version history} \textbf{v0.1} (19.6.2004): initial version. \textbf{v0.2} (1.9.2004): page numbers now changed to footnotesize, left and @@ -458,7 +636,7 @@ added). \textbf{v0.2e} (15.04.2005): Documentation completed (sections \ref{secBackgroundEsopic} and \ref{secHandout} added). \textbf{v0.3} (12.08.2005): new (class) options for font selection: -\texttt{tmrfont} (Times Roman), \texttt{helvetfont} (Helevetica), +\texttt{tmrfont} (Times Roman), \texttt{helvetfont} (Helvetica), \texttt{cmfont} (Computer Modern), \texttt{sansfont} (Sans Serif: default). Documentation updated, sections \ref{secInclGraphicsFiles} and \ref{secTwoColumns} added. @@ -468,8 +646,15 @@ 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 +\textbf{v0.4a} (24.01.2018): Documentation completed. +\textbf{v0.5} (12.07.2020): New class options: \texttt{nofonts} +(no font selection) and \texttt{navisymb} (inserts a panel of +symbols for navigation), new commands: \verb+auvimm+ (generates +a link to external audio, video files), \verb+\fromlinktext+ and +\verb+\totargettext+ (create links within a presentation). +Documentation has been partly rewritten. + \end{document} -% vim:set spell:set fileencoding=latin1: +% vim:spell:fileencoding=latin1:lines=55: |