Merge pull request #81 from SoftVarE-Group/release

Release v0.3.0

Author: tthuem

README.md

@@ -10,10 +10,13 @@ First, you need to create a new beamer presentation. For that, add ``\documentcl
 ### Including the Theme
 The beamer theme can be used for a beamer presentation by the command ``\usetheme{uulm}``.
 
+### Empty Slides Template
+You can easily start creating slides by using a copy of the ``empty-slides.tex`` template file.
+
 ### Creating a Symbolic Link
 To use the template from another directory, you can create a symbolic link to the directory of the cloned template. The terminal-commands to create such links vary between different operating systems:
 - **Windows:** `mklink /J \path\to\slides\template path\to\template`
-- **Linux/macOS:** `ln -s /path/to/slides/template /path/to/template`
+- **Linux/macOS:** `ln -s /path/to/template /path/to/slides/template`
 
 ## Functionality of the Theme
 ### Title Page
@@ -29,14 +32,20 @@ The title picture can be changed with an optional parameter: ``\maketitle[<path-
 
 If no picture is given (`\maketitle`), a default picture is used. To create a title frame without a picture, you can use `\maketitle[]`.
 
+To repeat the title slide you can use the command `\againtitle` at any point. It creates a copy of the last title slide with the same picture and picture-offset.
+
+### Content Overview
+
+A slide that shows a clickable multi-column table of contents (including the sections and subsections of the document) can be generated using the command `\contentoverview`.
+
 ### Section Frames
 
 At the begin of each section a title slide is automatically generated. If you are in handout-mode, this slide also includes an overview of all sections and subsections that can be used to navigate through the slides easily.
 
 You can overwrite this behaviour by using one of the following documentclass-options:
-* `\nosectionframes`: no automatic frames at the begin of each section
-* `\sectiontitleslides`: automatic title frames at the begin of each section
-* `\sectionoverviews`: automatic section overviews at the begin of each section
+* `nosectionframes`: no automatic frames at the begin of each section
+* `sectiontitleslides`: automatic title frames at the begin of each section
+* `sectionoverviews`: automatic section overviews at the begin of each section
 
 ### Faculty Colors
 
@@ -64,9 +73,9 @@ Within, the `\mynextcolumn` can be used to separate columns, various options all
 \begin{mycolumns}[columns=3, t]
    Content of Column 1
 \mynextcolumn
-		Content of Column 2
+   Content of Column 2
 \mynextcolumn
-		Content of Column 3
+   Content of Column 3
 \end{mycolumns}
 ```
 
@@ -78,11 +87,13 @@ In total, there are the following options:
 |`b`     | no  | Will vertically align based on the baseline of the last line of each column |
 |`T`     | no  | Similar to `t` but will use the very top of the first line (good for images, ...). |
 | `width=<width>` | `\linewidth` | The total width of all columns (including margins) |
+| `height=<width>` | `no height` | The artificial height of the columns environment (e.g. for animations with different heights). |
+| `no height` |  | Counterpart of `height =<width>` makes the layout use the natural height again. |
 | `margin=<width>` | `0.035\linewidth` | The horizontal space between columns. |
 | `columns=<amount>` | `2` | The number of columns |
 | `widths={<widths>}` | `{}` | A comma-separated list of values, which determine how wide the columns should be. For example, using `columns=4, widths={40,30}` will cause the first column to occupy 40% of the width, the next one 30%, and evenly distribute the remaining 30% among the other two columns (equivalent to `columns=4, widths={40,30,15,15}`). |
-| `animation=none` | yes | Will make all slides visible by default, without any animation (should not be combined with `reverse`). |
-| `keep` or `animation=keep`| no | Similar to the "and" mode of the old layouts. This will cause the columns to be animated one after the other, with previous columns remaining visible. |
+| `animation=none` | yes | Similar to the "and" mode of the old layouts. Will make all slides visible by default, without any animation (should not be combined with `reverse`). |
+| `keep` or `animation=keep`| no | Similar to the "then" mode of the old layouts. This will cause the columns to be animated one after the other, with previous columns remaining visible. |
 | `forget` or `animation=forget`| no | Similar to the "or" mode of the old layouts. This will cause the columns to be animated one after the other, with previous columns disappearing again. This behavior is active *only in recording mode* (`\recordingtrue`), otherwise, this is similar to `animation=keep`. |
 | `reverse`| no | With the default animation order being left-to-right, this makes it right-to-left. |
 | `extra/columns=<value>`| `{}` | Only for people who know, what they are doing. This allows direct, overwriting access on the beamer-`columns` mechanism working behind the scenes. |
@@ -93,6 +104,11 @@ Some of these defaults may appear arbitrary. They can be changed (locally to the
 \setmycolumnsdefault{margin=7mm,t}
 ```
 
+### Unique Slide-Numbering
+
+With the package option `uniqueslidenumber` you can ensure that even frames with overlays get a unique slide number at the bottom right.
+For this, this option adds a suffix to the slide number (`<slide>.<overlay>`) of slides with animations, so the slides can be uniquely identified.
+
 #### Old Macros
 
 Please note that, all of the macros in this section are deprecated (for not being verbatim-safe). Please use the `mycolumns`-mechanism described above.
@@ -103,14 +119,50 @@ The following layouts can be used to arrange content into multiple columns on a
 * ``\leftorright{<left>}{<right>}``, ``\leftmiddleorright{<left>}{<middle>}{<right>}`` <br> Splits the frame into multiple columns, which contain the content given by the multiple arguments and are displayed column by column individually with a blank frame in between (only if not in ``handout``-mode). <br> **Hint:** This only works if the recording mode is enabled via ``\recordingtrue``, otherwise it will act the same as ``\leftthenright`` or ``\leftmiddlethenright``.
 
 ### Color Boxes
-The following colorboxes can be used for writing definitions, examples and notes. The each consist of a title and a content part.
+The following colorboxes can be used for writing definitions, examples and notes:
+
+```latex
+\begin{definition}{<Title>}
+   <Content>
+\end{definition}
+
+\begin{example}{<Title>}
+   <Content>
+\end{example}
+
+\begin{note}{<Title>}
+   <Content>
+\end{note}
+```
+
+#### Custom Color Boxes
+You can also create own colorbox-environments with ``\MakeNewBox{<box-name>}{<box-color>}`` or modify existing ones using ``\UpdateBoxColor{<box-name>}{<new-box-color>}``.
+
+#### Counting Color Boxes
+The prefix and suffix of a box title can be updated using ``\UpdateBoxPrefix{<new-prefix>}`` and ``\UpdateBoxSuffix{<new-suffix>}``. To create a counting box, ``\boxnumber`` can be used in the definition of the prefix or suffix. 
+
+You can also directly add a prefix and suffix to the box title at creation using additional options: ``\MakeNewBox[<prefix>]{<box-name>}{<box-color>}[<suffix>]``
+
+#### Old Macros
+Please note that, all of the macros in this section are deprecated (for not being verbatim-safe). Please use the `definition`, `example` and `note` environments described above.
+
 * ``\mydefinition{<title>}{<content>}``
 * ``\myexample{<title>}{<content>}``
 * ``\mynote{<title>}{<content>}``
 
-Additionally there are environments named `environment`, `example` and `note`, that can be used as verbatim-safe alternatives.
+### Dark Mode
+For easier viewing and editing slides in dark environments, the template features a dark mode that can be enabled with the documentclass-option ``darkmode``.
+
+### Including Pictures
+Pictures can be included using the `\pic{<path>}`-command. This command also enables creating automatic links on the pictures (e.g. for sources). Therefore, the link simply has to be stored in a ``.txt``-file with the same filename.
+
+#### Automatic Dark Mode for Pictures
+Similar to the `\pic` command described above, `\picDark{<path>}` can be used to include pictures that get inverted automatically when the dark mode is used. Therefore, white gets converted to a dark gray that matches the dark background color of the slides.
+
+Alternatively, a separate dark version of the picture can be stored with the suffix `-dark` to get automatically used instead of the normal version when dark mode is enabled.
 
 ### Other Functionalities
 * **Easy Navigation in Slides:** A click on the title or subtitle in the slide footer leads to a jump to the title slide. A click on the section title brings you to the begin of the section.
 * **Auto-Scaling:** Frame titles that are longer than the width of the frame are scaled down automatically. This can avoid annoying linebreaks for a single character or word.
-* **Recording mode:** This theme comes with a optional recording mode. In this mode, the animations for the content layouts ``\leftorright`` and ``\leftmiddleorright`` are different. Each column that is generated by those layouts is displayed individually one after another with a blank slide in between. That way, the presenter can walk over to the other side of the frame if recording in front of the slides. <br> The recording mode can be enabled using the command ``\recordingtrue``.
+* **Recording mode:** This theme comes with a optional recording mode. In this mode, the animations for the content layouts ``\leftorright`` and ``\leftmiddleorright`` are different. Each column that is generated by those layouts is displayed individually one after another with a blank slide in between. That way, the presenter can walk over to the other side of the frame if recording in front of the slides. <br> The recording mode can be enabled using the command ``\recordingtrue``.
+* **Using Lectures:** Standard LaTeX `\lecture`s can also be used with the template. `lecture-demo` contains an example for how to use them.