`cuzbeamer`

This is a LaTeX template based on the metropolis beamer theme, and customized for the convenience of making slides for Communication University of Zhejiang (CUZ).

Related Repo

cuzthesis: a LaTeX thesis template for CUZ students.

Project Structure

The structure of this project is shown and explained below:

CUZbeamer
├── cuzbeamer
│   ├── cuzbeamer.cls
│   ├── images
│   │   ├── cuzlogo-brown.pdf
│   │   ├── cuzlogo-dark.pdf
│   │   ├── cuzlogo-light.pdf
│   │   └── cuzlogo.pdf
│   └── tikz-uml.sty
├── demo.pdf
├── demo.tex
├── initialization.tex
├── README.md
└── references.bib

cuzbeamer/: a folder containing the class file cuzbeamer.cls and the package tikz-uml.sty (written by Nicolas Kielbasiewicz), also with the images/ folder (with school logos in it), this folder should be copied/moved to a default path storing custom tex templates, before using this template (see the Installation part);
initialization.tex: common info imported by a series of .tex files, the content includes: author's name and e-mail, title, subtitle and date, users should assign these variables beforehand;
demo.tex: the demo source file, showing how to use this cuzbeamer class to make a proper set of slides;
references.bib (optional): the bib file used for bibtex to import references.

Users are supposed to add new .tex files at the same level of demo.tex, and specify their own common info in initialization.tex and necessary reference items in references.bib file if needed; while the file structure is not suggested to be modified, unless you know exactly what you are doing.

Prerequests

To use this class:

A LaTeX environment is required (TeX Live is highly recommended);
The Ubuntu font is required to show beautiful non-CJK characters;
[Optional] If codes are to be shown, the minted package is used (the minted option should be switched on, see below), which then requires a Python 3 environment, with the pygments installed:
```
> pip install pygments
```

Installation

Users are supposed to copy/move the cuzbeamer/ folder to the path where the custom latex templates located, which could be obtained by:

> kpsewhich --var-value=TEXMFHOME

eg (the tex/latex folders should be created manually if they do not exist):

For Manjaro Linux: ~/texmf/tex/latex
For macOS: ~/Library/texmf/tex/latex

Usage

Compilation

Due to some reasons of metropolis beamer theme, the pdflatex engine is not supported, thus the xelatex or lualatex is recommended. Besides, if minted option is on, the -shell-escape option is required when compiling, e.g.:

> xelatex -shell-escape -synctex=1 -interaction=nonstopmode -file-line-error demo.tex

Options

When importing this cuzbeamer class in the main .tex files, several options are allowed to be set:

[colortheme=light/dark]: a string option, set the background color of metropolis, dark by default, or light if desired;
[pagestyle=normal/wide/wider]: a string option, set the aspectratio of slide pages, normal for 5:4, wide for 16:10 (the default), or wider for 16:9;
[titlealignment=left/center/right]: a string option, set the alignment of elements (e.g. title, subtitle, author, date, etc.) in the title page, left (the default), center or right;
[minted=true/false]: a boolean option, set for whether to include codes in the slides, true by default;
[algorithm=true/false]: a boolean option, set for whether to use algorithm environments, false by default;
[pgfplots=true/false]: a boolean option, set for whether to use pgfplots package to plot figures, false by default.

License

This class is licensed under a 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 class.