Commit 958c86c3 authored by Reinhold Kainhofer's avatar Reinhold Kainhofer
Browse files

Dokumentation der Benutzung der Beamer-Klasse, Beispiele ins README

parent e41f9bf9
......@@ -2,11 +2,134 @@
## Author: Reinhold Kainhofer, reinhold@kainhofer.com
LaTeX-Dokumentklassen für das Corporate Design der Aktuarvereinigung Österreichs (AVÖ, http://avoe.at/).
* Präsentation (Beamer-Stil "avoe")
* Dokumentklasse avoereport (Modifikation der report-Dokumentklasse mit dem AVÖ-Corporate Design)
* Dokumentklasse avoearticle (Modifikation der article-Dokumentklasse mit dem AVÖ-Corporate Design)
Diese Dokumentklassen kamen bereits bei der Dokumentation und Präsentation der Pensionstafel AVÖ 2018-P zur Anwendung.
Beispiel-PDF: [example-avoearticle.pdf](examples/example-avoearticle.pdf), [example-avoeslides-beamer.pdf](examples/example-avoeslides-beamer.pdf)
## Installation
Linux: Einfach das gesamte Verzeichnis als ~/textmf/tex/latex/avoeclasses speichern
und (bei Verwendung von TeXlive) `texhash` ausführen. pdflatex sollte nun
die Klassen und Grafiken problemlos finden.
Windows (MikTeX): Das gesamte Verzeichnis als tex/latex/avoeclasses eines beliebigen
Verzeichnisses speichern, die MikTeX-Konsole öffnen und das beliebige Verzeichnis (in
dem das Verzeichnis tex/ liegt) als einen TeX-Pfad hinzufügen. Danach die Datei-Datenbank
mit dem entsprechenden Menüpunkt der MikTeX-Konsole aktualisieren lassen.
## Benutzung
### Präsentation
Es existiert eine [Beispiel-Präsentation](examples/example-avoeslides-beamer.tex) im Verzeichnis [examples/](examples/). Ein gekürztes Beispiel ist:
```{latex}
\documentclass[10pt]{beamer}
\usepackage{fontenc}
\usepackage[utf8]{inputenc}
\usepackage[shorthands=off,main=ngerman]{babel}
\usetheme{avoe}
\title{Corporate Design der AVÖ}
\subtitle{LaTeX-Vorlagen für Reports und Folien}
\author[R. Kainhofer]{Reinhold Kainhofer}
\institute[AVÖ AK RG]{AVÖ Arbeitskreis Rechnungsgrundlagen}
\date[25.1.2019]{Bereitstellung im Internet\\\footnotesize 25. Jänner 2019}
\begin{document}
\begin{frame}
\showHeaderImageAnalysis
\titlepage
\end{frame}
\begin{frame}
\showHeaderImageNumbers
\frametitle{Überblick}
\tableofcontents
\end{frame}
\section{Notwendigkeit eines Corporate Designs}
\begin{frame}
\frametitle{Corporate Design als Außenwirkung}
\framesubtitle{Was ist CD? Wofür einheitliche Darstellung?}
\begin{itemize}
\item Wiedererkennungswert nach außen
\item Fördert (internes) Zugehörigkeitsgefühl zur jeweiligen Organisation
\item Vorgegebene Struktur fördert strukturiertes Vorgehen
\begin{itemize}
\item Erleichtert Erstellung von Materialien
\item Erleichtert Benutzung der Materialien durch ähnlichen Aufbau, etc.
\end{itemize}
\item item
\end{itemize}
\end{frame}
\end{document}
```
### AVÖ-Report / Artikel eines Arbeitskreises
Auch hier existiert eine [Beispieldatei](examples/example-avoearticle.tex) im Verzeichnis [examples/](examples/). Ein gekürztes Beispiel ist:
```{latex}
\documentclass[a4paper,10pt,titlepage]{avoearticle}
\usepackage[utf8]{inputenc}
\usepackage[ngerman]{babel}
\usepackage{fontenc}
\author{Reinhold Kainhofer}
\title{AVÖ \LaTeX{} Document Classes: \\avoearticle}
\shorttitle{AV\"O Design}
\themengebiet{Corporate Identity}
\date{9. März 2018}
\arbeitskreis{Rechnungsgrundlagen}
\begin{document}
\maketitle
\tableofcontents
\begin{documenthistory}
0.1 & Erster Entwurf von ... & xx.xx.20xx\\\hline
0.2 & Review durch ... & xx.xx.20xx\\\hline
\end{documenthistory}
\pagebreak
\section{Kapitel}
\subsection{Unterkapital}
Hier kommt dann der Text des Reports oder Artikels...
\end{document}
```
Beispiel-PDF: [example-avoearticle.pdf](example-avoearticle.pdf)
## Funktionialität
### Beamer-Stil avoe für Präsentationen
"Normale" Verwendung von Beamer führt bereits zum vollständigen AVÖ-Design. Für die Bilder auf der Titelseite und den Kapitel-Titelseiten existieren folgende Befehle:
* ``\showHeaderImageAnalysis``, ``\showHeaderImageNumbers``, ``\showHeaderImagePen``
### Dokumentklassen avoearticle und avoereport
"Normale" Verwendung der AVÖ-Dokumentklasse führt bereits zum AVÖ-Design ohne weitere Anpassungen. Zusätzlich existieren folgende Features, um AVÖ-spezifische Teile des Dokuments zu setzen:
* ``\shorttitle{...}``: Kurztitel für die Fußzeile. Falls nicht angegeben, wird der \title{...} benutzt
* ``\themengebiet{...}``: Untertitel des Artikels (auch in Fußzeile)
* ``\arbeitskreis{...}``: Arbeitskreis (vor Author), auch in Kopfzeile
......@@ -23,13 +146,7 @@ Beispiel-PDF: [example-avoearticle.pdf](example-avoearticle.pdf)
```
## Installation
Einfach das gesamte Verzeichnis als ~/textmf/tex/latex/avoeclasses speichern
und (bei Verwendung von TeXlive) `texhash` ausführen. pdflatex sollte nun
die Klassen und Grafiken problemlos finden.
### Paket-Abhängigkeiten
## Paket-Abhängigkeiten
* hyperref
* opensans
* titlesec
......@@ -45,31 +162,3 @@ die Klassen und Grafiken problemlos finden.
## Beispiel
```{latex}
\documentclass[a4paper,10pt]{avoearticle}
\usepackage[utf8]{inputenc}
\usepackage[ngerman]{babel}
\usepackage{fontenc}
\author{Reinhold Kainhofer}
\title{AVÖ \LaTeX{} Document Class}
\shorttitle{AV\"O Design}
\themengebiet{Corporate Identity}
\date{9. März 2018}
\arbeitskreis{Rechnungsgrundlagen}
\begin{document}
\maketitle
\tableofcontents
\section{Beispielkapitel}
Hier kommt der Text...
\end{document}
```
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment