diff options
author | Karl Berry <karl@freefriends.org> | 2017-06-06 21:54:50 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2017-06-06 21:54:50 +0000 |
commit | 9fc9e3041c5412f3fdb979bdb587f7c90bfaf8bb (patch) | |
tree | 88900a8c128118aca53a473b4828efb757dbf4bd /Master/texmf-dist/doc | |
parent | d065000138908e78e45f5e66e97ad1349866e0c3 (diff) |
beamerswitch (23may17)
git-svn-id: svn://tug.org/texlive/trunk@44508 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/latex/beamerswitch/Makefile | 2 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/beamerswitch/README.md | 99 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example-article.pdf | bin | 19460 -> 19452 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example-handout.pdf | bin | 21672 -> 21663 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example-trans.pdf | bin | 22284 -> 22276 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example.pdf | bin | 35774 -> 35779 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example.tex | 2 | ||||
-rw-r--r-- | Master/texmf-dist/doc/latex/beamerswitch/beamerswitch.pdf | bin | 146131 -> 151598 bytes |
8 files changed, 61 insertions, 42 deletions
diff --git a/Master/texmf-dist/doc/latex/beamerswitch/Makefile b/Master/texmf-dist/doc/latex/beamerswitch/Makefile index 533b127c14f..351e476ea33 100644 --- a/Master/texmf-dist/doc/latex/beamerswitch/Makefile +++ b/Master/texmf-dist/doc/latex/beamerswitch/Makefile @@ -12,7 +12,7 @@ UTREE = $(shell kpsewhich --var-value TEXMFHOME) all: $(NAME).pdf $(NAME)-example.pdf clean @exit 0 $(NAME).cls $(NAME)-example.tex: $(NAME).dtx - lualatex -synctex=1 -shell-escape -interaction=batchmode $(NAME).dtx >/dev/null + tex -interaction=batchmode $(NAME).dtx >/dev/null $(NAME).pdf: $(NAME).dtx latexmk -silent -lualatex -synctex=1 -shell-escape -interaction=batchmode $(NAME).dtx >/dev/null $(NAME)-example.pdf $(NAME)-example-trans.pdf $(NAME)-example-handout.pdf $(NAME)-example-article.pdf: $(NAME).cls $(NAME)-example.tex diff --git a/Master/texmf-dist/doc/latex/beamerswitch/README.md b/Master/texmf-dist/doc/latex/beamerswitch/README.md index b39c964a8e7..b6e05943dab 100644 --- a/Master/texmf-dist/doc/latex/beamerswitch/README.md +++ b/Master/texmf-dist/doc/latex/beamerswitch/README.md @@ -1,75 +1,94 @@ # beamerswitch: Convenient mode selection in Beamer documents -This class is a wrapper around the `beamer` class to make it easier to use the -same document to generate the different forms of the presentation: the slides -themselves, an abbreviated slide set for transparencies or online reference, -an n-up handout version, and a transcript or set of notes using the `article` -class. +This class is a wrapper around the [beamer](http://ctan.org/pkg/beamer) class to +make it easier to use the same document to generate the different forms of the +presentation: the slides themselves, an abbreviated slide set for transparencies +or online reference, an n-up handout version, and a transcript or set of notes +using the `article` class. ## Installation ### Dependencies -To compile the documentation you will need to have the `minted` package working, -which in turn relies on Python 2.6+ and Pygments. See the documentation of that -package for details. +To compile the documentation you will need to have the +[minted](http://ctan.org/pkg/minted) package working, which in turn relies on +Python 2.6+ and Pygments. See the documentation of that package for details. -There is an example file that demonstrates the features of the class. -The class itself depends only on packages easily available through TeX -distributions and CTAN. One feature relies on `latexmk` though you can work -around that if you have the patience. +There is an example file that demonstrates the features of the class. The class +itself depends only on packages easily available through TeX distributions and +CTAN. One feature relies on [latexmk](http://ctan.org/pkg/latexmk) though you +can work around that if you have the patience. -Note that the zip file on the [Releases] page on GitHub contains all the files -you need, pre-compiled. +Note that the zip file on the +[Releases](https://github.com/alex-ball/beamerswitch/releases) page on GitHub +contains all the files you need, pre-compiled. You can also avoid the hassle by +installing the class from your TeX distribution's package manager. -[Releases]: https://github.com/alex-ball/beamerswitch/releases +### Managed way + +The latest stable release of the beamerswitch class has been packaged for +TeX Live and MiKTeX. If you are running TeX Live and have `tlmgr` +installed, you can install the package simply by running +`tlmgr install beamerswitch`. If you are running MiKTeX, you can install the +package by running `mpm --install=beamerswitch`. Both `tlmgr` and `mpm` have +GUI versions that you might find friendlier. ### Automated way A makefile is provided which you can use with the Make utility: + * Running `make beamerswitch.cls` just generates the class file (and a few + others). * Running `make` generates the class file and documentation. - * Running `make inst` installs the files to your home TeX tree. - * Running `make install` installs the files to the local TeX tree. - * Running `make uninst` uninstalls the files to your home TeX tree. - * Running `make uninstall` uninstalls the files to the local TeX tree. + * Running `make inst` generates and installs the files to your home TeX tree. + (To undo, run `make uninst`.) + * Running `make install` generates and installs the files to the local TeX + tree. (To undo, run `make uninstall`.) + * Running `make clean` removes auxiliary files from the working directory. + * Running `make distclean` removes the generated from the working directory + files as well. ### Manual way To install the class from scratch, follow these instructions. If you have downloaded the zip file from the [Releases] page on GitHub, you can skip the -first two steps. +first three steps. + + 1. Run `tex beamerswitch.dtx` to generate the class file and the example file + `beamerswitch-example.tex`. (You can safely skip this step if you are + confident about step 2.) - 1. Process `beamerswitch.dtx` with your favourite version of LaTeX with shell + 2. Compile `beamerswitch.dtx` with your favourite version of LaTeX with shell escape enabled (as required by `minted` for typesetting the listings). You - will also need to run it through `makeindex`. This will generate the class - file and the main documentation (DVI or PDF), plus an example file - `beamerswitch-example.tex`. + will also need to run it through `makeindex`. This will generate the main + documentation (DVI or PDF). - 2. Process `beamerswitch-example.tex` with your favourite version of LaTeX. If + 3. Compile `beamerswitch-example.tex` with your favourite version of LaTeX. If you enable shell escape and have `latexmk` installed you will end up with another four documents (DVI or PDF). Otherwise you will get one. - 3. To install the files, create the following folders in your chosen TeX tree + 4. To install the files, create the following folders in your chosen TeX tree and copy the files across as shown (read `.pdf` as `.dvi` if that is what you generated): - - * `source/latex/beamerswitch`: - `beamerswitch.dtx`, - (`beamerswitch.ins`) - * `tex/latex/beamerswitch`: - `beamerswitch.cls` - * `doc/latex/beamerswitch`: - `beamerswitch.pdf`, - `beamerswitch-example.tex`, - `beamerswitch-example.pdf`, - `beamerswitch-example-article.pdf`, - `beamerswitch-example-handout.pdf`, - `beamerswitch-example-trans.pdf` + - `source/latex/beamerswitch`: + `beamerswitch.dtx`, + (`beamerswitch.ins`) + - `tex/latex/beamerswitch`: + `beamerswitch.cls` + - `doc/latex/beamerswitch`: + `beamerswitch.pdf`, + `beamerswitch-example.tex`, + `beamerswitch-example.pdf`, + `beamerswitch-example-article.pdf`, + `beamerswitch-example-handout.pdf`, + `beamerswitch-example-trans.pdf` + + 5. You may then have to update your installation's file name database + before TeX and friends can see the files. ## Licence -Copyright 2016 Alex Ball. +Copyright 2016^^e2^^80^^932017 Alex Ball. This work consists of the file beamerswitch.dtx and a Makefile. diff --git a/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example-article.pdf b/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example-article.pdf Binary files differindex f71c227da88..8eca04a1d54 100644 --- a/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example-article.pdf +++ b/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example-article.pdf diff --git a/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example-handout.pdf b/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example-handout.pdf Binary files differindex 88a721e7f2c..788771e234c 100644 --- a/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example-handout.pdf +++ b/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example-handout.pdf diff --git a/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example-trans.pdf b/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example-trans.pdf Binary files differindex 8c44105c572..844dfdd2e50 100644 --- a/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example-trans.pdf +++ b/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example-trans.pdf diff --git a/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example.pdf b/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example.pdf Binary files differindex 59c3fb2621c..8aef6f3364f 100644 --- a/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example.pdf +++ b/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example.pdf diff --git a/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example.tex b/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example.tex index f1dfc37a9c0..d4ad2527b43 100644 --- a/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example.tex +++ b/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch-example.tex @@ -77,6 +77,6 @@ Happy {\LaTeX}ing! \end{document} %% -%% Copyright (C) 2016 by Alex Ball <a.j.ball@bath.ac.uk> +%% Copyright (C) 2016-2017 by Alex Ball <a.j.ball@bath.ac.uk> %% %% End of file `beamerswitch-example.tex'. diff --git a/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch.pdf b/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch.pdf Binary files differindex 418ad7bf717..c9f064386d8 100644 --- a/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch.pdf +++ b/Master/texmf-dist/doc/latex/beamerswitch/beamerswitch.pdf |