mirror of https://github.com/matze/mtheme.git
moved missing information from README.md to mtheme.dtx
This commit is contained in:
Benjamin Weiss
parent
9b16634f89
commit
5fd4a8cbf4
119
README.md
119
README.md
|
|
@ -1,127 +1,14 @@
|
|||
## Beamer mtheme
|
||||
|
||||
The *mtheme* is a Beamer theme with minimal visual. The core design principles
|
||||
The *mtheme* is a Beamer theme with minimal visual noise. The core design principles
|
||||
of the theme were described in a [blog post](http://bloerg.net/2014/09/20/a-modern-beamer-theme.html).
|
||||
Not convinced? Have a look at the [demo slides](demo.pdf).
|
||||
|
||||
|
||||
|
||||
For further information take a look at the [manual](mtheme.pdf).
|
||||
|
||||
### Installation
|
||||
|
||||
To install the theme either run `make install` or copy the style files ending
|
||||
with `.sty` to the source files of your presentation. As of now, fonts, colors
|
||||
and the section indicator are hardcoded into the theme. For the demo you need
|
||||
|
||||
* XeLaTeX,
|
||||
* the [Fira Sans](https://github.com/mozilla/Fira) and Mono font and
|
||||
* TikZ.
|
||||
|
||||
Depending on the Linux distribution, the packaged name of Fira Sans might be
|
||||
`Fira Sans OT` instead of `Fira Sans`. In that case, you may have to edit
|
||||
`beamerfontthememetropolis.sty`. You may also need to install Fira Sans; see
|
||||
the `contrib/` directory for more. Users of Debian or Ubuntu can also install
|
||||
[this .deb package](https://launchpad.net/~edd/+archive/ubuntu/misc/+files/latex-mtheme_0.1.0vidid1_all.deb)
|
||||
containing the theme files as well as the Fira Sans font files.
|
||||
|
||||
To build the demo slides run
|
||||
|
||||
$ make
|
||||
|
||||
in the top-level directory.
|
||||
|
||||
To use this theme with [Pandoc](http://johnmacfarlane.net/pandoc/)-based
|
||||
presentations, you can run the following command
|
||||
|
||||
$ pandoc -t beamer --latex-engine=xelatex -V theme:m -o output.pdf input.md
|
||||
|
||||
|
||||
### Customization
|
||||
|
||||
#### Package options
|
||||
|
||||
To use any of options below, call them when invoking *mtheme* in the preamble of
|
||||
the slides, i.e.
|
||||
|
||||
```latex
|
||||
\usetheme[<options>]{m}
|
||||
```
|
||||
|
||||
* The `usetitleprogressbar` option adds a thin progress bar similar to the
|
||||
section progress bar underneath *each* frame title
|
||||
|
||||
|
||||
* In order to use `\cite`, `\ref` and similar commands in a frame title you have
|
||||
to protect the title. This can be done automatically with the
|
||||
`protectframetitle` option.
|
||||
* The `blockbg` option defines extra colors used in defining the blocks. The
|
||||
blocks then have a gray background similar to other beamer themes.
|
||||
* By default, this package adds `\vspace{2em}` after the frametitle to center
|
||||
content vertically on the frame. If using more content per slide, this can be
|
||||
turned off at the package-level by passing the `nooffset` option.
|
||||
* With option `nosectionslide`, no dedicated slide is produced when a new
|
||||
section starts. By default when using the `\section` command, a slide is
|
||||
created with just the title on it.
|
||||
* Option `usetotalslideindicator` creates slide numbering in lower right corner
|
||||
in following format: #current/#total. By default, just current page number is
|
||||
printed.
|
||||
* Option `noslidenumbers` omits slide numbers entirely.
|
||||
* Option `darkcolors` makes the background dark and the foreground light.
|
||||
|
||||
#### Color customization
|
||||
|
||||
The included `metropolis` color theme is used by default, but its colours can
|
||||
be easily changed to suit your tastes. All of the theme's styles are defined
|
||||
in terms of three beamer colors:
|
||||
|
||||
- `normal text` (dark fg, light bg)
|
||||
- `alerted text` (colored fg, should be visible against dark or light)
|
||||
- `example text` (colored fg, should be visible against dark or light)
|
||||
|
||||
An easy way to customize the theme is to redefine these colors using
|
||||
|
||||
```latex
|
||||
\setbeamercolor{ ... }{ fg= ... , bg= ... }
|
||||
```
|
||||
|
||||
in your preamble. For greater customization, you can redefine any of the other
|
||||
colors in `beamercolorthememetropolis`, including `progress bar`.
|
||||
|
||||
|
||||
#### Title formatting
|
||||
|
||||
The main title, section titles, and frame titles are all formatted according
|
||||
to the custom command `\mthemetitleformat`. By default, this is equivalent to
|
||||
`scshape` and sets the titles in small capitals, but you can change it in your
|
||||
preamble. For example:
|
||||
|
||||
```latex
|
||||
\renewcommand{\mthemetitleformat}{} % no small capitals
|
||||
\renewcommand{\mthemetitleformat}{\scshape\MakeLowercase} % all small capitals
|
||||
\renewcommand{\mthemetitleformat}{\MakeUppercase} % all capitals
|
||||
```
|
||||
|
||||
Note that `\MakeLowercase` and `\MakeUppercase` can have unexpected behaviour
|
||||
in math mode, are disabled when `protectframetitle` is used, and cause crashes
|
||||
when an unprotected frametitle appears on a slide with `allowframebreaks`.
|
||||
|
||||
|
||||
#### Commands
|
||||
|
||||
The `\plain{title=[]}{body}` command sets a slide in plain dark colors
|
||||
which can be useful to focus attentation on a single image.
|
||||
|
||||
|
||||
#### pgfplot styles
|
||||
|
||||
The beamer theme also contains pre-defined pgfplot styles. Use the `mlineplot`
|
||||
key to plot line data and `mbarplot` or `horizontal mbarplot` to plot bar
|
||||
charts.
|
||||
|
||||
|
||||
|
||||
|
||||
### License
|
||||
## License
|
||||
|
||||
The theme itself is licensed under a [Creative Commons Attribution-ShareAlike
|
||||
4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/). This
|
||||
|
|
|
|||
116
mtheme.dtx
116
mtheme.dtx
|
|
@ -87,9 +87,58 @@
|
|||
Beamer is an awesome way to make presentations with LaTeX. But the stock themes do not necessarily look particularly nice and the custom themes often scream “Beamer” at first sight. The goal of \textsc{mtheme} is to provide a modern Beamer theme with minimal visual noise. It provides section slides 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 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 if you have issues, find mistakes in the manual or want to contribute – to make the theme even better – get in contact there.
|
||||
The codebase is maintained on \href{https://github.com/matze/mtheme}{GitHub}. So if you have issues, find mistakes in the manual or want to contribute – to make the theme even better – get in touch there.
|
||||
|
||||
\section{Getting Started}
|
||||
\subsection{Installation}
|
||||
% The easiest way to install the \textsc{mtheme} is via your \TeX distribution’s package manager. If not or you want to access the latest version you can also download the theme on GitHub.
|
||||
% \begin{lstlisting}
|
||||
% git clone https://github.com/matze/mtheme.git
|
||||
% \end{lstlisting}
|
||||
The \textsc{mtheme} uses Make as build system. Hence the installation is very straight forward. Simply type
|
||||
\begin{lstlisting}
|
||||
$ make
|
||||
$ make install
|
||||
\end{lstlisting}
|
||||
in the top directory and all the files will be created and installed on your computer. The complete list of make rules is as follows:
|
||||
|
||||
\begin{description}
|
||||
\item[all] \hfill \\
|
||||
Build the theme, the manual and the demo presentation.
|
||||
\item[install] \hfill \\
|
||||
Install the theme into your local texmf folder.
|
||||
\item[uninstall] \hfill \\
|
||||
Remove the theme from your local texmf folder.
|
||||
\item[sty] \hfill \\
|
||||
Build the manual.
|
||||
\item[manual] \hfill \\
|
||||
Build the manual.
|
||||
\item[demo] \hfill \\
|
||||
Build the demo presentation.
|
||||
\item[ctan] \hfill \\
|
||||
Create a package for CTAN distribution.
|
||||
\end{description}
|
||||
|
||||
\subsection{Dependencies}
|
||||
|
||||
\begin{itemize}
|
||||
\item XeLaTeX
|
||||
\item \href{https://github.com/mozilla/Fira}{Fira Sans} and Mono font
|
||||
\item TikZ
|
||||
\end{itemize}
|
||||
|
||||
Depending on the Linux distribution, the packaged name of |Fira Sans| might be |Fira Sans OT| instead of |Fira Sans|. In that case, you may have to edit |beamerfontthememetropolis.dtx|. You may also need to install Fira Sans; see the |contrib/| directory for more. Users of Debian or Ubuntu can also install this \href{https://launchpad.net/\%7Eedd/+archive/ubuntu/misc/+files/latex-mtheme_0.1.0vidid1_all.deb}{.deb package} containing the theme files as well as the Fira Sans font files.
|
||||
|
||||
\subsection{Pandoc}
|
||||
|
||||
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:m -o output.pdf input.md
|
||||
\end{lstlisting}
|
||||
|
||||
\subsection{A Minimal Example}
|
||||
|
||||
To get started with the theme is very simple. The following code shows a minimal example of a Beamer presentation using the \textsc{mtheme}.
|
||||
|
||||
\begin{lstlisting}
|
||||
|
|
@ -111,6 +160,69 @@ To get started with the theme is very simple. The following code shows a minimal
|
|||
\end{document}
|
||||
\end{lstlisting}
|
||||
|
||||
\section{Customization}
|
||||
\subsection{Package options}
|
||||
The theme provides a number of options. To use any of the options below, call them when invoking \textsc{mtheme} in the preamble of the slides, i.e.
|
||||
\begin{lstlisting}[numbers=none]
|
||||
\usetheme[<options>]{m}
|
||||
\end{lstlisting}
|
||||
|
||||
\begin{description}
|
||||
\item[usetitleprogressbar] \hfill \\
|
||||
Adds a thin progress bar similar to the section progress bar underneath each frame title.
|
||||
\item[protectframetitle] \hfill \\
|
||||
In order to use |\cite|, |\ref| and similar commands in a frame title you have to protect the title. This can be done automatically with this option.
|
||||
\item[blockbg] \hfill \\
|
||||
Adds background color to the blocks similar to other beamer themes.
|
||||
\item[nooffset] \hfill \\
|
||||
By default, the \textsc{mtheme} adds |\vspace{2em}| after the frametitle to center content vertically on the frame. This option removes this additional space in order to get more content per slide.
|
||||
\item[nosectionslide] \hfill \\
|
||||
By default when using the |\section| command, a slide is created with just the title and the progress bar on it. This option prevents the creation of these additional slides.
|
||||
\item[usetotalslideindicator] \hfill \\
|
||||
By default, only the current page number is printed in the lower right corner. This option changes the slide numbering format to |#current/#total|.
|
||||
\item[noslidenumbers] \hfill \\
|
||||
Omits slide numbers entirely.
|
||||
\item[darkcolors] \hfill \\
|
||||
Makes the background dark and the foreground light.
|
||||
\end{description}
|
||||
|
||||
\subsection{Color Customization}
|
||||
|
||||
The included metropolis color theme is used by default, but its colors can be easily changed to suit your tastes. All of the theme's styles are defined in terms of three beamer colors:
|
||||
\begin{itemize}
|
||||
\item |normal text| (dark fg, light bg)
|
||||
\item |alerted text| (colored fg, should be visible against dark or light)
|
||||
\item |example text| (colored fg, should be visible against dark or light)
|
||||
\end{itemize}
|
||||
An easy way to customize the theme is to redefine these colors using
|
||||
|
||||
\begin{lstlisting}[numbers=none]
|
||||
\setbeamercolor{ ... }{ fg= ... , bg= ... }
|
||||
\end{lstlisting}
|
||||
in your preamble. For greater customization, you can redefine any of the other colors in |beamercolorthememetropolis|, including progress bar.
|
||||
|
||||
\subsection{Title Formatting}
|
||||
The main title, section titles, and frame titles are all formatted according to the custom command |\mthemetitleformat|. By default, this is equivalent to |\scshape| and sets the titles in small capitals, but you can change it in your preamble. For example:
|
||||
|
||||
\begin{lstlisting}
|
||||
% no small capitals
|
||||
\renewcommand{\mthemetitleformat}{}
|
||||
% all small capitals
|
||||
\renewcommand{\mthemetitleformat}{\scshape\MakeLowercase}
|
||||
% all capitals
|
||||
\renewcommand{\mthemetitleformat}{\MakeUppercase}
|
||||
\end{lstlisting}
|
||||
|
||||
Note that |\MakeLowercase| and |\MakeUppercase| can have unexpected behaviour in math mode, are disabled when |protectframetitle| is used, and cause crashes when an unprotected frametitle appears on a slide with |allowframebreaks|.
|
||||
|
||||
\subsection{Commands}
|
||||
|
||||
The |\plain{title=[]}{<body>}| command sets a slide in plain dark colors which can be useful to focus attention on a single sentence or image.
|
||||
|
||||
\subsection{pgfplot styles}
|
||||
|
||||
The beamer theme also contains pre-defined pgfplot styles. Use the |mlineplot| key to plot line data and |mbarplot| or horizontal |mbarplot| to plot bar charts.
|
||||
|
||||
\section{Known Issues}
|
||||
|
||||
\section{Changelog}
|
||||
|
|
@ -120,7 +232,7 @@ To get started with the theme is very simple. The following code shows a minimal
|
|||
The theme itself is licensed under a \href{http://creativecommons.org/licenses/by-sa/4.0/}{Creative Commons Attribution-ShareAlike 4.0 International License}. This means that if you change the theme and re-distribute it, you must retain the copyright notice header and license it under the same CC-BY-SA license. This does not affect the presentation that you create with the theme.
|
||||
|
||||
\section{Contributors}
|
||||
\input{contributors}
|
||||
For a full list of contributors please visit the \href{https://github.com/matze/mtheme/graphs/contributors}{GitHub Repository}.
|
||||
|
||||
\section{Implementation}
|
||||
\DocInput{beamerthemem.dtx}
|
||||
|
|
|
|||
BIN
mtheme.pdf
BIN
mtheme.pdf
Binary file not shown.
Loading…
Reference in New Issue