metropolis_theme/README.md

90 lines
3.1 KiB
Markdown
Raw Normal View History

2014-09-19 15:05:08 +02:00
## Beamer mtheme
2014-09-22 12:09:38 +02:00
The *mtheme* is a Beamer theme with minimal visual. 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).
2014-09-19 15:05:08 +02:00
![Sample](http://i.imgur.com/wP4uGbS.png)
2014-12-03 16:40:21 +01:00
### Installation
2014-09-19 15:05:08 +02:00
2014-12-03 16:40:21 +01:00
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
2014-09-19 15:05:08 +02:00
2014-12-03 16:40:21 +01:00
* XeLaTeX,
2015-04-28 20:57:00 +02:00
* the [Fira Sans](https://github.com/mozilla/Fira) and Mono font and
* TikZ.
2014-10-09 15:10:47 +02:00
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
2014-12-03 16:37:18 +01:00
2014-12-03 16:40:21 +01:00
### Usage
2014-12-01 22:37:51 +01:00
2014-12-03 16:40:21 +01:00
To build the demo slides just 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
2014-12-03 16:37:18 +01:00
$ pandoc -t beamer --latex-engine=xelatex -V theme:m -o output.pdf input.md
### Customization
2014-10-31 16:03:56 +01:00
2014-12-03 16:37:18 +01:00
#### Package options
2014-10-04 02:54:38 +02:00
The `usetitleprogressbar` option adds a thin progress bar similar to the section
2014-12-03 16:37:18 +01:00
progress bar underneath *each* frame title
2014-10-31 16:03:56 +01:00
![Progressbar](http://i.imgur.com/4BXHU4K.png)
2014-09-19 15:05:08 +02:00
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.
2015-01-29 05:26:34 +01:00
The `blockbg` option defines extra colors used in defining the blocks.
The blocks then have a gray background similar to other beamer themes.
2015-01-30 01:03:10 +01:00
By default, this package adds `\vspace{2em}` after the frametitle to
make content more centered on the frame. If using more content per
slide, this can be turned off at the package-level by passing the
`nooffset` option.
2014-10-09 15:10:47 +02:00
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.
The `nosmallcapitals` option supresses the usage of small capitals on
title page, frame titles and dedicated section slides.
Option `usetotalslideindicator` creates slide numbering in lower right corner
in following format: #current/#total. By default, just current page number is
printed.
2014-10-09 15:10:47 +02:00
2015-01-30 01:03:10 +01:00
#### Commands
2014-10-09 15:10:47 +02:00
2015-01-30 01:03:10 +01:00
The `\plain{title=[]}{body}` command sets a slide in plain dark colors
which can be useful to focus attentation on a single image.
2014-10-09 15:10:47 +02:00
2014-10-31 16:03:56 +01:00
2014-12-03 16:37:18 +01:00
#### pgfplot styles
2014-10-17 08:40:25 +02:00
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.
2014-10-31 16:03:56 +01:00
![Charts](http://i.imgur.com/yuEqU3j.png)
2014-10-17 08:40:25 +02:00
2014-09-19 15:05:08 +02:00
### 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
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.