Presentation with glossaries (#4)

.gitignore

@@ -8,12 +8,10 @@
 *.lof
 *.log
 *.lot
-*.nav
 *.nlo
 *.nls
 *.out
 *.pdf
-*.snm
 *.synctex.gz
 *.toc
 *.fls
@@ -23,5 +21,20 @@
 *.cls
 *.bst
 *.gin
+*.nav
+*.snm
+# glossary files
+*.acn
+*.acr
+*.alg
+*.glg
+*.glo
+*.gls
+*.ist
+*.glsdefs
+*.slg
+*.syg
+*.syi
 # Do not initialize twice
 .prepared
+packages.txt

.latexmkrc

@@ -1,5 +1,13 @@
 $pdf_mode = 1;
 $pdflatex = 'pdflatex --shell-escape -interaction=nonstopmode %O %S -file-line-error -synctex=1';
+
+# Custom dependency and function for glossaries package
+add_cus_dep('glo', 'gls', 0, 'makeglo2gls');
+add_cus_dep('acn', 'acr', 0, 'makeglo2gls');
+sub makeglo2gls {
+        system("makeglossaries $_[0]");
+}
+
 # Custom dependency and function for nomencl package
 add_cus_dep( 'nlo', 'nls', 0, 'makenlo2nls' );
 sub makenlo2nls {

presentation.tex

@@ -84,19 +84,32 @@ \section*{}
 \begin{frame}{Content}
 \tableofcontents
 \end{frame}
+
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%%%%%%%%%% Content starts here %%%%%%%%%%
+%%%%%%%%%% Glossary entries    %%%%%%%%%%
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
-\section{Logo}
-\begin{frame}{Logo}
-\framesubtitle{In Blau}
-%#1 Breite
-%#2 Datei (liegt im image Verzeichnis)
-%#3 Beschriftung
-%#4 Label fuer Referenzierung
-\image{.25\textwidth}{\meta/config/images/logo.png}{Uni-Logo}{img:logo}
-\end{frame}
+\newacronym{ieee}{IEEE}{Institute of Electrical and Electronics Engineers}
+
+\newglossaryentry{latex}
+{
+        name=latex,
+        description={Is a mark up language specially suited for scientific documents}
+}
+
+\newglossaryentry{symb:Pi}
+{
+        name=\ensuremath{\pi},
+        description={Geometrical value},
+        type=symbolslist
+}
+
+\lstset{language=TeX}
+
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%% Content starts here %%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{Git Version}
 \begin{frame}{Git Version}\framesubtitle{\gitAbbrevHash}
@@ -119,32 +132,47 @@ \section{Git Version}
 \end{frame}
 
 \section{Grafiken}
-\begin{frame}{Grafiken mit Tikz}
-  Grafiken im TikZ-Framework\footnote{\url{http://www.tn-home.de/TUGDD/Stuff/TikZ_final.pdf}} lassen sich mit dem Befehl \textbackslash scaletikzimage\{Datei im Image Verzeichnis\}\{Beschriftung\}\{Label\}\{Skalierungsfaktor\} einbinden. \scaletikzimage{tikz}{TikZ-Grafik}{img:tikz}{0.9}
+\begin{frame}[containsverbatim]{Bilder}
+\framesubtitle{In Blau}
+Bilder befinden sich im Image-Ordner und lassen sich mit \lstinline|\image{Breite}{Datei im Image-Verzeichnis}{Beschriftung}{Label}| einbinden.
+\image{3cm}{logo.png}{Uni-Logo}{img:uni}
+Die Referenzierung erfolgt mittels \lstinline|\autoref{Label}|, also z.B. \autoref{img:uni}.
+\end{frame}
+
+\begin{frame}[containsverbatim]{Grafiken mit Tikz}
+Grafiken im TikZ-Framework\footnote{\url{http://www.tn-home.de/TUGDD/Stuff/TikZ_final.pdf}} lassen sich mit dem Befehl \lstinline|\scaletikzimage{Datei im Image Verzeichnis}{Beschriftung}{Label}{Skalierungsfaktor}| einbinden. \scaletikzimage{tikz}{TikZ-Grafik}{img:tikz}{0.9}
 \end{frame}
 
-\begin{frame}{Grafiken mit moeptikz}
-Grafiken mit Netzwerksymbolen können einfach mit moeptikz\footnote{\url{https://github.com/moepinet/moeptikz}} erstellt werden:
+\begin{frame}[containsverbatim]{Grafiken mit moeptikz}
+Grafiken mit Netzwerksymbolen können einfach mit moeptikz\footnote{\url{https://github.com/moepinet/moeptikz}} erstellt und mit \lstinline|\scaletikzimage{}{}{}| eingebunden werden:
 \scaletikzimage{network}{Example Network}{img:topo}{0.9}
 \end{frame}
 
-\begin{frame}{Grafiken mit Tikz-UML}
-UML basierte Grafiken können einfach mit tikz-uml\footnote{\url{https://perso.ensta-paris.fr/~kielbasi/tikzuml/index.php}} erstellt werden:
+\begin{frame}[containsverbatim]{Grafiken mit Tikz-UML}
+UML basierte Grafiken können einfach mit tikz-uml\footnote{\url{https://perso.ensta-paris.fr/~kielbasi/tikzuml/index.php}} erstellt werden und mit \lstinline|\scaletikzimage{}{}{}| eingebunden werden:
 \scaletikzimage{sequence}{Example Sequence}{img:seq}{0.9}
 \end{frame}
 
 
 \section{Tabellen}
-\begin{frame}{Tabellen}
-Tabellen lassen sich mit dem Environment\\
-\textbackslash begin\{longtable\}[H h t b c]\{Spaltendefinitionen\} ...\\
-\qquad\qquad \textbackslash caption\{Tabellenunterschrift\}\\
-\qquad\qquad \textbackslash label\{Label\}\\
-\textbackslash end\{longtable\}\\
- definieren\footnote{\url{ftp://ftp.dante.de/pub/tex/macros/latex/required/tools/longtable.pdf}}\\
+\begin{frame}[containsverbatim]{Tabellen}
+Tabellen, siehe \autoref{lst:table}, lassen sich mit dem Environment \lstinline|longtable| definieren\footnote{\url{ftp://ftp.dante.de/pub/tex/macros/latex/required/tools/longtable.pdf}}.
+
+\begin{lstlisting}[caption=Tabelle, language=TeX, label=lst:table]
+\begin{longtable}[H h t b c]{Spaltendefinitionen} \\
+Zelle 1 & Zelle 2 & ... & Zelle n \\
+... \\
+Zelle x & Zelle y & ... & Zelle z \\
+\caption{Tabellenunterschrift}
+\label{Label}
+\end{longtable}
+\end{lstlisting}
+
 \begin{longtable}[H]{|p{0.2\textwidth}|p{0.2\textwidth}|p{0.2\textwidth}|}
 \hline
-A&B&C\\
+Zelle 1 & Zelle 2 & Zelle n \\
+\hline
+Zelle x & Zelle y & Zelle z \\
 \hline
 \caption{Tabelle 1}
 \label{tab:tab1}
@@ -154,19 +182,44 @@ \section{Tabellen}
 \section{Code-Ausschnitte}
 
 \begin{frame}[containsverbatim]{Pseudo-Code}
-Pseudo-Code Ausschnitte lassen sich mit \textbackslash pseudo\{Name des Algorithmus\}\{Label\}\{Datei im Code-Verzeichnis\} einbinden.
+Pseudo-Code Ausschnitte lassen sich mit \lstinline|pseudo{Name des Algorithmus}{Label}{Datei im Code-Verzeichnis}| einbinden.
 \pseudo{Mittelwert}{lst:mean}{code}
 \end{frame}
 
 \begin{frame}[containsverbatim]{Programmiersprachen}
-Code Ausschnitte lassen sich einfach mit listings verwenden z.B. in der Umgebung \textbackslash begin\{lstlisting\} ... \textbackslash end\{lstlisting\}, wie in \autoref{lst:python} gezeigt.
+Code Ausschnitte lassen sich einfach mit listings verwenden z.B. in der Umgebung \lstinline|\begin{lstlisting} ... \end{lstlisting}|, wie in \autoref{lst:python} gezeigt.
 
 \begin{lstlisting}[language=Python, caption={Simple Python program}, label=lst:python]
 def my_function():
   print("Hello from a function")
 \end{lstlisting}
 \end{frame}
 
+\section{Abkürzungen und Glossar}
+
+\begin{frame}[containsverbatim]{Abkürzungen}
+Abkürzungen können mit \lstinline|\newacronym{ieee}{IEEE}{Institute of Electrical and Electronics Engineers}| angegeben werden. Diese werden alphabetisch sortiert in ein Abkürzungsverzeichnis aufgenommen und im Text z.B. mit \lstinline|\gls{ieee}| referenziert, dies führt bei Verwendung zu \gls{ieee}.
+\end{frame}
+
+\begin{frame}[containsverbatim]{Glossar}
+Glossareinträge können, wie in \autoref{lst:glossar} gezeigt, angelegt werden. Diese können im Text ebenfalls mit \lstinline|\gls{latex}| referenziert werden, z.B. \gls{latex}.
+\begin{lstlisting}[caption=Glossareinträge, label=lst:glossar, language=TeX]
+ \newglossaryentry{latex}{
+        name=latex,
+        description={Is a mark up language specially suited for scientific documents}}
+\end{lstlisting}
+\end{frame}
+
+\begin{frame}[containsverbatim]{Symbole}
+Symbole aus dem Symbolverzeichnis können ebenfalls mit \lstinline|\gls{symb:Pi}| genutzt werden und erzeugen dann \gls{symb:Pi}, wenn der Eintrag wie in \autoref{lst:symbol}
+\begin{lstlisting}[caption=Einträge für das Symbolverzeichnis, label=lst:symbol, language=TeX]
+\newglossaryentry{symb:Pi}{
+        name=\ensuremath{\pi},
+        description={Geometrical value},
+        type=symbolslist}
+\end{lstlisting}
+\end{frame}
+
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 %%%%%%%%%% References          %%%%%%%%%%