summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/beamer-contrib/themes/beamertheme-trigon/docs/trigontheme.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/beamer-contrib/themes/beamertheme-trigon/docs/trigontheme.dtx')
-rw-r--r--macros/latex/contrib/beamer-contrib/themes/beamertheme-trigon/docs/trigontheme.dtx66
1 files changed, 49 insertions, 17 deletions
diff --git a/macros/latex/contrib/beamer-contrib/themes/beamertheme-trigon/docs/trigontheme.dtx b/macros/latex/contrib/beamer-contrib/themes/beamertheme-trigon/docs/trigontheme.dtx
index e40dd1431f..f7d6503a2d 100644
--- a/macros/latex/contrib/beamer-contrib/themes/beamertheme-trigon/docs/trigontheme.dtx
+++ b/macros/latex/contrib/beamer-contrib/themes/beamertheme-trigon/docs/trigontheme.dtx
@@ -111,7 +111,7 @@
\themename found its origin and inspiration in the graphical guidelines
resulting from the visual identity overhaul of the
-\href{https://www.uliege.be}{Univeristy of Liège} (Belgium).\\
+\href{https://www.uliege.be}{University of Liège} (Belgium).\\
Although directly inspired from these guidelines, \themename was stripped out of
any mention or specificities related the University and its faculties. This
makes the \themename theme perfectly suitable for many different contexts.
@@ -130,6 +130,26 @@ Any feature request, issue report or merge requests are welcome.
%% ------------------------------------
\section{Getting Started}
+\subsection{Installing from CTAN}
+The latest stable version of \themename is available on
+\href{https://ctan.org/pkg/beamertheme-trigon}{CTAN} and should now be part of
+the usual \TeX\ distibutions (\TeX\ Live, Mac\TeX\ , Mik\TeX\ ), under the name
+\textit{beamertheme-trigon}. It means that if your distribution is kept
+up-to-date, the package should normally be already installed on your system. If
+this is not the case, consider updating the packages of your Tex distribution.
+
+For \TeX\ Live and Mac\TeX\ users, this usually means running
+\begin{lstlisting}
+tlmgr update --all
+\end{lstlisting}
+, or if administrative privileges are required
+\begin{lstlisting}
+sudo tlmgr update --all
+\end{lstlisting}
+
+For Mik\TeX\ users, please refer to \href{https://miktex.org/howto/update-miktex}{the official Mik\TeX\ documentation}.
+
+
\subsection{Installing from Gitlab}
If you want to use the cutting-edge development version of \themename, you can
@@ -163,14 +183,17 @@ options for advanced users:
\end{description}
-\subsection{Other install methods}
+\subsection{Overleaf}
+As of the writing of this documentation (September 5,2021), the theme is not yet
+natively supported on Overleaf. It will be added once they update their package
+list, which is planned for end of Q3 2021
+(\href{https://gitlab.com/thlamb/beamertheme-trigon/-/issues/1#note_558034187}{see
+discussion on that topic}).
-\themename will be proposed for integration on \href{https://www.ctan.org}{CTAN}
-shortly. It will then hopefully be integrated to texlive, miktex, etc. In the
-meantime, only the installation from Gitlab is possible.
+In the meantime, a \href{https://www.overleaf.com/read/dvbnhdcbfknk}{template
+project} was created on Overleaf so users can just copy this project and use
+that as a basis for their own presentation.
-Once accepted on CTAN, the theme will also be made available on
-\href{https://www.overleaf.com}{Overleaf}.
\subsection{A Minimal Example}
@@ -243,6 +266,11 @@ Vogelgesang, many of \textsc{Metropolis} options are also available in
\subsubsection{Main theme}
+\DescribeOption{background}{light,dark}{light}{%
+ Provides the option to have a dark background and light foreground instead of
+ the reverse.
+}
+
\DescribeOption{titleformat}%
{regular, smallcaps, allsmallcaps, allcaps}
{regular}{
@@ -254,7 +282,7 @@ Vogelgesang, many of \textsc{Metropolis} options are also available in
}
\DescribeOption{usesourcefonts}{true,false}{true}{%
- Choses if the |sourcesanspro| font package should be loaded |true| or not
+ Chooses if the |sourcesanspro| font package should be loaded |true| or not
|false|.
}
@@ -342,14 +370,15 @@ Vogelgesang, many of \textsc{Metropolis} options are also available in
and |example|.
}
-\DescribeOption{headingcolor}{black, theme}{black}{
+\DescribeOption{headingcolor}{default, theme}{default}{
Controls weather the color of all headings (title page, frame title, etc.)
- should be in |black| in a slightly darker shade of the theme color |theme|.
+ should be in black (|default|) or in a slightly darker shade of the theme
+ color |theme|.
}
-\DescribeOption{textgcolor}{black, theme}{black}{
- Controls weather the color of the regular text elements should be in |black|
- in a slightly darker shade of the theme color |theme|.
+\DescribeOption{textgcolor}{default, theme}{default}{
+ Controls weather the color of the regular text elements should be in black
+ (|default|) or in a slightly darker shade of the theme color |theme|.
}
\subsubsection{Font theme}
@@ -369,7 +398,7 @@ Vogelgesang, many of \textsc{Metropolis} options are also available in
The included \themename color theme is used by default, but its colors can be
easily changed to suit your tastes. All of the theme's styles are defined in
-terms of four colors:
+terms of a few main colors:
\begin{itemize}
\item |tPrim| The primary theme color, used for main triangle elements, and
for headings and text if the appropriate options are selected.
@@ -378,6 +407,10 @@ terms of four colors:
\item |tAccent| The accent color, used mostly for alerted text.
\item |tGrey| A grey color, used for background elements (triangles, blocks,
etc.).
+ \item |tTxt| The default text color.
+ \item |tBg| The default background color.
+ \item |tGreyBg| A tint of grey to use for the triangle elements.
+ \item |tTheme| A tint of the |tPrim| color to use for some triangle elements.
\end{itemize}
An easy way to customize the theme is to redefine these colors using
@@ -385,8 +418,7 @@ An easy way to customize the theme is to redefine these colors using
\begin{lstlisting}
\colorlet{tPrim}{ ... }
\colorlet{tSec}{ ... }
- \colorlet{tAccent}{ ... }
- \colorlet{tGrey}{ ... }
+ ...
\end{lstlisting}
in your preamble.
@@ -439,7 +471,7 @@ only alphabetic characters and do not require the expansion of any macros.
\section{License}
\themename is licensed under the terms of the
-\href{https://creativecommons.org/licenses/by-sa/4.0/}{Creative Commons
+\href{https://creativecommons.org/licenses/by-sa/4.0/}{Creative Commons
Attribution-ShareAlike 4.0} license.