Minor fixes and added documentation

beamerthemem.dtx

@@ -44,10 +44,10 @@
 %
 % \subsection{Options}
 %
-% \begin{macro}{\setmetropolis}
+% \begin{macro}{\metropolisset}
 % First of all we define a macro for the user to set options.
 %    \begin{macrocode}
-\newcommand{\setmetropolis}[1]{\pgfkeys{/metropolis/.cd,#1}}
+\newcommand{\metropolisset}[1]{\pgfkeys{/metropolis/.cd,#1}}
 %    \end{macrocode}
 % \end{macro}
 %

mtheme.dtx

@@ -13,7 +13,7 @@
 \documentclass{ltxdoc}
 %\OnlyDescription
 
-\usepackage[parfill]{parskip}
+\usepackage{parskip}
 \usepackage{setspace}
 \onehalfspacing
 
@@ -62,7 +62,7 @@
   xrightmargin=0em,
   aboveskip=1em,
   belowskip=1em,
-  morekeywords={usetheme,institute,maketitle,@metropolis@titleformat,plain,setbeamercolor},
+  morekeywords={usetheme,institute,maketitle,@metropolis@titleformat,plain,setbeamercolor,metropolisset},
 }
 \lstMakeShortInline|
 
@@ -72,6 +72,13 @@
             pagecolor=mLightBrown,
             urlcolor=mLightBrown]{hyperref}
 
+\newcommand{\DescribeOption}[4]{
+  \noindent\DescribeMacro{#1}\textit{\textbf{\textcolor{mLightGreen}{#2}}}\dotfill\,#3\par
+  \begingroup
+  \leftskip2em #4\par
+  \endgroup
+}
+
 \GetFileInfo{beamerthemem.dtx}
 \title{Modern Beamer Presentations\\with the\\\textsc{mtheme} package}
 \author{Matthias Vogelgesang \\ \url{matthias.vogelgesang@gmail.com}}
@@ -82,21 +89,21 @@
 \maketitle
 
 \section{Introduction}
-Beamer is an awesome way to make presentations with LaTeX. But the stock themes
+Beamer is an awesome way to make presentations with LaTeX. But the stock
-do not necessarily look particularly nice and the custom themes often scream
+themes do not necessarily look particularly nice and the custom themes often
-“Beamer” at first sight. The goal of \textsc{mtheme} is to provide a modern
+scream “Beamer” at first sight. The goal of \textsc{mtheme} is to provide a
-Beamer theme with minimal visual noise. It provides section slides with a neat
+modern Beamer theme with minimal visual noise. It provides section slides with
-progress bar and It is intended to be used with
+a neat progress bar and it is intended to be used with
-\href{https://www.mozilla.org/en-US/styleguide/products/firefox-os/typeface/}{Fira
+\href{https://www.mozilla.org/en-US/styleguide/products/firefox-os/typeface/}
-Sans}, a gorgeous typeface commissioned by Mozilla and designed by
+{Fira Sans}, a gorgeous typeface commissioned by Mozilla and designed by
 \href{http://www.carrois.com/fira-3-1/}{Carrois}. Hence to get the best results
 you should have installed the Fira typeface and use XeTeX to typeset your
 slides. Nevertheless this is no hard dependency. The theme also works fine with
 pdfTeX and the Computer Modern typeface.
 
-The codebase is maintained on \href{https://github.com/matze/mtheme}{GitHub}. So
+The codebase is maintained on \href{https://github.com/matze/mtheme}{GitHub}.
-if you have issues, find mistakes in the manual or want to contribute – to make
+So if you have issues, find mistakes in the manual or want to contribute – to
-the theme even better – get in touch there.
+make the theme even better – get in touch there.
 
 
 \section{Getting Started}
@@ -182,38 +189,48 @@ minimal example of a Beamer presentation using the \textsc{mtheme}.
 
 \section{Customization}
 \subsection{Package options}
-The theme provides a number of options. To use any of the options below, call
+The theme provides a number of options. The options use a key=value interface.
-them when invoking \textsc{mtheme} in the preamble of the slides, i.e.
+So every option is controlled by a key its value. To use any of the options
+below, you can either provide a comma separated list of options when invoking
+\textsc{mtheme} in the preamble of the presentation,
 \begin{lstlisting}[numbers=none]
-\usetheme[<options>]{m}
+\usetheme[<key=value list>]{m}
+\end{lstlisting}
+or set them at any time with
+\begin{lstlisting}[numbers=none]
+\metropolisset[<key=value list>]
 \end{lstlisting}
 
-\noindent\DescribeMacro{usetitleprogressbar}
+\DescribeOption{sectionpage}{none, progressbar}{progressbar}{
-Adds a thin progress bar similar to the section progress bar underneath each
+  Adds a thin progress bar similar to the section progress bar underneath each frame title.
-frame title.\\
+}
 
-\noindent\DescribeMacro{blockbg}
+\DescribeOption{block}{transparent, fill}{transparent}{
-Adds background color to the blocks similar to other beamer themes.\\
+  This option controls the block background. It can either be filled with a
+  light grey or be transparent.
+}
 
-\noindent\DescribeMacro{nooffset}
+\DescribeOption{numbering}{none, counter, fraction}{counter}{
-By default, the \textsc{mtheme} adds |\vspace{2em}| after the frametitle to
+  In the bottom right corner of each frame the current frame number is
-center content vertically on the frame. This option removes this additional
+  displayed. This can be disabled or the total framenumber can be added
-space in order to get more content per slide.\\
+  additionally.
+}
 
-\noindent\DescribeMacro{nosectionslide}
+\DescribeOption{progressbar}{none, head}{none}{
-By default when using the |\section| command, a slide is created with just the
+  If enabled this option adds a thin progress bar similar to the sections
-title and the progress bar on it. This option prevents the creation of these
+  progress bar underneath each frame title.
-additional slides.\\
+}
 
-\noindent\DescribeMacro{usetotalslideindicator}
+\DescribeOption{frametitleoffset\\noframetitleoffset}{<dimension>}{2em}{
-By default, only the current page number is printed in the lower right corner.
+  The frametitle offset is an additional vertical space after the frame title
-This option changes the slide numbering format to |#current/#total|.\\
+  to center the content vertically on the frame. To remove this space entirely
+  the short option |noframetitleoffset| is defined.
+}
 
-\noindent\DescribeMacro{noslidenumbers}
+\DescribeOption{background}{dark, light}{light}{
-Omits slide numbers entirely.\\
+  This option defines whether the background shall be dark and the foreground
-
+  be light or vice versa.
-\noindent\DescribeMacro{darkcolors}
+}
-Makes the background dark and the foreground light.\\
 
 
 \subsection{Color Customization}