summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/tuda-ci/example/DEMO-TUDaPub.tex
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2020-09-09 03:03:16 +0000
committerNorbert Preining <norbert@preining.info>2020-09-09 03:03:16 +0000
commit4b315627efc5a6beb1e6c6ec7a98779f215c75eb (patch)
treecf65539a3758192b9bfbaea63d1962f28ec32a3e /macros/latex/contrib/tuda-ci/example/DEMO-TUDaPub.tex
parentbc2d0660f4f460b55009ab4e525f2a0e4cde6187 (diff)
CTAN sync 202009090303
Diffstat (limited to 'macros/latex/contrib/tuda-ci/example/DEMO-TUDaPub.tex')
-rw-r--r--macros/latex/contrib/tuda-ci/example/DEMO-TUDaPub.tex76
1 files changed, 69 insertions, 7 deletions
diff --git a/macros/latex/contrib/tuda-ci/example/DEMO-TUDaPub.tex b/macros/latex/contrib/tuda-ci/example/DEMO-TUDaPub.tex
index 243299d1a8..5d05b18732 100644
--- a/macros/latex/contrib/tuda-ci/example/DEMO-TUDaPub.tex
+++ b/macros/latex/contrib/tuda-ci/example/DEMO-TUDaPub.tex
@@ -1,4 +1,4 @@
-%% This is file `DEMO-TUDaPub.tex' version 2.11 (2020/06/12),
+%% This is file `DEMO-TUDaPub.tex' version 3.00 (2020/09/08),
%% it is part of
%% TUDa-CI -- Corporate Design for TU Darmstadt
%% ----------------------------------------------------------------------------
@@ -24,6 +24,10 @@
%% https://github.com/tudace/tuda_latex_templates
%% Please use the issue tracker for feedback!
%%
+%% If you need a compiled version of this document, have a look at
+%% http://mirror.ctan.org/tex-archive/macros/latex/contrib/tuda-ci/doc
+%% or at the documentation directory of this package (if installed)
+%% <path to your LaTeX distribution>/doc/latex/tuda-ci
%% ============================================================================
%%
% !TeX program = lualatex
@@ -103,7 +107,7 @@ In diesem Dokument werden die speziellen Optionen und Einstellungsmöglichkeiten
\section{Verwendung}
Die Klasse wird wie gewohnt geladen:
\begin{verbatim}
-\documentclass[<Optionen>{tudapub}
+\documentclass[<Optionen>]{tudapub}
\end{verbatim}
Im folgenden werden die möglichen Optionen beschrieben.
@@ -133,7 +137,7 @@ Im folgenden werden die möglichen Optionen beschrieben.
\item[ruledheaders] Wählt den Stil der Überschriften aus. \code{ruledheaders=all} wählt den mit Linien eingerahmten Stil für alle bis zur \verb+\subsubsection+. Bei \code{chapter} beziehungsweise \code{section} ist dieser Stil entsprechend
beschränkt. False lädt den Standardstil aus \KOMAScript.
\item[type] Als Typ stehen im Moment \code{publication} und \code{thesis} zur Verfügung. Die besonderen Möglichkeiten im Typ thesis sind in der Datei DEMO-TUDaThesis.tex/.pdf geschildert. Voreingestellt ist \code{publication}.
- Zusätzlich existiert ab Version 1.2 noch der Modus \code{intern}. Dieser wählt die Optionen \code{titlepage=false} für einen Titelkopf statt Titelseiten, sowie die TUDaPub-Optionen \code{pdfa=false} und \code{IMRAD=false}. Dieser Modus ist für kurze, interne Berichte gedacht.
+ Zusätzlich existiert ab Version 1.2 noch der Modus \code{intern}. Dieser wählt die Optionen \code{titlepage=false} für einen Titelkopf statt Titelseiten, sowie die TUDaPub-Optionen \code{pdfa=""false} und \code{IMRAD=false}. Dieser Modus ist für kurze, interne Berichte gedacht.
\item[headline] Die Kopfzeile verfügt über die im Corporate Design beschriebenen Layoutmöglichkeiten über den Wert \code{automark}. Da diese Lösung typografisch nicht sonderlich sinnvoll ist, ist es auch möglich, diese abzuschalten. Voreingestellt ist ein Stil ohne Kolumnentitel.
\item[logo] Option für die Titelseite, siehe \ref{sec:title}
\item[colorback] Option für die Titelseite, siehe \ref{sec:title}
@@ -177,8 +181,27 @@ Um die Institutsboxen für Logos zu verwenden, liefert \cls{tudapub} das Makro \
\addTitleBoxLogo*{\includegraphics[width=\linewidth]{example-image}}
\end{verbatim}
+\minisec{Sponsorenlogos}
+Ab Version 3.0 steht in TUDaPub auch der Sponsorenmechanismus der TUDaLeaflet-Klasse zur verfügung. Damit ist es Möglich Sponsorenlogos unterhalb des Titelbildes zu platzieren.
+
+Sponsorenlogos werden üblicherweise über
+\begin{verbatim}
+ \AddSponsor{<logo1>}
+ \AddSponsor{<log2>}
+\end{verbatim}
+übergeben. Innerhalb des Arguments ist \verb+\height+ so gesetzt. Somit werden im Beispiel alle Logos auf die gleiche Höhe gesetzt. Der Abstand dazwischen wird entsprechend aufgefüllt, sodass der gesamte Block immer links und rechts mit dem Text abschließt.
+
+Die zweite Variante ermöglicht die Platzierung mit manueller vertikaler Ausrichtung, wie es bei Logos mit unterschiedlicher Höhe notwendig sein könnte. Hierbei werden lediglich die Abstände und Trennlinien um die Logos ergänzt:
+
+\begin{verbatim}
+ \sponsors{
+ <logo1><logo2>
+ }
+\end{verbatim}
+
+
\minisec{Optionen für die Titelseite}
-Die Position des Logos ist umschaltbar. Dies geschieht über die Dokumentenklassenoption \code{logo=head/body}.
+Die Position des Logos ist umschaltbar. Dies geschieht über die Dokumentenklassenoption \code{logo=head/""body}.
\begin{description}
\item[logo=head] Das Logo wird im Kopf direkt neben dem Titel platziert. Der Titel wird in der Breite reduziert. Der Hintergrund des Titels wird in der Farbe der Identitätsleiste eingefärbt. Zusätzliche Infoboxen (s.u.) werden ebenfalls im Kopf platziert.
\item[logo=body] Das Logo samt der Infoboxen wird im Körper der Titelseite platziert.
@@ -233,7 +256,7 @@ No color profile found to use for RGB screen colors
\end{verbatim}
Um diesen Fehler zu beheben, können die notwendigen *.icc-Dateien unter \url{http://mirror.ctan.org/support/colorprofiles} heruntergeladen und entweder installiert oder im Projektordner mit abgelegt werden. Die einfachste Lösung bleibt jedoch, das eigene \TeX-System zu aktualisieren.
-Darüber hinaus werden bei \hologo{XeLaTeX} einige Features nicht unterstützt. In diesem Fall erzeugt \code{pdfa=false} ein kompilierbares Dokument, allerdings sollte für validierbare PDF/A-Dateien auf \hologo{LuaLaTeX} einer möglichst aktuellen Version umgestiegen werden.
+Darüber hinaus werden bei \hologo{XeLaTeX} einige Features nicht unterstützt. In diesem Fall erzeugt \code{pdfa=""false} ein kompilierbares Dokument, allerdings sollte für validierbare PDF/A-Dateien auf \hologo{LuaLaTeX} einer möglichst aktuellen Version umgestiegen werden.
\subsection{Zusätzliche Metadaten nach Wunsch der Universitätsbibliothek}
\label{sec:IMRAD}
@@ -269,7 +292,8 @@ Somit ist es möglich, für den Vorspann auf römische Ziffern zu wechseln. Ab \
\subsection{Mathematikschriften}
Da es keine Compiler-unanbhängige, universelle Mathematikschrift gibt und die Corporate Design Richtlinien auch keinerlei Empfehlung berücksichtigen, wurden hierfür einige mögliche Varianten diskutiert. Die Voreinstallung entspricht immer dem Standard der Installation. Es werden keine spezifischen Einstellungen geladen.
-Die Diskussion hierzu findet sich unter \url{https://github.com/tudace/tuda_latex_templates/issues/19}
+Die Diskussion hierzu findet sich unter:\\
+\url{https://github.com/tudace/tuda_latex_templates/issues/19}
Im Folgenden werden ein paar Beispielkonfigurationen gezeigt. Grundsätzlich ist die Mathematikschriftart jedoch -- abgesehen durch Einschränkungen des Compilers -- frei wählbar.
@@ -285,9 +309,47 @@ Hier existiert eine Variante, die die Buchstaben der Basischriftart \enquote{Cha
Es gibt ähnliche Ansätze für ein paar weitere Kombinationen. Einige Beispiele finden sich in der XCharter Dokumentation. \url{http://mirrors.ctan.org/fonts/xcharter/doc/xcharter-doc.pdf}
+\section{Fachbereichsspezifische Anpassungen}
+Einige Fachbereiche haben spezielle Anforderungen. Dieser Abschnitt betrachtet die speziellen Anpassungen. Bisher (Juli 2020) existieren diese Modifikationen lediglich für den Fachbereich Maschinenbau, der Mechanismus ist jedoch erweiterungsfähig.
+
+
+\subsection{Fachbereich Maschinenbau}
+Der entsprechende Modus wird über die Option \code{department=mecheng} oder kurz \code{mecheng} aktiviert. Die Farbgebung passt sich dann automatisch an und die Trennlinie der Fußzeile erhält die geforderte Form des Zeitstrahles.
+
+Darüber hinaus erfordern manche Stellen dieses Fachbereits die übergabe einer ID zu Kennzeichnung des Dokuments. Hierfür wurde der Mechanismus
+\begin{verbatim}
+\SetPaperID{<Buchstabe>}{<tiefgestelle Nummer>}}
+\end{verbatim}
+eingeführt.
+Dieser funktioniert auch ohne die Aktivierung des \code{mecheng}-Modus, allerdings ergänzt due Option einige zusätzliche Parameter für angepasste Abstände.
+
+Darüber hinaus aktiviert der Modus die Optionen:
+\code{colorback=false}, \code{ruledheaders=section}.
+
+\minisec{Logo}
+Das Fachbereichslogo wird über die Option \verb+departmentlogofile=tuda_maschinenbau_logo+ übergeben. Über diese Option kann auch eine abweichende Datei genutzt werden. Falls der Wert leer bleibt, wird kein Bild eingefügt.
+
+\minisec{Farbanpassungen}
+Der Fachbereich untergliedert die im Corporate Design Handbuch beschriebenen Farben zusätzlich. Daher existieren, wenn \code{mecheng} aktiviert wurde zusätzlich die folgenden Farbnamen:
+
+\begin{verbatim}
+\colorlet{TUDa-Primary1}{TUDa-6b}
+\colorlet{TUDa-Primary2}{TUDa-2d}
+\colorlet{TUDa-Secondary1}{TUDa-9a}
+\colorlet{TUDa-Secondary2}{TUDa-8a}
+\colorlet{TUDa-Secondary3}{TUDa-6a}
+\colorlet{TUDa-Secondary4}{TUDa-3a}
+\colorlet{TUDa-Secondary5}{TUDa-4a}
+\colorlet{TUDa-Secondary6}{TUDa-5a}
+\colorlet{TUDa-Arrow}{TUDa-Primary2}
+\end{verbatim}
+
+\minisec{Zeitstrahl}
+Des Design-Element des Zeitstrahls kann über das Makro \verb+\MechEngArrow{<Länge>}+ erzeugt werden. Die Farbe entspricht dabei der Farbe \code{TUDaArrow}, die mit der zweiten Primärfarbe (blau) vorbelegt ist.
+
\section{Standard-KOMA-Script}
\label{sec:KOMA}
-Da die Klasse bis auf ein paar erzwungene Einstellungen, die das Layout betreffen, vollständig \KOMAScript-kompatibel ist, ist für sämtliche Modifikationen ein Blick in die \KOMAScript-Dokumentation hilfreich. Für einen Großteil bietet \KOMAScript{} eine eigene Lösung, wodurch Ergänzungspakete oft hinfällig sind.
+Da die Klasse bis auf ein paar erzwungene Einstellungen, die das Layout betreffen, vollständig \KOMAScript"=kompatibel ist, ist für sämtliche Modifikationen ein Blick in die \KOMAScript-Dokumentation hilfreich. Für einen Großteil bietet \KOMAScript{} eine eigene Lösung, wodurch Ergänzungspakete oft hinfällig sind.
Beispiele für typische Modifikationen, die auch im Rahmen des Corporate Design zulässig sind:
\begin{itemize}