summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/beamer-contrib/hackthefootline/hackthefootline.sty
blob: 14d83c28148b6aa547023f8b273d66e09e3cd55c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
%%	This is file 'hackthefootline.sty', Version 2018-01-29
%%	Copyright 2017-18 Sebastian Friedl <sfr682k@t-online.de>
%% 
%%	This work may be distributed and/or modified under the conditions of the LaTeX Project
%%	Public License, either version 1.3c of this license or (at your option) any later version.
%%	The latest version of this license is available at
%%		http://www.latex-project.org/lppl.txt
%%	and version 1.3c or later is part of all distributions of LaTeX version 2008-05-04 or later
%%
%%	This work has the LPPL maintenace status 'maintained'.
%%	The current maintainer of this work is Sebastian Friedl.
%%
%%	This work consists of the files hackthefootline.sty, hackthefootline-examples.tex and
%%	hackthefootline-doc.tex
%%
%%	-------------------------------------------------------------------------------------------
%%
%%	The hackthefootline package is a tool providing arbitrary footline selection and
%%	configuration for LaTeX beamer's standard themes (it may work with other themes as well)
%%
%%	-------------------------------------------------------------------------------------------
%%
%%	Please report bugs and other problems as well as suggestions for improvements
%%	to my email address (sfr682k@t-online.de).
%%
%%	-------------------------------------------------------------------------------------------
%%
%%	Acknowledgement:
%%	The basic layout of the two- and three-column footline is based on the original LaTeX
%%	beamer split and infolines outer themes written by Till Tantau.
%%
%%	-------------------------------------------------------------------------------------------


\ProvidesPackage{hackthefootline}[2018/01/29 hackthefootline: Arbitrary footline selection and configuration for LaTeX beamer's standard themes]
\mode<presentation>

\RequirePackage{ifthen}
\RequirePackage{pgfkeys}

\newcommand{\htfprintmessage}{%
	\typeout{}
	\typeout{========================================}
	\typeout{THE FOOTLINE HAS BEEN TAKEN OVER}
	\typeout{by the hackthefootline package}
	\typeout{Version 2018/01/29}
	\typeout{}
	\typeout{(c) 2017-18 Sebastian Friedl}
	\typeout{Licensed under LPPL 1.3c or later}
	\typeout{========================================}
	\typeout{}}



% PACKAGE OPTIONS AND VARIABLES -- INCLUDES AUXILIARY STUFF -------------------------------------------------------------------------------------

\DeclareOptionBeamer{onecol}{%
	\htfconfig{title=short, authinst=both, date=none, framenrs=fraction, atsep=colon}%
	\AtBeginDocument{\htfconfig{cols=one}}\htfprintmessage}
\DeclareOptionBeamer{twocols}{%
	\htfconfig{title=short, authinst=onlyauthor, date=none, framenrs=none, atsep=colon}%
	\AtBeginDocument{\htfconfig{cols=two}}\htfprintmessage}
\DeclareOptionBeamer{threecols}{%
	\htfconfig{title=short, authinst=instpths, date=short, framenrs=fraction, atsep=colon}%
	\AtBeginDocument{\htfconfig{cols=three}}\htfprintmessage}

\newif\ifbeamer@htfcountappendixframes
\beamer@htfcountappendixframesfalse
\DeclareOptionBeamer{countappendixframes}{\beamer@htfcountappendixframestrue}

\newif\ifbeamer@htffunnystuff
\beamer@htffunnystufftrue
\DeclareOptionBeamer{nofun}{\beamer@htffunnystufffalse}



% Check for author and/or institute when inserting the separation symbol?
\newif\ifbeamer@htfcheckauth
\newif\ifbeamer@htfcheckinst
\newif\ifbeamer@htfinsertsep
\newcommand{\htfcheckauthor}{\beamer@htfcheckauthtrue\beamer@htfcheckinstfalse}
\newcommand{\htfcheckinstit}{\beamer@htfcheckauthfalse\beamer@htfcheckinsttrue}
\newcommand{\htfcheckboth}{\beamer@htfcheckauthtrue\beamer@htfcheckinsttrue}
\newcommand{\htfchecknone}{\beamer@htfcheckauthfalse\beamer@htfcheckinstfalse}

% Variables
\newif\ifbeamer@htfnotitle
\newif\ifbeamer@htfshowframenrs

% Own replacement for \beamer@inappendix; required for compatibility reasons
\newif\ifbeamer@htfinsideappendix
\beamer@htfinsideappendixfalse



% TEMPLATES -------------------------------------------------------------------------------------------------------------------------------------
% Please **always** use \defbeamertemplate **without asterisk**!!

% Title
\defbeamertemplate{htf-title}{none}{}
\defbeamertemplate{htf-title}{short}{\insertshorttitle}
\defbeamertemplate{htf-title}{long}{\inserttitle}

% Author/Institute
\defbeamertemplate{htf-authinst}{none}{}
\defbeamertemplate{htf-authinst}{onlyauth}{\insertshortauthor}
\defbeamertemplate{htf-authinst}{onlyinst}{\insertshortinstitute}
\defbeamertemplate{htf-authinst}{instpths}{\insertshortauthor\ifx\beamer@shortinstitute\@empty\else~~(\insertshortinstitute)\fi}
\defbeamertemplate{htf-authinst}{authpths}{\insertshortinstitute\ifx\beamer@shortauthor\@empty\else~~(\insertshortauthor)\fi}
\defbeamertemplate{htf-authinst}{bothcmma}{\insertshortauthor\ifx\beamer@shortinstitute\@empty\else,~\insertshortinstitute\fi}

% Date
\defbeamertemplate{htf-date}{none}{}
\defbeamertemplate{htf-date}{short}{\insertshortdate}
\defbeamertemplate{htf-date}{long}{\insertdate}

% Frame Numbers
\defbeamertemplate{htf-framenrs}{none}{}
\defbeamertemplate{htf-framenrs}{counter}{\insertframenumber}
\defbeamertemplate{htf-framenrs}{fraction}{%
	\ifbeamer@htfcountappendixframes{\insertframenumber~/~\inserttotalframenumber}%
	\else%
		\ifx\insertmainframenumber\@undefined{\insertframenumber~/~\inserttotalframenumber}%
		\else%
			% beamer v3.49 and later: detect whether appendix has been entered and use the required templates and use internal cmds
			\ifbeamer@htfinsideappendix{\insertframenumberinappendix~/~\insertappendixframenumber}%
			\else{\insertframenumber~/~\insertmainframenumber}%
			\fi%
		\fi%
	\fi}
\ifbeamer@htffunnystuff
	\defbeamertemplate{htf-framenrs}{percent}{\htfupdateprogress\nprounddigits{0}\lenprint[htfpercent]{\htfprogress}}
\fi


% Author-Title-Seperator
\defbeamertemplate{htf-atsep}{colon}{:~~~~}
\defbeamertemplate{htf-atsep}{comma}{,~}
\defbeamertemplate{htf-atsep}{space}{~~~~~~~~~~}



% FOOTLINE DEFINITIONS --------------------------------------------------------------------------------------------------------------------------

% Auxiliary length
\newlength{\htfframenrboxwidth}%

% No footline
\defbeamertemplate*{footline}{htf-none}{}

% One column
\defbeamertemplate{footline}{htf-onecol}{%
	\begin{beamercolorbox}[wd=\paperwidth,ht=2.25ex,dp=1ex,leftskip=.3cm,rightskip=.3cm]{palette primary}%
		\usebeamerfont{author in head/foot}%
		\usebeamertemplate{htf-authinst}%
		%
		\beamer@htfinsertsepfalse
		\ifbeamer@htfcheckauth\ifx\beamer@shortauthor\@empty\else\beamer@htfinsertseptrue\fi\fi
		\ifbeamer@htfcheckinst\ifx\beamer@shortinstitute\@empty\else\beamer@htfinsertseptrue\fi\fi
		%
		\ifx\beamer@shorttitle\@empty\beamer@htfinsertsepfalse\fi
		\ifbeamer@htfnotitle\beamer@htfinsertsepfalse\fi
		%
		\ifbeamer@htfinsertsep\usebeamertemplate{htf-atsep}\fi
		%
		\usebeamerfont{title in head/foot}
		\usebeamertemplate{htf-title}
		\hfill
		\usebeamercolor{date in head/foot}
		\usebeamertemplate{htf-date}
		%
		% Measure the largest required space when printing frame numbers
		\newbox\htfpagenumbox%
		\newbox\htfpercframenumbox%
		\setbox\htfpagenumbox=\hbox{0\inserttotalframenumber~/~0\inserttotalframenumber}%
		\setbox\htfpercframenumbox=\hbox{100\,\%}%
		\ifthenelse{\lengthtest{\wd\htfpagenumbox > \wd\htfpercframenumbox}}%
			{\setlength{\htfframenrboxwidth}{\wd\htfpagenumbox}}%
			{\setlength{\htfframenrboxwidth}{\wd\htfpercframenumbox}}%
		%
		\ifbeamer@htfshowframenrs \hspace{\htfframenrboxwidth}\hspace{.2\htfframenrboxwidth}~\fi%
	\end{beamercolorbox}%
	\ifbeamer@htfshowframenrs
		\vspace{-3.25ex}
		\hfill%
		\addtolength{\htfframenrboxwidth}{.3cm}%
		\addtolength{\htfframenrboxwidth}{2em}%
		\addtolength{\htfframenrboxwidth}{.5\htfframenrboxwidth}%
		\hspace{-1.3\htfframenrboxwidth}%
		\begin{beamercolorbox}[wd=1.3\htfframenrboxwidth,ht=2.25ex,dp=1ex,right,rightskip=.3cm]{bg}%
			% The color *has* to be set here; otherwise, the page number box will cover parts of the date
			\usebeamercolor[fg]{date in head/foot}\usebeamertemplate{htf-framenrs}
		\end{beamercolorbox}%
	\fi}

% Two columns
\defbeamertemplate{footline}{htf-twocols}{%
	\leavevmode%
	\hbox{\begin{beamercolorbox}[wd=.5\paperwidth,ht=2.5ex,dp=1.125ex,leftskip=.3cm,rightskip=.3cm]{author in head/foot}%
			\usebeamerfont{author in head/foot}\usebeamertemplate{htf-date}\hfill\usebeamertemplate{htf-authinst}
		\end{beamercolorbox}%
		\begin{beamercolorbox}[wd=.5\paperwidth,ht=2.5ex,dp=1.125ex,leftskip=.3cm,rightskip=.3cm]{title in head/foot}%
			\usebeamerfont{title in head/foot}\usebeamertemplate{htf-title}\hfill
			\ifbeamer@htfshowframenrs \usebeamertemplate{htf-framenrs} \fi
	\end{beamercolorbox}}%
	\vskip0pt}

% Three columns
\defbeamertemplate{footline}{htf-threecols}{
	\leavevmode%
	\hbox{%
		\begin{beamercolorbox}[wd=.333333\paperwidth,ht=2.25ex,dp=1ex,left,leftskip=.3cm]{author in head/foot}%
			\usebeamerfont{author in head/foot}\usebeamertemplate{htf-authinst}
		\end{beamercolorbox}%
		\begin{beamercolorbox}[wd=.333333\paperwidth,ht=2.25ex,dp=1ex,center]{title in head/foot}%
			\usebeamerfont{title in head/foot}\usebeamertemplate{htf-title}
		\end{beamercolorbox}%
		\begin{beamercolorbox}[wd=.333333\paperwidth,ht=2.25ex,dp=1ex,right,rightskip=.3cm]{date in head/foot}%
			\usebeamerfont{date in head/foot}\usebeamertemplate{htf-date}%
			%
			% Measure the largest required space when printing frame numbers
			\newbox\htfpagenumbox%
			\newbox\htfpercframenumbox%
			\setbox\htfpagenumbox=\hbox{0\inserttotalframenumber~/~0\inserttotalframenumber}%
			\setbox\htfpercframenumbox=\hbox{100\,\%}%
			\ifthenelse{\lengthtest{\wd\htfpagenumbox > \wd\htfpercframenumbox}}%
				{\setlength{\htfframenrboxwidth}{\wd\htfpagenumbox}}%
				{\setlength{\htfframenrboxwidth}{\wd\htfpercframenumbox}}%
			%
			\ifbeamer@htfshowframenrs \hspace{\htfframenrboxwidth}\hspace{.2\htfframenrboxwidth}~\fi%
		\end{beamercolorbox}%
		\ifbeamer@htfshowframenrs%
			\addtolength{\htfframenrboxwidth}{.3cm}%
			\addtolength{\htfframenrboxwidth}{2em}%
			\addtolength{\htfframenrboxwidth}{.5\htfframenrboxwidth}%
			\hspace{-1.3\htfframenrboxwidth}%
			\begin{beamercolorbox}[wd=1.3\htfframenrboxwidth,ht=2.25ex,dp=1ex,right,rightskip=.3cm]{bg}%
				% The color *has* to be set here; otherwise, the page number box will cover parts of the date
				\usebeamercolor[fg]{date in head/foot}\usebeamertemplate{htf-framenrs}
			\end{beamercolorbox}%
		\fi}%
	\vskip0pt}



% PGF KEYS STORING THE CURRENT FOOTLINE CONFIGURATION -------------------------------------------------------------------------------------------

\pgfkeys{/hackthefootline/cols/.cd,
	.is choice, .default=none,
	one/.code={\setbeamertemplate{footline}[htf-onecol]\beamer@calculateheadfoot},
	two/.code={\setbeamertemplate{footline}[htf-twocols]\beamer@calculateheadfoot},
	three/.code={\setbeamertemplate{footline}[htf-threecols]\beamer@calculateheadfoot},
	none/.code={%
		\htfconfig{framenrs=none}%
		\setbeamertemplate{footline}[htf-none]%
		\beamer@calculateheadfoot},
}

\pgfkeys{/hackthefootline/title/.cd,
	.is choice, .default=none,
	short/.code={\setbeamertemplate{htf-title}[short]\beamer@htfnotitlefalse},
	long/.code={\setbeamertemplate{htf-title}[long]\beamer@htfnotitlefalse},
	none/.code={\setbeamertemplate{htf-title}[none]\beamer@htfnotitletrue},
}

\pgfkeys{/hackthefootline/authinst/.cd,
	.is choice, .default=none,
	onlyauthor/.code={\setbeamertemplate{htf-authinst}[onlyauth]\htfcheckauthor},
	onlyinst/.code={\setbeamertemplate{htf-authinst}[onlyinst]\htfcheckinstit},
	instpths/.code={\setbeamertemplate{htf-authinst}[instpths]\htfcheckboth},
	authpths/.code={\setbeamertemplate{htf-authinst}[authpths]\htfcheckboth},
	both/.code={\setbeamertemplate{htf-authinst}[bothcmma]\htfcheckboth},
	none/.code={\setbeamertemplate{htf-authinst}[none]\htfchecknone},
}

\pgfkeys{/hackthefootline/date/.cd,
	.is choice, .default=none,
	short/.code={\setbeamertemplate{htf-date}[short]},
	long/.code={\setbeamertemplate{htf-date}[long]},
	none/.code={\setbeamertemplate{htf-date}[none]}
}

\pgfkeys{/hackthefootline/framenrs/.cd,
	.is choice, .default=none,
	counter/.code={\setbeamertemplate{htf-framenrs}[counter]\beamer@htfshowframenrstrue},
	fraction/.code={\setbeamertemplate{htf-framenrs}[fraction]\beamer@htfshowframenrstrue},
	percent/.code={%
		\ifbeamer@htffunnystuff    \setbeamertemplate{htf-framenrs}[percent]%
		\else                      \PackageError{hackthefootline}{Do not pass the nofun option when using percent frame numbers!}{}%
		\fi
		\beamer@htfshowframenrstrue%
	},
	none/.code={\setbeamertemplate{htf-framenrs}[none]\beamer@htfshowframenrsfalse},
}

\pgfkeys{/hackthefootline/atsep/.cd,
	.is choice, .default=colon,
	colon/.code={\setbeamertemplate{htf-atsep}[colon]},
	comma/.code={\setbeamertemplate{htf-atsep}[comma]},
	space/.code={\setbeamertemplate{htf-atsep}[space]},
}

% Configruation Command
\newcommand{\htfconfig}[1]{\pgfkeys{/hackthefootline/.cd,#1}}



% FORMER CONFIGURATION COMMANDS (OBSOLETE!!) ----------------------------------------------------------------------------------------------------

% These configuration commands have been introduced in the initial release of this package and were implemented very ineffective.
% Since using pgfkeys for switching the templates, the \htfconfig command has been introduced for easier footline configuration.
% All commands defined in this section obsolete now and should be replaced by \htfconfig, since they may be removed soon.

% Obsolete commands for switching templates
\newcommand{\htfnotitle}{\htfObsoleteCMD\htfconfig{title=none}}
\newcommand{\htfshorttitle}{\htfObsoleteCMD\htfconfig{title=short}}
\newcommand{\htflongtitle}{\htfObsoleteCMD\htfconfig{title=none}}
\newcommand{\htfnoauthinst}{\htfObsoleteCMD\htfconfig{authinst=none}}
\newcommand{\htfonlyauthor}{\htfObsoleteCMD\htfconfig{authinst=onlyauthor}}
\newcommand{\htfonlyinstitute}{\htfObsoleteCMD\htfconfig{authinst=onlyinst}}
\newcommand{\htfinstitutepths}{\htfObsoleteCMD\htfconfig{authinst=instpths}}
\newcommand{\htfauthorpths}{\htfObsoleteCMD\htfconfig{authinst=authpths}}
\newcommand{\htfauthinst}{\htfObsoleteCMD\htfconfig{authinst=both}}
\newcommand{\htfnodate}{\htfObsoleteCMD\htfconfig{date=none}}
\newcommand{\htfshortdate}{\htfObsoleteCMD\htfconfig{date=short}}
\newcommand{\htflongdate}{\htfObsoleteCMD\htfconfig{date=long}}
\newcommand{\htfnoframenrs}{\htfObsoleteCMD\htfconfig{framenrs=none}}
\newcommand{\htfcounterframenrs}{\htfObsoleteCMD\htfconfig{framenrs=counter}}
\newcommand{\htffractionframenrs}{\htfObsoleteCMD\htfconfig{framenrs=fraction}}
\newcommand{\htfpercentframenrs}{\htfObsoleteCMD\htfconfig{framenrs=percent}}
\newcommand{\htfcolonsep}{\htfObsoleteCMD\htfconfig{atsep=colon}}
\newcommand{\htfcommasep}{\htfObsoleteCMD\htfconfig{atsep=comma}}
\newcommand{\htfsepspace}{\htfObsoleteCMD\htfconfig{atsep=space}}

% This command was used to apply changes, but is useless now.
\newcommand{\hackthefootline}{%
	\PackageWarning{hackthefootline}{%
		The \protect\hackthefootline command is obsolete and may be removed soon. Consider using \noexpand\htfconfig instead}}

% A shorthand for printing an "this command is obsolete" warning
\newcommand{\htfObsoleteCMD}{%
	\PackageWarning{hackthefootline}{%
		The old \noexpand\htf... commands are obsolete and may be removed soon. Consider using \noexpand\htfconfig instead}
}



% PROCESS OPTIONS -------------------------------------------------------------------------------------------------------------------------------
% This *has* to be done here, otherwise mysterious things will happen ...
% and too many packages will be required ...

\ProcessOptionsBeamer



% ACTIONS FOR NOT COUNTING APPENDIX FRAMES ------------------------------------------------------------------------------------------------------

\ifbeamer@htfcountappendixframes\else
	% Required packages
	\ifx\insertmainframenumber\@undefined\RequirePackage{appendixnumberbeamer}\fi % only beamer v3.48 and earlier
	\RequirePackage{etoolbox}
	
	% Removes frame numbers for appendix slides
	\apptocmd{\appendix}{%
		\htfconfig{framenrs=none}
		\beamer@htfinsideappendixtrue
	}{}{}
\fi



% REQUIREMENTS FOR SOME "FUNNY STUFF" -----------------------------------------------------------------------------------------------------------

\ifbeamer@htffunnystuff
	% Frame numbering in %: requirements, package settings, variables, commands
	\RequirePackage{calc}
	\RequirePackage[addmissingzero,autolanguage,nosepfour]{numprint}
	\npdefunit{htfpercent}{\%}{1}
	\newlength{\htfprogress}
	\def\htfupdateprogress{%
		\ifbeamer@htfcountappendixframes\setlength{\htfprogress}{100pt*\ratio{\insertframenumber pt}{\inserttotalframenumber pt}}%
		\else%
			\ifx\insertmainframenumber\@undefined\setlength{\htfprogress}{100pt*\ratio{\insertframenumber pt}{\inserttotalframenumber pt}}%
			\else%
				\ifbeamer@htfinsideappendix\setlength{\htfprogress}{100pt*\ratio{\insertframenumberinappendix pt}{\insertappendixframenumber pt}}%
				\else\setlength{\htfprogress}{100pt*\ratio{\insertframenumber pt}{\insertmainframenumber pt}}%
				\fi%
			\fi%
		\fi}
\fi



% END OF FILE -----------------------------------------------------------------------------------------------------------------------------------

\mode<all>
\endinput