docs: update documentation

doc/moloch.tex

@@ -15,6 +15,7 @@
 \usepackage{parskip}
 \usepackage{setspace}
 \usepackage{xspace}
+\usepackage{xurl}
 \onehalfspacing
 
 \usepackage{enumitem}
@@ -82,9 +83,9 @@
 \usepackage{readprov}
 % \ReadPackageInfos{beamerthememoloch}
 
-\title{Modern Beamer Presentations with the \themename package}
+\title{Clean and Simple Beamer Presentations with the \themename package}
-\author{Matthias Vogelgesang \\ \url{matthias.vogelgesang@gmail.com}}
+\author{Johan Larsson \and Matthias Vogelgesang\footnote{Matthias wrote the original version of this manual for the Metropolis theme.}}
-\date{\fileversion~---~\filedate}
+\date{\today}
 
 \begin{document}
 
@@ -94,7 +95,8 @@
 
 \section{Introduction}
 
-Beamer is an awesome way to make presentations with LaTeX, but its theme
+
+Beamer is a great way to make presentations with LaTeX, but its theme
 selection is surprisingly sparse. The stock themes share an aesthetic that can
 be a little cluttered, while the few distinctive custom themes available are
 often specialized for a particular corporate or institutional brand.
@@ -104,12 +106,14 @@ for anyone to use. It tries to minimize noise and maximize space for content;
 the only visual flourish it offers is an (optional) progress bar added to each
 slide or to the section slides.
 
-\themename's codebase is maintained on \href{https://github.com/matze/mtheme}
+\themename's codebase is maintained at \url{https://github.com/jolars/moloch}.
-{GitHub}. If you have issues, find mistakes in the manual or want to help make
+If you have any issues, find mistakes in the manual or want to help make
-the theme even better, please get in touch there. The
+the theme even better, please get in touch there.
-\href{https://github.com/matze/mtheme/graphs/contributors}
-{full list of contributors} already contains over a dozen names!
 
+\themename is a fork of the popular Metroplis theme by Matthias Vogelgesang.
+The motivation for the fork was to fix some longstanding bugs in Metropolis
+and also simplify the codebase to make it easier to maintain and less
+fragile to changes in the underlying Beamer code.
 
 \section{Getting Started}
 
@@ -137,43 +141,19 @@ Mac\TeX\ on OS X also provides a graphical interface for |tlmgr| called
 For any other distribution please refer to its documentation on how to update
 your packages.
 
-\subsection{Installing from GitHub}
+\subsection{Installing from Source}
 
-If you want to use the cutting-edge development version of \themename, you can
+If you want to use the development version of \themename, you can
-install it manually. Like any \LaTeX\ package, this involves four easy steps:
+install it manually. You only need a recent \LaTeX\ distribution
+which includes \textbf{l3build}. Then simply follow the steps below.
 \begin{description}
-  \item[Download the source] with a |git clone| of the
+  \item[Download the source] with a |git clone| of
-        \href{https://github.com/matze/mtheme}{\themename repository} or as a
+        \url{https://github.com/jolars/moloch}
-        \href{https://github.com/matze/mtheme/archive/master.zip}{zip archive}
-        of the latest development version.
 
-  \item[Compile the style files] by running |make sty| inside the downloaded
+  \item[Install the package] by running |l3build install| inside the downloaded
-        directory. (Or run \LaTeX{} directly on |source/molochtheme.ins|.)
+        directory.
-
-  \item[Move the resulting |*.sty| files] to the folder containing your
-        presentation. To use \themename with many presentations, run
-        |make install| or move the |*.sty| files to a folder in your \TeX{} path
-        instead.
-
-  \item[Use the theme for your presentation] by declaring
-        |\usetheme{moloch}| in the preamble of your Beamer document.
 \end{description}
 
-\themename uses the Make build system to offer the following installation
-options for advanced users:
-
-\begin{description}
-  \item[|make sty|] builds the theme style files.
-  \item[|make doc|] builds this documentation manual.
-  \item[|make demo|] builds a demo presentation to test the features of
-        \themename.
-  \item[|make all|] builds the theme and manual.
-  \item[|make clean|] removes the files generated by |make all|.
-  \item[|make install|] installs the theme into your local texmf folder.
-  \item[|make uninstall|] removes the theme from your local texmf folder.
-\end{description}
-
-
 \subsection{A Minimal Example}
 
 The following code shows a minimal example of a Beamer presentation using
@@ -181,10 +161,10 @@ The following code shows a minimal example of a Beamer presentation using
 
 \begin{lstlisting}
 \documentclass{beamer}
-\usetheme{moloch}       % Use moloch theme
+\usetheme{moloch}
 \title{A minimal example}
 \date{\today}
-\author{Matthias Vogelgesang}
+\author{Johan Larsson}
 \institute{Centre for Modern Beamer Themes}
 \begin{document}
   \maketitle
@@ -213,7 +193,7 @@ To use this theme with \href{http://johnmacfarlane.net/pandoc/}{Pandoc}-based
 presentations, you can run the following command
 
 \begin{lstlisting}
-$ pandoc -t beamer --latex-engine=xelatex -V theme:moloch -o output.pdf input.md
+$ pandoc -t beamer -V theme:moloch -o output.pdf input.md
 \end{lstlisting}
 
 
@@ -228,7 +208,7 @@ of option-value pairs when loading \themename in the preamble:
 \usetheme[option1=value1, option2=value2, ...]{moloch}
 \end{lstlisting}
 
-Options can be changed at any time --- even mid-presentation! --- with the
+Options can be changed at any time---even mid-presentation---with the
 |\molochset| macro.
 \begin{lstlisting}
 \molochset{option1=newvalue1, option2=newvalue2, ...}
@@ -313,7 +293,7 @@ For low-light situations \themename it might be helpful to use the
 \subsubsection{Standout frames}
 
 The \themename inner theme offers a custom frame format with large, centered
-text and an inverted background --- perfect for focusing attention on
+text and an inverted background---perfect for focusing attention on
 single sentence or image. To use it, add the key |standout| to the frame:
 
 \begin{lstlisting}

src/beamerinnerthememoloch.dtx

@@ -56,8 +56,14 @@
   /moloch/inner/sectionpage/.cd,
   .is choice,
   none/.code=\moloch@disablesectionpage,
-  simple/.code={\moloch@enablesectionpage\setbeamertemplate{section page}[simple]},
+  simple/.code={%
-  progressbar/.code={\moloch@enablesectionpage\setbeamertemplate{section page}[progressbar]},
+      \moloch@enablesectionpage%
+      \setbeamertemplate{section page}[simple]%
+    },
+  progressbar/.code={%
+      \moloch@enablesectionpage%
+      \setbeamertemplate{section page}[progressbar]%
+    },
 }
 %    \end{macrocode}
 % \end{macro}
@@ -69,8 +75,14 @@
   /moloch/inner/subsectionpage/.cd,
   .is choice,
   none/.code=\moloch@disablesubsectionpage,
-  simple/.code={\moloch@enablesubsectionpage\setbeamertemplate{section page}[simple]},
+  simple/.code={%
-  progressbar/.code={\moloch@enablesubsectionpage\setbeamertemplate{section page}[progressbar]},
+      \moloch@enablesubsectionpage%
+      \setbeamertemplate{section page}[simple]%
+    },
+  progressbar/.code={%
+      \moloch@enablesubsectionpage%
+      \setbeamertemplate{section page}[progressbar]%
+    },
 }
 %    \end{macrocode}
 % \end{macro}
@@ -335,8 +347,14 @@
   }
   \tikzexternaldisable
   \begin{tikzpicture}
-    \fill[bg] (0,0) rectangle (\textwidth, \moloch@progressonsectionpage@linewidth);
+    \fill[bg]
-    \fill[fg] (0,0) rectangle (\moloch@progressonsectionpage, \moloch@progressonsectionpage@linewidth);
+    (0,0)
+    rectangle
+    (\textwidth, \moloch@progressonsectionpage@linewidth);
+    \fill[fg]
+    (0,0)
+    rectangle
+    (\moloch@progressonsectionpage, \moloch@progressonsectionpage@linewidth);
   \end{tikzpicture}
   \tikzexternalenable
 }
@@ -374,7 +392,9 @@
 \setbeamertemplate{footnote}{%
   \parindent 0em\noindent%
   \raggedright
-  \usebeamercolor{footnote}\hbox to 0.8em{\hfil\insertfootnotemark}\insertfootnotetext\par%
+  \usebeamercolor{footnote}%
+  \hbox to 0.8em{\hfil\insertfootnotemark}%
+  \insertfootnotetext\par%
 }
 %    \end{macrocode}
 %
@@ -412,6 +432,7 @@
 %
 % \themename offers a custom frame format with large, centered text and an
 % inverted background. To use it, add the key |standout| to the frame:
+%
 % |\begin{frame}[standout] ... \end{frame}|.
 %
 % \begin{macro}{standout}

src/beamerouterthememoloch.dtx

@@ -165,8 +165,14 @@
   \begin{beamercolorbox}[wd=\paperwidth]{progress bar in head/foot}
     \tikzexternaldisable
     \begin{tikzpicture}
-      \fill[bg] (0,0) rectangle (\paperwidth, \moloch@progressinheadfoot@linewidth);
+      \fill[bg]
-      \fill[fg] (0,0) rectangle (\moloch@progressinheadfoot, \moloch@progressinheadfoot@linewidth);
+      (0,0)
+      rectangle
+      (\paperwidth, \moloch@progressinheadfoot@linewidth);
+      \fill[fg]
+      (0,0)
+      rectangle
+      (\moloch@progressinheadfoot, \moloch@progressinheadfoot@linewidth);
     \end{tikzpicture}
     \tikzexternalenable
   \end{beamercolorbox}