| 1 |
% !TeX root = beameruserguide.tex |
| 2 |
% Copyright 2003--2007 by Till Tantau |
| 3 |
% Copyright 2010 by Vedran Mileti\'c |
| 4 |
% Copyright 2013,2015 by Vedran Mileti\'c, Joseph Wright |
| 5 |
% Copyright 2017,2018 by Louis Stuart, Joseph Wright |
| 6 |
% |
| 7 |
% This file may be distributed and/or modified |
| 8 |
% |
| 9 |
% 1. under the LaTeX Project Public License and/or |
| 10 |
% 2. under the GNU Free Documentation License. |
| 11 |
% |
| 12 |
% See the file LICENSE.md for more details. |
| 13 |
|
| 14 |
\def\beamer{\textsc{beamer}} |
| 15 |
\def\pdf{\textsc{pdf}} |
| 16 |
\def\pgfname{\textsc{pgf}} |
| 17 |
\def\translatorname{\textsc{translator}} |
| 18 |
\def\pstricks{\textsc{pstricks}} |
| 19 |
\def\prosper{\textsc{prosper}} |
| 20 |
\def\seminar{\textsc{seminar}} |
| 21 |
\def\texpower{\textsc{texpower}} |
| 22 |
\def\foils{\textsc{foils}} |
| 23 |
|
| 24 |
{ |
| 25 |
\makeatletter |
| 26 |
\global\let\myempty=\@empty |
| 27 |
\global\let\mygobble=\@gobble |
| 28 |
\makeatother |
| 29 |
\gdef\getridofats#1@#2\relax{% |
| 30 |
\def\getridtest{#2}% |
| 31 |
\ifx\getridtest\myempty% |
| 32 |
\expandafter\def\expandafter\strippedat\expandafter{\strippedat#1} |
| 33 |
\else% |
| 34 |
\expandafter\def\expandafter\strippedat\expandafter{\strippedat#1\protect\printanat} |
| 35 |
\getridofats#2\relax% |
| 36 |
\fi% |
| 37 |
} |
| 38 |
\gdef\removeats#1{% |
| 39 |
\let\strippedat\myempty% |
| 40 |
\edef\strippedtext{\stripcommand#1}% |
| 41 |
\expandafter\getridofats\strippedtext @\relax% |
| 42 |
} |
| 43 |
\makeatletter |
| 44 |
\gdef\stripcommand#1{\expandafter\@gobble\string#1} |
| 45 |
} |
| 46 |
\providecommand\href[2]{\texttt{#1}} |
| 47 |
|
| 48 |
\def\printanat{\char`\@} |
| 49 |
|
| 50 |
\def\declare#1{{\color{red!75!black}#1}} |
| 51 |
%\def\declare{\afterassignment\translatormanualdeclare\let\next=} |
| 52 |
%\def\translatormanualdeclare{\ifx\next\bgroup\bgroup\color{red!75!black}\else{\color{red!75!black}\next}\fi} |
| 53 |
|
| 54 |
\def\command#1{\list{}{\leftmargin=2em\itemindent-\leftmargin\def\makelabel##1{\hss##1}}% |
| 55 |
\item\extractcommand#1@\par\topsep=0pt} |
| 56 |
\def\endcommand{\endlist} |
| 57 |
\def\extractcommand#1#2@{\strut\declare{\texttt{\string#1}}#2% |
| 58 |
\index{\stripcommand#1@\protect\myprintcommand{\stripcommand#1}}} |
| 59 |
|
| 60 |
%\let\textoken=\command |
| 61 |
%\let\endtextoken=\endcommand |
| 62 |
|
| 63 |
\def\myprintcommand#1{\texttt{\char`\\#1}} |
| 64 |
|
| 65 |
\def\example{\par\smallskip\noindent\textit{Example: }} |
| 66 |
\def\themeauthor{\par\smallskip\noindent\textit{Theme author: }} |
| 67 |
|
| 68 |
\def\environment#1{\list{}{\leftmargin=2em\itemindent-\leftmargin\def\makelabel##1{\hss##1}}% |
| 69 |
\extractenvironement#1@\par\topsep=0pt} |
| 70 |
\def\endenvironment{\endlist} |
| 71 |
\def\extractenvironement#1#2@{% |
| 72 |
\item{{\ttfamily\char`\\begin\char`\{\declare{#1}\char`\}}#2}% |
| 73 |
{\itemsep=0pt\parskip=0pt\item{\meta{environment contents}}% |
| 74 |
\item{\ttfamily\char`\\end\char`\{\declare{#1}\char`\}}}% |
| 75 |
\index{#1@\protect\texttt{#1} environment}% |
| 76 |
\index{Environments!#1@\protect\texttt{#1}}} |
| 77 |
|
| 78 |
\def\classoption#1{\list{}{\leftmargin=2em\itemindent-\leftmargin\def\makelabel##1{\hss##1}}% |
| 79 |
\item{{\ttfamily\char`\\documentclass[\declare{#1}]\char`\{beamer\char`\}}} |
| 80 |
\index{#1@\protect\texttt{#1} class option}% |
| 81 |
\index{Class options for \textsc{beamer}!#1@\protect\texttt{#1}}% |
| 82 |
\par\topsep=0pt} |
| 83 |
\def\endclassoption{\endlist} |
| 84 |
|
| 85 |
|
| 86 |
\newcommand\beameroption[2]{\list{}{\leftmargin=2em\itemindent-\leftmargin\def\makelabel##1{\hss##1}}% |
| 87 |
\item{{\ttfamily\char`\\setbeameroption\char`\{\declare{#1}{\normalfont\opt{#2}}\char`\}}} |
| 88 |
\index{#1@\protect\texttt{#1} beamer option}% |
| 89 |
\index{Beamer options!#1@\protect\texttt{#1}}% |
| 90 |
\par\topsep=0pt} |
| 91 |
\def\endbeameroption{\endlist} |
| 92 |
|
| 93 |
|
| 94 |
\def\smallpackage{\vbox\bgroup\package} |
| 95 |
\def\endsmallpackage{\egroup\endpackage} |
| 96 |
|
| 97 |
\def\package#1{\list{}{\leftmargin=2em\itemindent-\leftmargin\def\makelabel##1{\hss##1}}% |
| 98 |
\extracttheme#1@usepackage@package@Packages@\par\topsep=0pt} |
| 99 |
\def\endpackage{\endlist} |
| 100 |
%\def\extracttheme#1#2@{% |
| 101 |
%\item{{{\ttfamily\char`\\usepackage}#2{\ttfamily\char`\{\declare{#1}\char`\}}}}} |
| 102 |
|
| 103 |
\def\theme#1#2#3#4{\list{}{\leftmargin=2em\itemindent-\leftmargin\def\makelabel##1{\hss##1}}% |
| 104 |
\extracttheme#2@#1@#3@#4@\par\topsep=0pt} |
| 105 |
\def\endtheme{\endlist} |
| 106 |
\def\extracttheme#1#2@#3@#4@#5@{% |
| 107 |
\item{{{\ttfamily\char`\\#3}#2{\ttfamily\char`\{\declare{#1}\char`\}}}}% |
| 108 |
\index{#1@\protect\texttt{#1} #4}% |
| 109 |
\index{#5!#1@\protect\texttt{#1}} |
| 110 |
} |
| 111 |
|
| 112 |
\def\class#1{\list{}{\leftmargin=2em\itemindent-\leftmargin\def\makelabel##1{\hss##1}}% |
| 113 |
\extractclass#1@\par\topsep=0pt} |
| 114 |
\def\endclass{\endlist} |
| 115 |
\def\extractclass#1#2@{% |
| 116 |
\item{{{\ttfamily\char`\\documentclass}#2{\ttfamily\char`\{\declare{#1}\char`\}}}}% |
| 117 |
\index{#1@\protect\texttt{#1} class}% |
| 118 |
\index{Classes!#1@\protect\texttt{#1}}} |
| 119 |
|
| 120 |
\def\typesetsol#1{\texttt{\def\_{\char`\_}#1}} |
| 121 |
|
| 122 |
\def\solution#1{\list{}{\leftmargin=2em\itemindent-\leftmargin\def\makelabel##1{\hss##1}}% |
| 123 |
\item \textbf{Solution Template }\declare{\typesetsol{#1}}\par\topsep=0pt% |
| 124 |
\index{#1@\protect\typesetsol{#1} solution}% |
| 125 |
\index{Solutions!#1@\protect\typesetsol{#1}}} |
| 126 |
\def\endsolution{\endlist} |
| 127 |
|
| 128 |
\def\template#1{\list{}{\leftmargin=2em\itemindent-\leftmargin\def\makelabel##1{\hss##1}}% |
| 129 |
\item {\ttfamily\char`\\setbeamertemplate\char`\{\declare{#1}\char`\}}\oarg{options}\opt{\meta{args}}\par\topsep=0pt} |
| 130 |
\def\endtemplate{\endlist} |
| 131 |
\newenvironment{template*}[1]{\list{}{\leftmargin=2em\itemindent-\leftmargin\def\makelabel##1{\hss##1}}% |
| 132 |
\item \leavevmode\llap{\color{blue}\vtop |
| 133 |
to0pt{\llap{\textsc{appear-\!}}\vskip-3pt\llap{\textsc{ance}}\vss}\ \ }{\ttfamily\char`\\setbeamertemplate\char`\{\declare{#1}\char`\}}\oarg{options}\opt{\meta{args}}\par\topsep=0pt} |
| 134 |
{\endlist} |
| 135 |
|
| 136 |
\newenvironment{element}[4]{\list{}{\leftmargin=2em\itemindent-\leftmargin\def\makelabel##1{\hss##1}}% |
| 137 |
\item \textbf{\ifx#2\semiyes Parent Beamer-Template\else% |
| 138 |
Beamer\applier#2{-Template}\applier#3{\applier#2{/}-Color}\applier#4{\ifx#2\yes/\else\ifx#3\yes/\fi\fi |
| 139 |
-Font}\fi} |
| 140 |
{\ttfamily{\declare{#1}}}\par\topsep=0pt% |
| 141 |
\edef\parameters{% |
| 142 |
\ifx#2\semiyes parent template\else% |
| 143 |
\applier#2{template}\applier#3{\applier#2{/}color}\applier#4{\ifx#2\yes/\else\ifx#3\yes/\fi\fi font}\fi} |
| 144 |
\index{#1@\protect\texttt{#1} \parameters}% |
| 145 |
\applier#2{\index{Beamer templates!#1@\protect\texttt{#1}}}% |
| 146 |
\applier#3{\index{Beamer colors!#1@\protect\texttt{#1}}}% |
| 147 |
\applier#4{\index{Beamer fonts!#1@\protect\texttt{#1}}}% |
| 148 |
} |
| 149 |
{\endlist} |
| 150 |
|
| 151 |
\def\applier#1#2{\ifx#1\yes#2\fi} |
| 152 |
|
| 153 |
\def\templateoptions{\par |
| 154 |
The following template options are predefined: |
| 155 |
\begin{itemize}} |
| 156 |
\def\endtemplateoptions{\end{itemize}} |
| 157 |
|
| 158 |
\def\itemoption#1#2{\item {\texttt{[\declare{#1}]}}#2} |
| 159 |
|
| 160 |
%\def\itemoption#1{\item \declare{\texttt{#1}}% |
| 161 |
% \indexoption{#1}% |
| 162 |
%} |
| 163 |
|
| 164 |
%\def\indexoption#1{% |
| 165 |
% \index{#1@\protect\texttt{#1} option}% |
| 166 |
% \index{Options!#1@\protect\texttt{#1}}% |
| 167 |
%} |
| 168 |
|
| 169 |
\def\yes{\hbox to .6cm{\ding{51}\hfil}} |
| 170 |
\def\semiyes{\hbox to .6cm{(\ding{51})\hfil}} |
| 171 |
\def\no{\hbox to .6cm{\ding{55}\hfil}} |
| 172 |
|
| 173 |
\def\choosecol#1{}%\ifx#1\yes\color{green!50!black}\else\color{red!50!black}\fi} |
| 174 |
|
| 175 |
\def\templatefontcolor#1#2#3#4{% |
| 176 |
\item\declare{\texttt{#1}}\hfill% |
| 177 |
{\choosecol#2Template #2} {\choosecol#3Color #3} {\choosecol#4Font #4}\par} |
| 178 |
|
| 179 |
\def\fontparents#1{Font parents: \texttt{#1}\par} |
| 180 |
\def\colorparents#1{Color parents: \texttt{#1}\par} |
| 181 |
\def\colorfontparents#1{Color/font parents: \texttt{#1}\par} |
| 182 |
|
| 183 |
\def\templateinserts{\begin{itemize}} |
| 184 |
\def\endtemplateinserts{\end{itemize}} |
| 185 |
|
| 186 |
\def\iteminsert#1{\item {\texttt{\declare{\string#1}}}% |
| 187 |
\index{Inserts!\stripcommand#1@\protect\myprintcommand{\stripcommand#1}}} |
| 188 |
|
| 189 |
\newcommand\opt[1]{{\color{black!50!green}#1}} |
| 190 |
\renewcommand\oarg[1]{\opt{{\ttfamily[}\meta{#1}{\ttfamily]}}} |
| 191 |
\newcommand\ooarg[1]{{\ttfamily[}\meta{#1}{\ttfamily]}} |
| 192 |
\newcommand\sarg[1]{\opt{{\ttfamily\char`\<}\meta{#1}{\ttfamily\char`\>}}} |
| 193 |
\newcommand\ssarg[1]{{\ttfamily\char`\<}\meta{#1}{\ttfamily\char`\>}} |
| 194 |
|
| 195 |
%\def\opt{\afterassignment\translatormanualopt\let\next=} |
| 196 |
\def\translatormanualopt{\ifx\next\bgroup\bgroup\color{black!50!green}\else{\color{black!50!green}\next}\fi} |
| 197 |
|
| 198 |
\newcommand{\beamernote}{\par\smallskip\noindent\llap{\color{blue}\vtop to0pt{\llap{\textsc{presen-\!}}\vskip-3pt\llap{\textsc{tation}}\vss}\ \ }} |
| 199 |
\newcommand{\articlenote}{\par\smallskip\noindent\llap{\color{blue}\textsc{article}\ \ }} |
| 200 |
\newcommand{\appearancenote}{\par\smallskip\noindent\appearancenotetext} |
| 201 |
|
| 202 |
\def\appearancenotetext{\llap{\color{blue}\vtop |
| 203 |
to0pt{\llap{\textsc{appear-\!}}\vskip-3pt\llap{\textsc{ance}}\vss}\ \ }} |
| 204 |
|
| 205 |
\newcommand{\templatenote}{\par\smallskip\noindent\llap{\color{blue}\textsc{template}\ \ }} |
| 206 |
\newcommand{\colornote}{\par\smallskip\noindent\llap{\color{blue}\textsc{color}\ \ }} |
| 207 |
\newcommand{\fontnote}{\par\smallskip\noindent\llap{\color{blue}\textsc{font}\ \ }} |
| 208 |
|
| 209 |
\newcommand{\genericthemeexample}[2][]{% |
| 210 |
\smallskip\par\noindent |
| 211 |
\includegraphics[width=.45\textwidth,page=1]{beamerug#2}\qquad\includegraphics[width=.45\textwidth,page=2]{beamerug#2} |
| 212 |
\smallskip\par} |
| 213 |
\newenvironment{themeexample}[2][] |
| 214 |
{\begin{theme}{usetheme}{{#2}#1}{presentation theme}{Presentation themes} |
| 215 |
\example\genericthemeexample{theme#2} |
| 216 |
} |
| 217 |
{\end{theme}} |
| 218 |
\newenvironment{innerthemeexample}[2][] |
| 219 |
{\begin{theme}{useinnertheme}{{#2}#1}{inner theme}{Inner themes} |
| 220 |
\example\genericthemeexample{innertheme#2} |
| 221 |
} |
| 222 |
{\end{theme}} |
| 223 |
\newenvironment{outerthemeexample}[2][] |
| 224 |
{\begin{theme}{useoutertheme}{{#2}#1}{outer theme}{Outer themes} |
| 225 |
\example\genericthemeexample{outertheme#2} |
| 226 |
} |
| 227 |
{\end{theme}} |
| 228 |
\newenvironment{colorthemeexample}[2][] |
| 229 |
{\begin{theme}{usecolortheme}{{#2}#1}{color theme}{Color themes} |
| 230 |
\example\genericthemeexample{colortheme#2} |
| 231 |
} |
| 232 |
{\end{theme}} |
| 233 |
\newenvironment{fontthemeexample}[2][] |
| 234 |
{\begin{theme}{usefonttheme}{{#2}#1}{font theme}{Font themes} |
| 235 |
\example\genericthemeexample{fonttheme#2} |
| 236 |
} |
| 237 |
{\end{theme}} |
| 238 |
\newenvironment{fontthemeexample*}[2][] |
| 239 |
{\begin{theme}{usefonttheme}{{#2}#1}{font theme}{Font themes}} |
| 240 |
{\end{theme}} |
| 241 |
|
| 242 |
\def\partname{Part} |
| 243 |
|
| 244 |
\colorlet{examplefill}{yellow!80!black} |
| 245 |
\definecolor{graphicbackground}{rgb}{0.96,0.96,0.8} |
| 246 |
\definecolor{codebackground}{rgb}{0.8,0.8,1} |
| 247 |
|
| 248 |
\newenvironment{translatormanualentry}{\list{}{\leftmargin=2em\itemindent-\leftmargin\def\makelabel##1{\hss##1}}}{\endlist} |
| 249 |
\newcommand\translatormanualentryheadline[1]{\itemsep=0pt\parskip=0pt\item\strut#1\par\topsep=0pt} |
| 250 |
\newcommand\translatormanualbody{\parskip3pt} |
| 251 |
|
| 252 |
|
| 253 |
%\newenvironment{command}[1]{ |
| 254 |
% \begin{translatormanualentry} |
| 255 |
% \extractcommand#1\@@ |
| 256 |
% \translatormanualbody |
| 257 |
%} |
| 258 |
%{ |
| 259 |
% \end{translatormanualentry} |
| 260 |
%} |
| 261 |
|
| 262 |
%\def\extractcommand#1#2\@@{% |
| 263 |
% \translatormanualentryheadline{\declare{\texttt{\string#1}}#2}% |
| 264 |
% \removeats{#1}% |
| 265 |
% \index{\strippedat @\protect\myprintcommand{\strippedat}}} |
| 266 |
|
| 267 |
|
| 268 |
\renewenvironment{environment}[1]{ |
| 269 |
\begin{translatormanualentry} |
| 270 |
\extractenvironement#1\@@ |
| 271 |
\translatormanualbody |
| 272 |
} |
| 273 |
{ |
| 274 |
\end{translatormanualentry} |
| 275 |
} |
| 276 |
|
| 277 |
\def\extractenvironement#1#2\@@{% |
| 278 |
\translatormanualentryheadline{{\ttfamily\char`\\begin\char`\{\declare{#1}\char`\}}#2}% |
| 279 |
\translatormanualentryheadline{{\ttfamily\ \ }\meta{environment contents}}% |
| 280 |
\translatormanualentryheadline{{\ttfamily\char`\\end\char`\{\declare{#1}\char`\}}}% |
| 281 |
\index{#1@\protect\texttt{#1} environment}% |
| 282 |
\index{Environments!#1@\protect\texttt{#1}}} |
| 283 |
|
| 284 |
|
| 285 |
|
| 286 |
%\newenvironment{package}[1]{ |
| 287 |
% \begin{translatormanualentry} |
| 288 |
% \translatormanualentryheadline{{\ttfamily\char`\\usepackage\opt{[\meta{options}]}\char`\{\declare{#1}\char`\}}} |
| 289 |
% \index{#1@\protect\texttt{#1} package}% |
| 290 |
% \index{Packages and files!#1@\protect\texttt{#1}}% |
| 291 |
% \translatormanualbody |
| 292 |
%} |
| 293 |
%{ |
| 294 |
% \end{translatormanualentry} |
| 295 |
%} |
| 296 |
|
| 297 |
|
| 298 |
|
| 299 |
\newenvironment{filedescription}[1]{ |
| 300 |
\begin{translatormanualentry} |
| 301 |
\translatormanualentryheadline{File {\ttfamily\declare{#1}}}% |
| 302 |
\index{#1@\protect\texttt{#1} file}% |
| 303 |
\index{Packages and files!#1@\protect\texttt{#1}}% |
| 304 |
\translatormanualbody |
| 305 |
} |
| 306 |
{ |
| 307 |
\end{translatormanualentry} |
| 308 |
} |
| 309 |
|
| 310 |
|
| 311 |
\newenvironment{packageoption}[1]{ |
| 312 |
\begin{translatormanualentry} |
| 313 |
\translatormanualentryheadline{{\ttfamily\char`\\usepackage[\declare{#1}]\char`\{translator\char`\}}} |
| 314 |
\index{#1@\protect\texttt{#1} package option}% |
| 315 |
\index{Package options for \textsc{translator}!#1@\protect\texttt{#1}}% |
| 316 |
\translatormanualbody |
| 317 |
} |
| 318 |
{ |
| 319 |
\end{translatormanualentry} |
| 320 |
} |
| 321 |
|
| 322 |
\makeatletter |
| 323 |
\def\index@prologue{\let\toclevel@section\toclevel@part\section*{Index}\addcontentsline{toc}{section}{Index} |
| 324 |
This index only contains automatically generated entries, sorry. A good |
| 325 |
index should also contain carefully selected keywords. |
| 326 |
\bigskip |
| 327 |
} |
| 328 |
\c@IndexColumns=2 |
| 329 |
\def\theindex{\@restonecoltrue |
| 330 |
\columnseprule \z@ \columnsep 35\p@ |
| 331 |
\twocolumn[\index@prologue]% |
| 332 |
\parindent -30pt |
| 333 |
\columnsep 15pt |
| 334 |
\parskip 0pt plus 1pt |
| 335 |
\leftskip 30pt |
| 336 |
\rightskip 0pt plus 2cm |
| 337 |
\small |
| 338 |
\def\@idxitem{\par}% |
| 339 |
\let\item\@idxitem \ignorespaces} |
| 340 |
\def\endtheindex{\onecolumn} |
| 341 |
\def\noindexing{\let\index=\@gobble} |
| 342 |
|
| 343 |
\makeatother |