| 1 |
# beamerswitch: Convenient mode selection in Beamer documents |
| 2 |
|
| 3 |
This class is a wrapper around the [beamer](http://ctan.org/pkg/beamer) class to |
| 4 |
make it easier to use the same document to generate the different forms of the |
| 5 |
presentation: the slides themselves, an abbreviated slide set for transparencies |
| 6 |
or online reference, an n-up handout version, and a transcript or set of notes |
| 7 |
using the `article` class. |
| 8 |
|
| 9 |
## Installation |
| 10 |
|
| 11 |
### Dependencies |
| 12 |
|
| 13 |
To compile the documentation you will need to have the |
| 14 |
[minted](http://ctan.org/pkg/minted) package working, which in turn relies on |
| 15 |
Python 2.6+ and Pygments. See the documentation of that package for details. |
| 16 |
|
| 17 |
There is an example file that demonstrates the features of the class. The class |
| 18 |
itself depends only on packages easily available through TeX distributions and |
| 19 |
CTAN. One feature relies on [latexmk](http://ctan.org/pkg/latexmk) though you |
| 20 |
can work around that if you have the patience. |
| 21 |
|
| 22 |
Note that the zip file on the |
| 23 |
[Releases](https://github.com/alex-ball/beamerswitch/releases) page on GitHub |
| 24 |
contains all the files you need, pre-compiled. You can also avoid the hassle by |
| 25 |
installing the class from your TeX distribution's package manager. |
| 26 |
|
| 27 |
### Managed way |
| 28 |
|
| 29 |
The latest stable release of the beamerswitch class has been packaged for |
| 30 |
TeX Live and MiKTeX. If you are running TeX Live and have `tlmgr` |
| 31 |
installed, you can install the package simply by running |
| 32 |
`tlmgr install beamerswitch`. If you are running MiKTeX, you can install the |
| 33 |
package by running `mpm --install=beamerswitch`. Both `tlmgr` and `mpm` have |
| 34 |
GUI versions that you might find friendlier. |
| 35 |
|
| 36 |
### Automated way |
| 37 |
|
| 38 |
A makefile is provided which you can use with the Make utility: |
| 39 |
|
| 40 |
* Running `make beamerswitch.cls` just generates the class file (and a few |
| 41 |
others). |
| 42 |
* Running `make` generates the class file and documentation. |
| 43 |
* Running `make inst` generates and installs the files to your home TeX tree. |
| 44 |
(To undo, run `make uninst`.) |
| 45 |
* Running `make install` generates and installs the files to the local TeX |
| 46 |
tree. (To undo, run `make uninstall`.) |
| 47 |
* Running `make clean` removes auxiliary files from the working directory. |
| 48 |
* Running `make distclean` removes the generated from the working directory |
| 49 |
files as well. |
| 50 |
|
| 51 |
### Manual way |
| 52 |
|
| 53 |
To install the class from scratch, follow these instructions. If you have |
| 54 |
downloaded the zip file from the [Releases] page on GitHub, you can skip the |
| 55 |
first three steps. |
| 56 |
|
| 57 |
1. Run `tex beamerswitch.dtx` to generate the class file and the example file |
| 58 |
`beamerswitch-example.tex`. (You can safely skip this step if you are |
| 59 |
confident about step 2.) |
| 60 |
|
| 61 |
2. Compile `beamerswitch.dtx` with your favourite version of LaTeX with shell |
| 62 |
escape enabled (as required by `minted` for typesetting the listings). You |
| 63 |
will also need to run it through `makeindex`. This will generate the main |
| 64 |
documentation (DVI or PDF). |
| 65 |
|
| 66 |
3. Compile `beamerswitch-example.tex` with your favourite version of LaTeX. If |
| 67 |
you enable shell escape and have `latexmk` installed you will end up with |
| 68 |
another four documents (DVI or PDF). Otherwise you will get one. |
| 69 |
|
| 70 |
4. To install the files, create the following folders in your chosen TeX tree |
| 71 |
and copy the files across as shown (read `.pdf` as `.dvi` if that is what |
| 72 |
you generated): |
| 73 |
- `source/latex/beamerswitch`: |
| 74 |
`beamerswitch.dtx`, |
| 75 |
(`beamerswitch.ins`) |
| 76 |
- `tex/latex/beamerswitch`: |
| 77 |
`beamerswitch.cls` |
| 78 |
- `doc/latex/beamerswitch`: |
| 79 |
`beamerswitch.pdf`, |
| 80 |
`beamerswitch-example.tex`, |
| 81 |
`beamerswitch-example.pdf`, |
| 82 |
`beamerswitch-example-article.pdf`, |
| 83 |
`beamerswitch-example-handout.pdf`, |
| 84 |
`beamerswitch-example-trans.pdf` |
| 85 |
|
| 86 |
5. You may then have to update your installation's file name database |
| 87 |
before TeX and friends can see the files. |
| 88 |
|
| 89 |
## Licence |
| 90 |
|
| 91 |
Copyright 2016–2022 Alex Ball. |
| 92 |
|
| 93 |
This work consists of the file beamerswitch.dtx and a Makefile. |
| 94 |
|
| 95 |
This work may be distributed and/or modified under the conditions of the |
| 96 |
[LaTeX Project Public License (LPPL)](http://www.latex-project.org/lppl.txt), |
| 97 |
either version 1.3c of this license or (at your option) any later version. |
| 98 |
|
| 99 |
This work is "maintained" (as per LPPL maintenance status) by |
| 100 |
[Alex Ball](http://alexball.me.uk/). |
| 101 |
|