tClean up and improve scibeamer documentation - scibeamer - quickly create scie… | |
git clone git://src.adamsgaard.dk/scibeamer | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
commit c986c7ebd64da71a1fa9c8ea199be00436018717 | |
parent 3b6f3b57e44edfe31389e23d7e1dbdadbaf053aa | |
Author: Anders Damsgaard <[email protected]> | |
Date: Thu, 19 Sep 2019 11:59:12 +0200 | |
Clean up and improve scibeamer documentation | |
Diffstat: | |
M scibeamer.sty | 97 +++++++++--------------------… | |
M template.pdf | 0 | |
2 files changed, 27 insertions(+), 70 deletions(-) | |
--- | |
diff --git a/scibeamer.sty b/scibeamer.sty | |
t@@ -12,20 +12,16 @@ | |
%% Citation commands | |
-% \fcite{arg1}{arg2} | |
-% Add a citation as a small footnote in the current slide. `arg1` will be | |
-% stylized as regular text, followed by `arg2` in emphasized style. | |
-% Example: \fcite{Author et al.\ 1999}{Journal} | |
+% \fcite{<author and year>}{<journal>} | |
+% Add a citation as a small footnote in the current slide. Author and year wil… | |
\newcommand{\fcite}[2]{% | |
\let\thefootnote\relax\footnotetext{\footnotesize{#1 \emph{#2}}}% | |
} | |
- | |
%% Frame templates | |
-% \titleframe{arg1} | |
+% \titleframe{<title text>} | |
% Add a frame with large centered text. | |
-% Example: \titleframe{Conclusions} | |
\newcommand{\titleframe}[1]{% | |
\begin{frame} | |
\begin{center} | |
t@@ -34,10 +30,8 @@ | |
\end{frame} | |
} | |
-% \plainimageframe{arg1}{arg2} | |
-% Add a plain frame with a single full-frame image `arg1`, scaled relative to | |
-% frame width multiplied by `arg2`. | |
-% Example: \plainimageframe{image.png}{1.0} | |
+% \plainimageframe{<image file>}{<scale factor>} | |
+% Add a plain frame with a single full-frame image, scaled relative to frame w… | |
\newcommand{\plainimageframe}[2]{% | |
\begin{frame}[plain] | |
\begin{center} | |
t@@ -47,10 +41,8 @@ | |
\end{frame} | |
} | |
-% \plainimageframeheight{arg1}{arg2} | |
-% Add a plain frame with a single full-frame image `arg1`, scaled relative to | |
-% frame height multiplied by `arg2`. | |
-% Example: \plainimageframeheight{image.png}{1.0} | |
+% \plainimageframeheight{<image file>}{<scale factor>} | |
+% Add a plain frame with a single full-frame image, scaled relative to frame h… | |
\newcommand{\plainimageframeheight}[2]{% | |
\begin{frame}[plain] | |
\begin{center} | |
t@@ -60,10 +52,8 @@ | |
\end{frame} | |
} | |
-% \imageframe{arg1}{arg2}{arg3} | |
-% Add a frame with title `arg1`, containing a single full-frame image `arg2`, | |
-% scaled relative to frame width multiplied by `arg3`. | |
-% Example: \imageframe{An example frame}{image.png}{1.0} | |
+% \imageframe{<title>}{<image file>}{<scale factor>} | |
+% Add a frame with title, containing a single full-frame image, scaled relativ… | |
\newcommand{\imageframe}[3]{% | |
\begin{frame}{#1} | |
\begin{center} | |
t@@ -73,10 +63,8 @@ | |
\end{frame} | |
} | |
-% \imageframeheight{arg1}{arg2}{arg3} | |
-% Add a frame with title `arg1`, containing a single full-frame image `arg2`, | |
-% scaled relative to frame height multiplied by `arg3`. | |
-% Example: \imageframeheight{An example frame}{image.png}{1.0} | |
+% \imageframeheight{<title>}{<image file>}{<scale factor>} | |
+% Add a frame with title, containing a single full-frame image, scaled relativ… | |
\newcommand{\imageframeheight}[3]{% | |
\begin{frame}{#1} | |
\begin{center} | |
t@@ -86,10 +74,8 @@ | |
\end{frame} | |
} | |
-% \plainimageframe{arg1}{arg2} | |
-% Add a frame with title `arg1`, containing a single full-frame image `arg2` | |
-% that is not scaled relative to the frame size. | |
-% Example: \plainimageframe{An example frame}{image.png} | |
+% \plainimageframe{<title>}{<image file>} | |
+% Add a frame with title, containing a single full-frame image that is not sca… | |
\newcommand{\imageframenoscale}[2]{% | |
\begin{frame}{#1} | |
\begin{center} | |
t@@ -99,11 +85,8 @@ | |
\end{frame} | |
} | |
-% \imageframecite{arg1}{arg2}{arg3}{arg4}{arg5} | |
-% Add a frame with title `arg1`, containing a single image `arg2`, scaled | |
-% relative to frame width multiplied by `arg3`, including a citation to | |
-% publication authored by `arg4`, published in `arg5`. | |
-% Example: \imageframecite{An example title}{image.pdf}{1.0}{Author year}{Jour… | |
+% \imageframecite{<title>}{<image file>}{<scale factor>}{<author and year>}{<j… | |
+% Add a frame with title, containing a single image, scaled relative to frame … | |
\newcommand{\imageframecite}[5]{% | |
\begin{frame}{#1} | |
\begin{center} | |
t@@ -114,11 +97,8 @@ | |
\end{frame} | |
} | |
-% \imageframeciteheight{arg1}{arg2}{arg3}{arg4}{arg5} | |
-% Add a frame with title `arg1`, containing a single image `arg2`, scaled | |
-% relative to frame height multiplied by `arg3`, including a citation to | |
-% publication authored by `arg4`, published in `arg5`. | |
-% Example: \imageframecite{An example title}{image.pdf}{1.0}{Author year}{Jour… | |
+% \imageframeciteheight{<title>}{<image file>}{<scale factor>}{<author and yea… | |
+% Add a frame with title, containing a single image, scaled relative to frame … | |
\newcommand{\imageframeciteheight}[5]{% | |
\begin{frame}{#1} | |
\begin{center} | |
t@@ -129,10 +109,8 @@ | |
\end{frame} | |
} | |
-% \plainmovieframe{arg1}{arg2} | |
-% Add a plain frame with a single full-frame movie `arg1`, with a placeholder | |
-% text `arg2`. | |
-% Example: \plainmovieframe{movie.mp4}{Example movie clip} | |
+% \plainmovieframe{<movie file>}{<placeholder text>} | |
+% Add a plain frame with a single full-frame movie accessible through placehol… | |
\newcommand{\plainmovieframe}[3]{% | |
\begin{frame}[plain] | |
\begin{center} | |
t@@ -143,12 +121,8 @@ | |
\end{frame} | |
} | |
-% \movieframe{arg1}{arg2}{arg3} | |
-% Add a frame titled `arg1`, a single full-frame movie `arg2`, with a | |
-% placeholder text `arg3` | |
-% NOTE: The movie file *must* reside in the same folder as the PDF, and file | |
-% names with underscore characters cannot be used. | |
-% Example: \movieframe{Example movie}{movie.mp4}{movie.png} | |
+% \movieframe{<title>}{<movie file>}{<placeholder text>} | |
+% Add a titled frame with a single full-frame movie accessible through placeho… | |
\newcommand{\movieframe}[3]{% | |
\begin{frame}{#1} | |
\begin{center} | |
t@@ -158,10 +132,10 @@ | |
\end{frame} | |
} | |
-% \plainmovieframepreview{arg1}{arg2}{arg3} | |
-% Add a plain frame with a single full-frame movie `arg1`, with a preview imag… | |
+% \movieframepreview{<title>}{<movie file>}{<preview image>} | |
+% Add a titled frame with a single full-frame movie accessible through a previ… | |
\newcommand{\movieframepreview}[3]{% | |
-\begin{frame}{#1}[plain] | |
+\begin{frame}{#1} | |
\begin{center} | |
\centering | |
\href{#2}{% | |
t@@ -172,27 +146,10 @@ | |
\end{frame} | |
} | |
-% `arg2`, with multimedia options `arg3` (externalviewer always set) | |
-% NOTE: The movie file *must* reside in the same folder as the PDF, and file | |
-% names with underscore characters cannot be used. | |
-% Example: \plainmovieframepreview{movie.mp4}{movie.png}{} | |
+% \plainmovieframepreview{<title>}{<movie file>}{<preview image>} | |
+% Add a plain titled frame with a single full-frame movie accessible through a… | |
\newcommand{\plainmovieframepreview}[3]{% | |
-\begin{frame}[plain] | |
- \begin{center} | |
- \centering | |
- \movie[externalviewer,#3]{\includegraphics[height=0.75\texthei… | |
- \footnotesize{\texttt{#1}} | |
- \end{center} | |
-\end{frame} | |
-} | |
- | |
-% \movieframepreview{arg1}{arg2}{arg3}{arg4} | |
-% Add a frame titled `arg1` with a single full-frame movie `arg2`, a preview | |
-% image `arg3` | |
-% NOTE: The movie file *must* reside in the same folder as the PDF. | |
-% Example: \movieframepreview{An example movie}{movie.mp4}{movie.png}{} | |
-\newcommand{\movieframepreview}[3]{% | |
-\begin{frame}{#1} | |
+\begin{frame}{#1}[plain] | |
\begin{center} | |
\centering | |
\href{#2}{% | |
diff --git a/template.pdf b/template.pdf | |
Binary files differ. |