Welcome to pandoc-beamer-multigraphics’s documentation!

Installation

pandoc-beamer-multigraphics is a pandoc filter for adding beamer ability to use multi-images.

Instructions

pandoc-beamer-multigraphics requires python, a programming language that comes pre-installed on linux and Mac OS X, and which is easily installed on Windows.

Install pandoc-beamer-multigraphics using the bash command

$ pip install pandoc-beamer-multigraphics

To upgrade to the most recent release, use

$ pip install --upgrade pandoc-beamer-multigraphics

To upgrade to the current code, use

$ pip install --upgrade --force git+https://github.com/chdemko/pandoc-beamer-multigraphics

pip is a script that downloads and installs modules from the Python Package Index, PyPI. It should come installed with your python distribution. If you are running linux, pip may be bundled separately. On a Debian-based system (including Ubuntu), you can install it as root using

$ sudo apt-get install python3-pip

Getting Help

If you have any difficulties with pandoc-beamer-multigraphics, please feel welcome to file an issue on github so that we can help.

Usage

To apply the filter, use the following option with pandoc:

$ pandoc --filter pandoc-beamer-multigraphics

Explanation

In the metadata block, specific set of classes can be defined to change image elements to become multi-images using the \multiinclude command of beamer.

The metadata block add information using the pandoc-beamer-multigraphics entry by a list of definitions:

pandoc-beamer-multigraphics:
  - classes: [multigraphics]
    format: pdf
    width: 10cm

The metadata block above is used to use multi-images ability for image elements which have multigraphics class. The format used will be pdf and the width will be \textwidth.

Each entry of pandoc-beamer-multigraphics is a YAML dictionary containing:

classes: the set of classes of the images to which the transformation will be applied. This parameter is mandatory.
format: the image format
width: the image width
height: the image height
start: the starting number (0 by default)
end: the ending number (infinity by default)

It’s also possible to set the paramters for each image using the pandoc attribute notation.

Example

Demonstration: Using pandoc-beamer-multigraphics-sample.txt as input gives and image output file in pdf.

Image files used:

The Tux junior image has been created by Stephen Groundwater under the CC BY-SA 3.0 licence.

$ pandoc \
    -t beamer \
    -V theme:Warsaw \
    --filter pandoc-beamer-multigraphics \
    -o docs/images/pandoc-beamer-multigraphics-sample.pdf \
    docs/images/pandoc-beamer-multigraphics-sample.txt