From 6e32f2f52ec8f2fa26683a91a2e73421538aff8d Mon Sep 17 00:00:00 2001 From: ZeroPointMax Date: Wed, 4 May 2022 12:33:36 +0200 Subject: [PATCH 01/18] let's test --- .vscode/settings.json | 1 - README.md | 24 +++++++---------- abk.tex | 17 +++++++----- build/components/package.config.tex | 2 +- build/components/setup.tex | 40 ++--------------------------- build/template.tex | 11 ++++---- config.tex | 3 +++ 7 files changed, 30 insertions(+), 68 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 3cf714b..762a1d2 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,6 +1,5 @@ { "cSpell.words": [ - "acro", "amssymb", "Autorreferat", "belowskip", diff --git a/README.md b/README.md index 9b42213..d8d6fd4 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Inoffizielles LaTeX-Template für Projektarbeiten für Technik-Studiengänge an - [Abbildungen](#abbildungen) - [LaTeX Abbildungen](#latex-abbildungen) - [dhge-latex Abbildungen](#dhge-latex-abbildungen) -- [Abkürzungen](#abkürzungen) +- [Abkürzungen und Glossareinträge](#abkürzungen-und-glossareinträge) - [Anlagenverzeichnis](#anlagenverzeichnis) - [Verwendung](#verwendung) - [Longfigure](#longfigure) @@ -287,32 +287,26 @@ Beispiel: Der `dhgefigure` Befehl wird nun auch als Snippet für Visual-Studio-Code mitgeliefert. -# Abkürzungen +# Abkürzungen und Glossareinträge ```latex -\DeclareAcronym{1}{ - short = {2}, - long = {3} - } +\newacronym{key}{short}{long} ``` -1. ID der Abkürzung, damit wird im Fließtext später referenziert. -2. Die Abkürzung selbst -3. Der ausgeschriebene Begriff +1. ``key``: ID der Abkürzung, damit wird im Fließtext später referenziert. +2. ``short``: Die Abkürzung selbst +3. ``long``: Der ausgeschriebene Begriff Beispielweise: ```latex -\DeclareAcronym{dhge}{ - short = {DHGE}, - long = {Duale Hochschule Gera-Eisenach} -} +\newacronym[]{ac:dhge}{DHGE}{Duale Hochschule Gera-Eisenach} ``` Im Fließtext wird dann mit ```latex -\ac{dhge} +\gls{ac:dhge} ``` die Abkürzung aufgerufen. @@ -401,7 +395,7 @@ Das Abkürzungsverzeichnis wird dann automatisch erstellt. Dabei ist zu beachten Für das Erstellen von Abkürzungen wird nun auch ein Snippet für Visual-Studio-Code mitgeliefert: `abk` / `dhgeabk`. -Für mehr Informationen kann die [Acro Package Documentation](https://mirror.physik.tu-berlin.de/pub/CTAN/macros/latex/contrib/acro/acro-manual.pdf) gelesen werden. +Für mehr Informationen kann die [Glossaries Package Documentation](https://ctan.org/pkg/glossaries?lang=de) gelesen werden. # Anlagenverzeichnis diff --git a/abk.tex b/abk.tex index f1cfd0b..d813513 100644 --- a/abk.tex +++ b/abk.tex @@ -1,9 +1,12 @@ -% Definieren Sie hier Ihre Abkürzungen anhand des DHGE Beispiels. -% Wenn Sie DHGE dann im Text verwenden, rufen sie einfach \ac{dhge} auf. +% Definieren Sie hier Ihre Abkürzungen und Glossar-Einträge anhand der Beispiele. +% Wenn Sie diese dann im Text verwenden, rufen Sie einfach \gls{key} auf, z.B. \gls{ac:dhge}. % LaTeX kümmert sich um den Rest. -% Für alles Weitere schauen Sie sich bitte die Dokumentation des Acro Packages an. +% Wenn alle Abkürzungen auch ohne Verweis darauf generiert werden sollen, ist ein Schalter dafür in config.tex verfügbar. +% Eine ausführliche, anfängerfreundliche Dokumentation ist unter https://www.overleaf.com/learn/latex/Glossaries abrufbar. -\DeclareAcronym{dhge}{ - short = {DHGE}, - long = {Duale Hochschule Gera-Eisenach}, -} +%\newglossaryentry{gls:sso}{ +% name={Single-Sign-On}, +% description={Authentifizierung an mehreren Diensten mit einer Anmeldung} +%} + +\newacronym[]{ac:dhge}{DHGE}{Duale Hochschule Gera-Eisenach} diff --git a/build/components/package.config.tex b/build/components/package.config.tex index a511c33..60156c5 100644 --- a/build/components/package.config.tex +++ b/build/components/package.config.tex @@ -4,7 +4,7 @@ \usepackage[hyperfootnotes = false, hidelinks]{hyperref} \usepackage{amssymb} \usepackage{fancyhdr} -\usepackage[version = 3]{acro} +\usepackage[toc,nonumberlist]{glossaries} \usepackage{enumitem} \usepackage[style=german]{csquotes} \usepackage[backend=biber, diff --git a/build/components/setup.tex b/build/components/setup.tex index 5195f15..110786a 100644 --- a/build/components/setup.tex +++ b/build/components/setup.tex @@ -213,44 +213,8 @@ \makeatother -% ACRO SETUP -\acsetup{ - list/heading = section*, - list/name = {Abkürzungsverzeichnis}, - list/template = description, - make-links = true, - link-only-first = false -} - -% Standard Abkürzungsverzeichnis überschreiben -> einheitliche Einrückung -\RenewAcroTemplate[list]{description}{% - \acronymsmapT{% - \AcroAddRow{% - \textbf{\acrowrite{short}}% - & - \acrowrite{long}% - \acropages - {\acrotranslate{page}\nobreakspace}% - {\acrotranslate{pages}\nobreakspace}% - \vspace{10pt} - \tabularnewline - }% - }% - \acroheading - \acropreamble - \noindent - \begin{tabular}{@{}ll} - \AcronymTable - \end{tabular} -} - -% AUTO REMOVE/INSERT Abkürzungsverzeichnis -% Abkürzungsverzeichnis überschreibt \UseAcroTemplate für \ac -% New Counter to count used acronyms: -\newtotcounter{acro_num} -\def\oldUseAcroTemplate{} \let\oldUseAcroTemplate=\UseAcroTemplate -\def\UseAcroTemplate{\stepcounter{acro_num}\oldUseAcroTemplate} - +% Glossar Setup +\makeglossaries % INDENTION SETUP % Abstände und Einrückungen abhängig von config.tex ein-/ausschalten diff --git a/build/template.tex b/build/template.tex index 60f87d6..8c32863 100644 --- a/build/template.tex +++ b/build/template.tex @@ -79,13 +79,12 @@ \phantomsection \conditionalLoT - % ABKÜRZUNGSVERZEICHNIS - % wird nur dann generiert, wenn mindestens ein mal \ac oder ein verwandter Befehl aufgerufen wurde und damit nicht leer ist - \ifnum\totvalue{acro_num}>0 - \printacronyms - \addcontentsline{toc}{section}{Abkürzungsverzeichnis} - \cleardoublepage + % das Glossaries-Package rendert sich nur, wenn mindestens ein Eintrag hinterlegt ist + \if\CALLGLO 1 % alle Glossar-Einträge unbedingt erzeugen + \glsaddall \fi + \printglossaries + \cleardoublepage \setcounter{savepage}{\arabic{page}} diff --git a/config.tex b/config.tex index a659298..4223019 100644 --- a/config.tex +++ b/config.tex @@ -51,3 +51,6 @@ % 1 setzt Absatztrenner auf Einrückungen, 0 auf vertikale Abstände \def\CEINR {0} + +% 1 lässt alle Glossar- und Abkürzungs-Einträge unbedingt erzeugen, 0 nur bei Referenz darauf +\def\CALLGLO {0} From fcbc4b08491c8c6277bf328b0b20f48aad97df8d Mon Sep 17 00:00:00 2001 From: ZeroPointMax Date: Wed, 11 May 2022 20:20:11 +0200 Subject: [PATCH 02/18] semi-working zwischenstand --- build/components/package.config.tex | 2 +- build/components/setup.tex | 5 ++--- build/template.tex | 8 +++++--- config.tex | 5 ++++- 4 files changed, 12 insertions(+), 8 deletions(-) diff --git a/build/components/package.config.tex b/build/components/package.config.tex index 60156c5..77ad00a 100644 --- a/build/components/package.config.tex +++ b/build/components/package.config.tex @@ -4,7 +4,7 @@ \usepackage[hyperfootnotes = false, hidelinks]{hyperref} \usepackage{amssymb} \usepackage{fancyhdr} -\usepackage[toc,nonumberlist]{glossaries} +\usepackage[toc,nonumberlist,style=super]{glossaries} \usepackage{enumitem} \usepackage[style=german]{csquotes} \usepackage[backend=biber, diff --git a/build/components/setup.tex b/build/components/setup.tex index 110786a..e842d8a 100644 --- a/build/components/setup.tex +++ b/build/components/setup.tex @@ -155,7 +155,7 @@ \newlistof{anlagen}{alt}{\listanlageverzeichnis} % Befehl welcher ein Item dem Anlagenverzeichnis hinzufügt -\newcommand{\addItemToAnlageverzeichnis}[1]{% +\newcommand{\addItemToAnlageverzeichnis}[1]{ \def\fig{fig} \def\tab{tab} @@ -212,9 +212,8 @@ } \makeatother - % Glossar Setup -\makeglossaries +\makenoidxglossaries % INDENTION SETUP % Abstände und Einrückungen abhängig von config.tex ein-/ausschalten diff --git a/build/template.tex b/build/template.tex index 8c32863..a76f0f6 100644 --- a/build/template.tex +++ b/build/template.tex @@ -20,6 +20,7 @@ % Abkürzungen müssen früher eingefügt werden, da sie % nicht als Text, sondern als Variablen definiert werden +\glsenableentrycount % Glossaries zählt Verwendung von Einträgen für bedingte Ausgabe des Glossars \input{abk.tex} @@ -79,12 +80,13 @@ \phantomsection \conditionalLoT - % das Glossaries-Package rendert sich nur, wenn mindestens ein Eintrag hinterlegt ist \if\CALLGLO 1 % alle Glossar-Einträge unbedingt erzeugen \glsaddall \fi - \printglossaries - \cleardoublepage + \if\CHASGLO 1 % füge das Glossar nur hinzu, wenn die Option in config.tex gesetzt ist + \printnoidxglossaries + \cleardoublepage + \fi \setcounter{savepage}{\arabic{page}} diff --git a/config.tex b/config.tex index 4223019..0591b13 100644 --- a/config.tex +++ b/config.tex @@ -46,6 +46,9 @@ % 1 aktiviert das Einbinden des Abstracts \def\CHASABSTRACT {0} +% 1 aktiviert das Glossar (Abkürzungsverzeichnis) +\def\CHASGLO {1} + % 1 aktiviert den Font-Vorschlag, 0 deaktiviert ihn \def\CFANCYFONTS {1} @@ -53,4 +56,4 @@ \def\CEINR {0} % 1 lässt alle Glossar- und Abkürzungs-Einträge unbedingt erzeugen, 0 nur bei Referenz darauf -\def\CALLGLO {0} +\def\CALLGLO {1} From cf7b9d00489d1eec8740d279c3ac7a01220455d6 Mon Sep 17 00:00:00 2001 From: ZeroPointMax Date: Thu, 12 May 2022 18:37:20 +0200 Subject: [PATCH 03/18] bugfix: no empty page before glossary (see comment in source) --- build/components/setup.tex | 6 ------ build/template.tex | 7 ++++++- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/build/components/setup.tex b/build/components/setup.tex index e842d8a..5e6d151 100644 --- a/build/components/setup.tex +++ b/build/components/setup.tex @@ -21,10 +21,6 @@ % DOCUMENT SETUP \onehalfspacing % 1.5 line spacing -% TODO: sollte theoretisch keine Verwendung mehr haben -% \widowpenalty10000 -% \clubpenalty10000 - % INHALTSVERZEICHNIS SETUP \renewcommand{\contentsname}{Inhaltsverzeichnis} @@ -137,14 +133,12 @@ \ifnum\totvalue{figCount}>0 \addcontentsline{toc}{section}{\listfigurename} \listoffigures - \cleardoublepage \fi } \newcommand{\conditionalLoT}{ \ifnum\totvalue{tabCount}>0 \addcontentsline{toc}{section}{\listtablename} \listoftables - \cleardoublepage \fi } diff --git a/build/template.tex b/build/template.tex index a76f0f6..4c98baf 100644 --- a/build/template.tex +++ b/build/template.tex @@ -20,7 +20,6 @@ % Abkürzungen müssen früher eingefügt werden, da sie % nicht als Text, sondern als Variablen definiert werden -\glsenableentrycount % Glossaries zählt Verwendung von Einträgen für bedingte Ausgabe des Glossars \input{abk.tex} @@ -75,17 +74,23 @@ % ABBILDUNGSVERZEICHNIS \phantomsection \conditionalLoF + \cleardoublepage % TABELLENVERZEICHNIS \phantomsection \conditionalLoT + % Hinweis: wenn sowohl Tabellenverzeichnis als auch Abbildungsverzeichnis leer sind, ist eine leere Seite vor dem Glossar + % in dem Falle bitte eine \cleardoublepage oben löschen + \if\CALLGLO 1 % alle Glossar-Einträge unbedingt erzeugen \glsaddall \fi + \if\CHASGLO 1 % füge das Glossar nur hinzu, wenn die Option in config.tex gesetzt ist \printnoidxglossaries \cleardoublepage + \else \cleardoublepage % Glossaries fügt von selbst einen page break ein - nur notwendig, wenn KEIN Glossar \fi \setcounter{savepage}{\arabic{page}} From 614ba78d13ab3e46827a4c7ee0d3e09c1cb596e4 Mon Sep 17 00:00:00 2001 From: ZeroPointMax Date: Thu, 12 May 2022 20:47:13 +0200 Subject: [PATCH 04/18] regression fix: jetzt aber --- README.md | 11 +++++++++++ build/components/setup.tex | 2 ++ build/template.tex | 8 ++------ config.tex | 5 +---- main.tex | 1 + 5 files changed, 17 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d8d6fd4..7bf5136 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,8 @@ Inoffizielles LaTeX-Template für Projektarbeiten für Technik-Studiengänge an - [Probleme im Kusche Mode](#probleme-im-kusche-mode) - [Abstract](#abstract) - [Absatztrenner](#absatztrenner) +- [Troubleshooting](#troubleshooting) + - [Glossaries](#glossaries) # Installation @@ -507,3 +509,12 @@ Der LaTeX Standard sind Einrückungen, Abstände sind aus beliebten WYSIWYG-Edit An der Studienrichtung Technik der DHGE werden Abstände in Arbeiten bevorzugt, weshalb das die Voreinstellung des Templates ist. Wenn Einrückungen bevorzugt werden, kann das in der ``config.tex`` geändert werden, indem der ``CEINR``-Schalter auf ``1`` gesetzt wird. + +# Troubleshooting + +## Glossaries + +- Symptom: das Glossar ist leer + - Prüfen Sie, ob Sie mit ``\gls`` auf mindestens ein Glossar-Eintrag verweisen oder ``CALLGLO`` in ``config.tex`` auf ``1`` gesetzt haben + - Wenn Sie kein ``latexmk`` verwenden, müssen Sie ggf. zwei mal kompilieren + - entfernen Sie den Projekt-Cache (``template.aux``, ``template.bbl``, ``template.bcf``, ``template.blg``, ...) und kompilieren Sie erneut (ggf. zwei mal) diff --git a/build/components/setup.tex b/build/components/setup.tex index 5e6d151..e6f186a 100644 --- a/build/components/setup.tex +++ b/build/components/setup.tex @@ -133,12 +133,14 @@ \ifnum\totvalue{figCount}>0 \addcontentsline{toc}{section}{\listfigurename} \listoffigures + \cleardoublepage \fi } \newcommand{\conditionalLoT}{ \ifnum\totvalue{tabCount}>0 \addcontentsline{toc}{section}{\listtablename} \listoftables + \cleardoublepage \fi } diff --git a/build/template.tex b/build/template.tex index 4c98baf..98cc2fb 100644 --- a/build/template.tex +++ b/build/template.tex @@ -74,7 +74,6 @@ % ABBILDUNGSVERZEICHNIS \phantomsection \conditionalLoF - \cleardoublepage % TABELLENVERZEICHNIS \phantomsection @@ -87,11 +86,8 @@ \glsaddall \fi - \if\CHASGLO 1 % füge das Glossar nur hinzu, wenn die Option in config.tex gesetzt ist - \printnoidxglossaries - \cleardoublepage - \else \cleardoublepage % Glossaries fügt von selbst einen page break ein - nur notwendig, wenn KEIN Glossar - \fi + \begingroup\let\newpage\relax\printnoidxglossaries\endgroup % Glossaries die leere Seite vor dem Glossar austreiben, wegen LoF, LoT + \cleardoublepage \setcounter{savepage}{\arabic{page}} diff --git a/config.tex b/config.tex index 0591b13..4223019 100644 --- a/config.tex +++ b/config.tex @@ -46,9 +46,6 @@ % 1 aktiviert das Einbinden des Abstracts \def\CHASABSTRACT {0} -% 1 aktiviert das Glossar (Abkürzungsverzeichnis) -\def\CHASGLO {1} - % 1 aktiviert den Font-Vorschlag, 0 deaktiviert ihn \def\CFANCYFONTS {1} @@ -56,4 +53,4 @@ \def\CEINR {0} % 1 lässt alle Glossar- und Abkürzungs-Einträge unbedingt erzeugen, 0 nur bei Referenz darauf -\def\CALLGLO {1} +\def\CALLGLO {0} diff --git a/main.tex b/main.tex index 22ad618..ed09cca 100644 --- a/main.tex +++ b/main.tex @@ -1,2 +1,3 @@ % hier können Sie Ihre Arbeit schreiben. % für ein Beispiel siehe `build/tests/` +Piep From 08af8e517bc0df6c4137e806f16ef34efae2cdbe Mon Sep 17 00:00:00 2001 From: ZeroPointMax Date: Thu, 12 May 2022 21:27:33 +0200 Subject: [PATCH 05/18] doku doku doku --- README.md | 122 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 64 insertions(+), 58 deletions(-) diff --git a/README.md b/README.md index 7bf5136..6244cd6 100644 --- a/README.md +++ b/README.md @@ -27,6 +27,8 @@ Inoffizielles LaTeX-Template für Projektarbeiten für Technik-Studiengänge an - [LaTeX Abbildungen](#latex-abbildungen) - [dhge-latex Abbildungen](#dhge-latex-abbildungen) - [Abkürzungen und Glossareinträge](#abkürzungen-und-glossareinträge) + - [Abkürzungen](#abkürzungen) + - [Glossareinträge](#glossareinträge) - [Anlagenverzeichnis](#anlagenverzeichnis) - [Verwendung](#verwendung) - [Longfigure](#longfigure) @@ -291,6 +293,8 @@ Der `dhgefigure` Befehl wird nun auch als Snippet für Visual-Studio-Code mitgel # Abkürzungen und Glossareinträge +## Abkürzungen + ```latex \newacronym{key}{short}{long} ``` @@ -302,7 +306,7 @@ Der `dhgefigure` Befehl wird nun auch als Snippet für Visual-Studio-Code mitgel Beispielweise: ```latex -\newacronym[]{ac:dhge}{DHGE}{Duale Hochschule Gera-Eisenach} +\newacronym{ac:dhge}{DHGE}{Duale Hochschule Gera-Eisenach} ``` Im Fließtext wird dann mit @@ -315,89 +319,91 @@ die Abkürzung aufgerufen. Dies sind die Pflicht-Argumente. Es gibt weitere Einstellungsmöglichkeiten bei dem Deklarieren von Abkürzungen, die in der unten stehenden Dokumentation nachgelesen werden können. Eine sinnvolle Auswahl davon: ```latex -\DeclareAcronym{1}{ - short = {2}, - long = {3}, - short-plural = {4}, - long-plural = {5}, - alt = {8} - } +\newacronym [ + longplural={1}, + shortplural={2} +] {3}{4}{5} ``` -ODER +1. Die ausgeschriebene Pluralform +2. Die Pluralform der Abkürzung +3. ID der Abkürzung, damit wird im Fließtext später referenziert +4. Die Abkürzung selbst +5. Der ausgeschriebene Begriff -```latex -\DeclareAcronym{1}{ - short = {2}, - long = {3}, - short-plural-form = {6}, - long-plural-form = {7}, - alt = {8} - } -``` +Die Optionen 1 und 2 sind optional. +Beachten Sie jedoch, dass die Optionen mit einem Komma getrennt sind. -1. ID der Abkürzung, damit wird im Fließtext später referenziert. -2. Die Abkürzung selbst -3. Der ausgeschriebene Begriff -4. Buchstabe oder Silbe, die der Abkürzung im Plural angehangen wird -5. Buchstabe oder Silbe, die dem ausgeschriebenen Wort im Plural angehangen wird -6. Plural-Form der Abkürzung, ersetzt die Abkürzung komplett -7. Plural-Form des Wortes, ersetzt das Wort komplett -8. Alternative zum ausgeschriebenen Wort +An einem Beispiel: -Die Angaben 4 bis 8 sind optional. +```latex +\newacronym [ + longplural={Jacobi-Matrizen}, + shortplural={JMs} +] {ac:jm}{JM}{Jacobi-Matrix} +``` Die Pluralform lässt sich mit ```latex -\acp{1} +\glspl{3} ``` -aufrufen, die Alternativform mit +aufrufen. +Ebenso kann der erste Buchstabe einer Abkürzung groß geschrieben werden (wenn er in der Abkürzung selbst klein geschrieben ist): ``\Gls{key}``. +Das ist kombinierbar mit ``\glspl{key}``, also: ```latex -\aca{1} +\Glspl{3} ``` -Beispiel: +Das Abkürzungsverzeichnis wird dann automatisch erstellt. Dabei ist zu beachten, dass unter Umständen bis zu zwei Kompilierungen notwendig sind, wenn eine Abkürzung hinzugefügt oder entfernt wurde, damit das Verzeichnis korrekt erstellt wird. -```latex -\DeclareAcronym{jpg}{ - short = {JPEG}, - long = {Joint Photographic Experts Group}, - short-plural-form = {JPEGs}, - long-plural-form = {Joint Photographic Experts Groups}, - alt = {JPG} - } -``` +*** -ODER +Für das Erstellen von Abkürzungen wird ein Snippet für Visual-Studio-Code mitgeliefert: `abk` / `dhgeabk`. -```latex -\DeclareAcronym{jpg}{ - short = {JPEG}, - long = {Joint Photographic Experts Group}, - short-plural = {s}, - long-plural = {s}, - alt = {JPG} - } -``` +Für mehr Informationen kann die [Glossaries Package Documentation](https://ctan.org/pkg/glossaries?lang=de) gelesen werden. -Aufruf: +## Glossareinträge + +Glossar-Einträge verhalten sich ähnlich zu den eben vorgestellten Abkürzungen und werden ebenso mit ``\gls{key}`` oder möglichen Alternativ-Formen aufgerufen. + +Glossar-Einträge werden im einfachsten Falle wie folgt angelegt: ```latex -\ac{jpg} % Normale Form -\acp{jpg} % Plural-Form -\aca{jpg} % Alternativ-Form +\newglossaryentry{1}{ + name={2}, + description={3} +} ``` -Das Abkürzungsverzeichnis wird dann automatisch erstellt. Dabei ist zu beachten, dass unter Umständen bis zu vier Kompilierungen notwendig sind, wenn eine Abkürzung hinzugefügt oder entfernt wurde, damit das Verzeichnis korrekt erstellt wird. +1. ID des Eintrages, damit wird im Fließtext später referenziert +2. Der Begriff, der im Glossar erklärt werden soll +3. Die Erklärung des Begriffes -*** +Im Fließtext wird dann mit ``\gls{key}`` der Eintrag verknüpft, wobei der Begriff im Text erscheint. -Für das Erstellen von Abkürzungen wird nun auch ein Snippet für Visual-Studio-Code mitgeliefert: `abk` / `dhgeabk`. +Sollte die Beschreibung des Begriffs allerdings **länger** als die verbleibende **Seitenbreite** sein, muss der Eintrag mit ``\longnewglossaryentry`` angelegt werden. +Von den Optionen ändert sich dabei nichts. -Für mehr Informationen kann die [Glossaries Package Documentation](https://ctan.org/pkg/glossaries?lang=de) gelesen werden. +An einem Beispiel: + +```latex +\newglossaryentry{gls:ereignisanzeige}{ + name={Ereignisanzeige}, + description={Zentrale Schnittstelle für Logs auf Microsoft Windows Systemen} +} +``` + +Im Fließtext wird dann referenziert: + +```latex +[...] +Eine entsprechende Fehlermeldung war \gls{gls:ereignisanzeige} zu sehen. +[...] +``` + # Anlagenverzeichnis From abba328ea3901df882ab712eb3b474ee9d77d850 Mon Sep 17 00:00:00 2001 From: ZeroPointMax Date: Thu, 12 May 2022 21:34:28 +0200 Subject: [PATCH 06/18] glossaries snippets --- .vscode/tex_snippets.code-snippets | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/.vscode/tex_snippets.code-snippets b/.vscode/tex_snippets.code-snippets index dbe03ce..24c6ad2 100644 --- a/.vscode/tex_snippets.code-snippets +++ b/.vscode/tex_snippets.code-snippets @@ -9,19 +9,27 @@ "Abkürzung": { "prefix": ["abk", "dhgeabk"], // auf welchem namen der snippet auffindbar ist "scope": "latex,tex", // welche files der snippet betreffen soll - "body": ["\\DeclareAcronym{${1:ac-used-name}}{", - " short = {${2:abk}},", - " long = {${3:non_abk}}", - "}" + "body": ["\\newacronym{${1:abk-id}}", + " {${2:abk}}", + " {${3:non_abk}}" ], // einzufügender snippet - "description": "Insert \\DeclareAcronym" // beschreibung + "description": "Insert \\newacronym" // beschreibung }, "Abkürzung - singleline": { "prefix": ["singleabk", "singledhgeabk"], // auf welchem namen der snippet auffindbar ist "scope": "latex,tex", // welche files der snippet betreffen soll - "body": ["\\DeclareAcronym{${1:ac-used-name}}{short = {${2:abk}}, long = {${3:non_abk}}}" + "body": ["\\newacronym{${1:abk-id}}{{${2:abk}}{${3:non_abk}}}" ], // einzufügender snippet "description": "Insert singleline \\DeclareAcronym" // beschreibung + }, + "Glossar": { + "prefix": ["gls", "dhgegls"], // auf welchem namen der snippet auffindbar ist + "scope": "latex,tex", // welche files der snippet betreffen soll + "body": ["\\newglossaryentry{${1:gls-id}}", + " {${2:name}}", + " {${3:desc}}" + ], // einzufügender snippet + "description": "Insert \\newglossaryentry" // beschreibung }, // Im 'body' könne parameter verwendet werden, um bestimmte Ziele zu erreichen. (z.B. tabbing) // Nummern entsprechen Reihenfolge From 77eacb3e3a4b5c481559d7551be2579c98280e03 Mon Sep 17 00:00:00 2001 From: ZeroPointMax Date: Thu, 12 May 2022 21:45:24 +0200 Subject: [PATCH 07/18] doku fixups --- .vscode/settings.json | 33 +++++++++++++++++++++++++++++++++ README.md | 19 +++++++++++++------ 2 files changed, 46 insertions(+), 6 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index 762a1d2..c3a4601 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -5,46 +5,79 @@ "belowskip", "Bera", "biber", + "bspw", + "CALLGLO", "captionsetup", "cauthor", + "CEINR", "CFANCYFONTS", + "CHASABSTRACT", "citestyle", + "CKUSCHE", + "Computerphile", "csquotes", + "CTAN", "deckblatt", "defernumbers", "dhge", "dhgefigure", + "dhgeparagraph", "einkommentieren", "enumitem", "etoolbox", "euler", "fancyhdr", "fancyplain", + "footcite", "footmisc", "giveninits", + "glspl", + "graphicspath", "graphicx", + "Hahner", "hidelinks", + "hovern", "hyperfootnotes", "ibidtracker", "icomma", "ifthen", + "includegraphics", + "Kogel", "labelfont", + "latexmk", "literatur", "lmodern", + "longfigure", + "longnewglossaryentry", + "longplural", "mathrm", "minalphanames", "minbibnames", + "newacronym", + "newcommand", + "newglossaryentry", "ngerman", "Palatino", "pdfauthor", + "pdflatex", + "Plantuml", + "Prenote", + "Prillwitz", + "Pygments", "secnumdepth", "setspace", + "shortplural", "singlelinecheck", + "Stackoverflow", + "supercite", + "synctex", + "texstudio", "Thesenblatt", "titletoc", "tocdepth", "tocloft", "totcount", + "usepackage", "xparse", "xpatch" ] diff --git a/README.md b/README.md index 6244cd6..5fe9f25 100644 --- a/README.md +++ b/README.md @@ -26,9 +26,10 @@ Inoffizielles LaTeX-Template für Projektarbeiten für Technik-Studiengänge an - [Abbildungen](#abbildungen) - [LaTeX Abbildungen](#latex-abbildungen) - [dhge-latex Abbildungen](#dhge-latex-abbildungen) -- [Abkürzungen und Glossareinträge](#abkürzungen-und-glossareinträge) +- [Abkürzungen und Glossar-Einträge](#abkürzungen-und-glossar-einträge) - [Abkürzungen](#abkürzungen) - - [Glossareinträge](#glossareinträge) + - [Glossar-Einträge](#glossar-einträge) + - [Weiterführende Dokumentation](#weiterführende-dokumentation) - [Anlagenverzeichnis](#anlagenverzeichnis) - [Verwendung](#verwendung) - [Longfigure](#longfigure) @@ -234,7 +235,7 @@ Beispiel: - Abbildungen werden durch das Template in `assets/img` gefunden. - `\includegraphics{}` entspricht `\includegraphics{assets/img/}` - anpassbar durch `\graphicspath {{}}` - - **``** ist aus der sicht von `build/` zu sehen + - **``** ist aus der Sicht von `build/` zu sehen - `\graphicspath {{../assets/img/}}}` ## LaTeX Abbildungen @@ -291,7 +292,7 @@ Beispiel: Der `dhgefigure` Befehl wird nun auch als Snippet für Visual-Studio-Code mitgeliefert. -# Abkürzungen und Glossareinträge +# Abkürzungen und Glossar-Einträge ## Abkürzungen @@ -365,7 +366,7 @@ Für das Erstellen von Abkürzungen wird ein Snippet für Visual-Studio-Code mit Für mehr Informationen kann die [Glossaries Package Documentation](https://ctan.org/pkg/glossaries?lang=de) gelesen werden. -## Glossareinträge +## Glossar-Einträge Glossar-Einträge verhalten sich ähnlich zu den eben vorgestellten Abkürzungen und werden ebenso mit ``\gls{key}`` oder möglichen Alternativ-Formen aufgerufen. @@ -405,6 +406,12 @@ Eine entsprechende Fehlermeldung war \gls{gls:ereignisanzeige} zu sehen. ``` +## Weiterführende Dokumentation + +[Anfängerfreundliche Glossaries-Doku](https://ctan.mirror.norbert-ruehl.de/macros/latex/contrib/glossaries/glossariesbegin.pdf) + +[Glossaries CTAN-Seite](https://www.ctan.org/pkg/glossaries) + # Anlagenverzeichnis > wird automatisch generiert @@ -451,7 +458,7 @@ Das ist besonders für Code-Beispiele für den Anhang praktisch. *** -Bei Proxy-Problemen mit pip, kann auch das `Pygments.whl` file runtergeladen und dann mit pip installiert werden. +Bei Proxy-Problemen mit pip, kann auch die `Pygments.whl` Datei heruntergeladen und dann mit pip installiert werden. [Pygments Download](https://pypi.org/project/Pygments/#files) # Spezielle Abschnitte From 8711a27de1958eaf97b8ddcd9c20e08d80570f38 Mon Sep 17 00:00:00 2001 From: ZeroPointMax Date: Thu, 12 May 2022 21:46:29 +0200 Subject: [PATCH 08/18] empty main.tex again --- main.tex | 1 - 1 file changed, 1 deletion(-) diff --git a/main.tex b/main.tex index ed09cca..22ad618 100644 --- a/main.tex +++ b/main.tex @@ -1,3 +1,2 @@ % hier können Sie Ihre Arbeit schreiben. % für ein Beispiel siehe `build/tests/` -Piep From dfd6a9840065d3ece8309916570ddb31ada44262 Mon Sep 17 00:00:00 2001 From: ZeroPointMax Date: Mon, 16 May 2022 09:57:09 +0200 Subject: [PATCH 09/18] fix tests --- abk.tex | 8 ++++---- build/tests/abstract.tex | 7 +++---- build/tests/config.tex | 1 + build/tests/main.tex | 4 +++- 4 files changed, 11 insertions(+), 9 deletions(-) diff --git a/abk.tex b/abk.tex index d813513..dc877f9 100644 --- a/abk.tex +++ b/abk.tex @@ -4,9 +4,9 @@ % Wenn alle Abkürzungen auch ohne Verweis darauf generiert werden sollen, ist ein Schalter dafür in config.tex verfügbar. % Eine ausführliche, anfängerfreundliche Dokumentation ist unter https://www.overleaf.com/learn/latex/Glossaries abrufbar. -%\newglossaryentry{gls:sso}{ -% name={Single-Sign-On}, -% description={Authentifizierung an mehreren Diensten mit einer Anmeldung} -%} +\newglossaryentry{gls:gloss}{ + name={Glossar}, + description={Ein Glossar ist eine Liste von Wörtern mit beigefügten Bedeutungserklärungen oder Übersetzungen. (Wikipedia)} +} \newacronym[]{ac:dhge}{DHGE}{Duale Hochschule Gera-Eisenach} diff --git a/build/tests/abstract.tex b/build/tests/abstract.tex index 4d67288..b35d41d 100644 --- a/build/tests/abstract.tex +++ b/build/tests/abstract.tex @@ -1,7 +1,6 @@ Franz jagt im komplett verwahrlosten Taxi quer durch Bayern. -\\ Falsches Üben von Xylophonmusik quält jeden größeren Zwerg. -\\ -Es ist Mittwoch, meine Kerle. -\\ + +Es ist Mittwoch, meine Kerle. Oder ist es Montag, meine Mümmler? + Lorem ipsum dolor sit amet. diff --git a/build/tests/config.tex b/build/tests/config.tex index ed3bd3c..7ed8a42 100644 --- a/build/tests/config.tex +++ b/build/tests/config.tex @@ -17,3 +17,4 @@ \def\CHASABSTRACT {0} \def\CFANCYFONTS {1} \def\CEINR {0} +\def\CALLGLO {1} diff --git a/build/tests/main.tex b/build/tests/main.tex index fe01453..f1df139 100644 --- a/build/tests/main.tex +++ b/build/tests/main.tex @@ -1,9 +1,11 @@ \section{Zitat und Abkürzung Test Section} -Diese Arbeit ist ein Test welcher f\"ur das \ac{dhge} LaTeX Template vorgesehen ist.\footcite{Xmisc} +Diese Arbeit ist ein Test welcher f\"ur das \gls{dhge} LaTeX Template vorgesehen ist.\footcite{Xmisc} Das Template unterstützt auch einen weiteren cite Befehl welcher platzsparender ist.\supercite{Xmisc} +Neben Abkürzungen unterstützt das Template auch Glossar-Einträge mit \gls{gls:gloss}. + \cleardoublepage \subsection{Command Test Subsection} From 0a9d321aafeb217d9a7542d584bc468e2242abdc Mon Sep 17 00:00:00 2001 From: ZeroPointMax Date: Mon, 16 May 2022 10:26:05 +0200 Subject: [PATCH 10/18] or so i thought --- build/tests/main.tex | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/build/tests/main.tex b/build/tests/main.tex index f1df139..03353e4 100644 --- a/build/tests/main.tex +++ b/build/tests/main.tex @@ -1,6 +1,6 @@ \section{Zitat und Abkürzung Test Section} -Diese Arbeit ist ein Test welcher f\"ur das \gls{dhge} LaTeX Template vorgesehen ist.\footcite{Xmisc} +Diese Arbeit ist ein Test welcher f\"ur das \gls{ac:dhge} LaTeX Template vorgesehen ist.\footcite{Xmisc} Das Template unterstützt auch einen weiteren cite Befehl welcher platzsparender ist.\supercite{Xmisc} From 116abb9b94c6251a7526a6a7a9b438e5ba28b228 Mon Sep 17 00:00:00 2001 From: ZeroPointMax Date: Mon, 16 May 2022 15:26:58 +0200 Subject: [PATCH 11/18] apply suggestions from @photovoltex --- .vscode/tex_snippets.code-snippets | 4 +--- README.md | 4 ++-- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/.vscode/tex_snippets.code-snippets b/.vscode/tex_snippets.code-snippets index 24c6ad2..3061021 100644 --- a/.vscode/tex_snippets.code-snippets +++ b/.vscode/tex_snippets.code-snippets @@ -25,9 +25,7 @@ "Glossar": { "prefix": ["gls", "dhgegls"], // auf welchem namen der snippet auffindbar ist "scope": "latex,tex", // welche files der snippet betreffen soll - "body": ["\\newglossaryentry{${1:gls-id}}", - " {${2:name}}", - " {${3:desc}}" + "body": ["\\newglossaryentry{${1:gls-id}}{name=${2:name}}{description=${3:desc}}" ], // einzufügender snippet "description": "Insert \\newglossaryentry" // beschreibung }, diff --git a/README.md b/README.md index 5fe9f25..a49ca44 100644 --- a/README.md +++ b/README.md @@ -347,7 +347,7 @@ An einem Beispiel: Die Pluralform lässt sich mit ```latex -\glspl{3} +\glspl{key} ``` aufrufen. @@ -355,7 +355,7 @@ Ebenso kann der erste Buchstabe einer Abkürzung groß geschrieben werden (wenn Das ist kombinierbar mit ``\glspl{key}``, also: ```latex -\Glspl{3} +\Glspl{key} ``` Das Abkürzungsverzeichnis wird dann automatisch erstellt. Dabei ist zu beachten, dass unter Umständen bis zu zwei Kompilierungen notwendig sind, wenn eine Abkürzung hinzugefügt oder entfernt wurde, damit das Verzeichnis korrekt erstellt wird. From 0e3fe5cc87f519bb335619666f866ae5ee82155a Mon Sep 17 00:00:00 2001 From: ZeroPointMax Date: Mon, 16 May 2022 16:33:59 +0200 Subject: [PATCH 12/18] more suggestions by @photovoltex and more fixups --- .vscode/tex_snippets.code-snippets | 11 +---------- build/components/package.config.tex | 2 +- build/components/setup.tex | 2 ++ build/template.tex | 20 +++++++++----------- 4 files changed, 13 insertions(+), 22 deletions(-) diff --git a/.vscode/tex_snippets.code-snippets b/.vscode/tex_snippets.code-snippets index 3061021..bb9b642 100644 --- a/.vscode/tex_snippets.code-snippets +++ b/.vscode/tex_snippets.code-snippets @@ -9,15 +9,6 @@ "Abkürzung": { "prefix": ["abk", "dhgeabk"], // auf welchem namen der snippet auffindbar ist "scope": "latex,tex", // welche files der snippet betreffen soll - "body": ["\\newacronym{${1:abk-id}}", - " {${2:abk}}", - " {${3:non_abk}}" - ], // einzufügender snippet - "description": "Insert \\newacronym" // beschreibung - }, - "Abkürzung - singleline": { - "prefix": ["singleabk", "singledhgeabk"], // auf welchem namen der snippet auffindbar ist - "scope": "latex,tex", // welche files der snippet betreffen soll "body": ["\\newacronym{${1:abk-id}}{{${2:abk}}{${3:non_abk}}}" ], // einzufügender snippet "description": "Insert singleline \\DeclareAcronym" // beschreibung @@ -25,7 +16,7 @@ "Glossar": { "prefix": ["gls", "dhgegls"], // auf welchem namen der snippet auffindbar ist "scope": "latex,tex", // welche files der snippet betreffen soll - "body": ["\\newglossaryentry{${1:gls-id}}{name=${2:name}}{description=${3:desc}}" + "body": ["\\newglossaryentry{${1:gls-id}}{name={${2:name}}}{description={${3:desc}}}" ], // einzufügender snippet "description": "Insert \\newglossaryentry" // beschreibung }, diff --git a/build/components/package.config.tex b/build/components/package.config.tex index 77ad00a..fc85c3f 100644 --- a/build/components/package.config.tex +++ b/build/components/package.config.tex @@ -4,7 +4,7 @@ \usepackage[hyperfootnotes = false, hidelinks]{hyperref} \usepackage{amssymb} \usepackage{fancyhdr} -\usepackage[toc,nonumberlist,style=super]{glossaries} +\usepackage[toc,nonumberlist,style=super,nopostdot,nogroupskip]{glossaries} \usepackage{enumitem} \usepackage[style=german]{csquotes} \usepackage[backend=biber, diff --git a/build/components/setup.tex b/build/components/setup.tex index e6f186a..78cb167 100644 --- a/build/components/setup.tex +++ b/build/components/setup.tex @@ -209,6 +209,8 @@ \makeatother % Glossar Setup +\renewcommand{\glsnamefont}[1]{\textbf{#1}} +\setlength{\glsdescwidth}{0.65\textwidth} \makenoidxglossaries % INDENTION SETUP diff --git a/build/template.tex b/build/template.tex index fc64739..e959c33 100644 --- a/build/template.tex +++ b/build/template.tex @@ -39,7 +39,6 @@ \author{} \date{} - \begin{document} \pagenumbering{gobble} % lade Deckblatt ohne Nummerierung @@ -79,16 +78,11 @@ \phantomsection \conditionalLoT - % Hinweis: wenn sowohl Tabellenverzeichnis als auch Abbildungsverzeichnis leer sind, ist eine leere Seite vor dem Glossar - % in dem Falle bitte eine \cleardoublepage oben löschen - - \if\CALLGLO 1 % alle Glossar-Einträge unbedingt erzeugen - \glsaddall + \if\CKUSCHE 0 + \printnoidxglossary[title={Abkürzungsverzeichnis}] + \cleardoublepage \fi - \begingroup\let\newpage\relax\printnoidxglossaries\endgroup % Glossaries die leere Seite vor dem Glossar austreiben, wegen LoF, LoT - \cleardoublepage - \setcounter{savepage}{\arabic{page}} % MAIN CONTENT @@ -145,15 +139,19 @@ \input{anlagen.tex} \cleardoublepage - % Im Kusche-Mode kommt das LiteraturVZ zuletzt \if\CKUSCHE 1 + % Im Kusche Mode kommt das Glossar erst hier unten + \printnoidxglossary + \cleardoublepage + + % Im Kusche-Mode kommt das LiteraturVZ zuletzt \ifnum\thetotalbibentries>0 \printbibliography[title=Literaturverzeichnis] \addcontentsline{toc}{section}{Literaturverzeichnis} \cleardoublepage \fi \fi - + % Einrückung und Abstand unabhängig von config.tex setzen: Ehrenwort und Freigabe korrekt formatiert \setlength{\parskip}{6pt} \setlength{\parindent}{0cm} From 63e6d9b88607b42315a3b8e0ddb6dd2c16e20062 Mon Sep 17 00:00:00 2001 From: ZeroPointMax Date: Mon, 16 May 2022 16:36:38 +0200 Subject: [PATCH 13/18] remove CALLGLO remnants --- README.md | 2 +- build/tests/config.tex | 1 - config.tex | 3 --- 3 files changed, 1 insertion(+), 5 deletions(-) diff --git a/README.md b/README.md index a49ca44..46b6ab3 100644 --- a/README.md +++ b/README.md @@ -528,6 +528,6 @@ Wenn Einrückungen bevorzugt werden, kann das in der ``config.tex`` geändert we ## Glossaries - Symptom: das Glossar ist leer - - Prüfen Sie, ob Sie mit ``\gls`` auf mindestens ein Glossar-Eintrag verweisen oder ``CALLGLO`` in ``config.tex`` auf ``1`` gesetzt haben + - Prüfen Sie, ob Sie mit ``\gls`` auf mindestens ein Glossar-Eintrag verweisen - Wenn Sie kein ``latexmk`` verwenden, müssen Sie ggf. zwei mal kompilieren - entfernen Sie den Projekt-Cache (``template.aux``, ``template.bbl``, ``template.bcf``, ``template.blg``, ...) und kompilieren Sie erneut (ggf. zwei mal) diff --git a/build/tests/config.tex b/build/tests/config.tex index 7ed8a42..ed3bd3c 100644 --- a/build/tests/config.tex +++ b/build/tests/config.tex @@ -17,4 +17,3 @@ \def\CHASABSTRACT {0} \def\CFANCYFONTS {1} \def\CEINR {0} -\def\CALLGLO {1} diff --git a/config.tex b/config.tex index 54e64d2..8d4abb9 100644 --- a/config.tex +++ b/config.tex @@ -48,6 +48,3 @@ % 1 setzt Absatztrenner auf Einrückungen, 0 auf vertikale Abstände \def\CEINR {0} - -% 1 lässt alle Glossar- und Abkürzungs-Einträge unbedingt erzeugen, 0 nur bei Referenz darauf -\def\CALLGLO {0} From e5d6ff3aa155413314f80917dcb5cc6f0a9dabdb Mon Sep 17 00:00:00 2001 From: ZeroPointMax Date: Tue, 17 May 2022 09:27:51 +0200 Subject: [PATCH 14/18] hopefully last fixes --- .vscode/tex_snippets.code-snippets | 2 +- README.md | 25 +++++++++++++++++++++---- build/template.tex | 1 - main.tex | 1 + 4 files changed, 23 insertions(+), 6 deletions(-) diff --git a/.vscode/tex_snippets.code-snippets b/.vscode/tex_snippets.code-snippets index bb9b642..66e7d76 100644 --- a/.vscode/tex_snippets.code-snippets +++ b/.vscode/tex_snippets.code-snippets @@ -16,7 +16,7 @@ "Glossar": { "prefix": ["gls", "dhgegls"], // auf welchem namen der snippet auffindbar ist "scope": "latex,tex", // welche files der snippet betreffen soll - "body": ["\\newglossaryentry{${1:gls-id}}{name={${2:name}}}{description={${3:desc}}}" + "body": ["\\newglossaryentry{${1:gls-id}}{name={${2:name}},description={${3:desc}}}" ], // einzufügender snippet "description": "Insert \\newglossaryentry" // beschreibung }, diff --git a/README.md b/README.md index 46b6ab3..4410910 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,7 @@ Inoffizielles LaTeX-Template für Projektarbeiten für Technik-Studiengänge an - [Abkürzungen und Glossar-Einträge](#abkürzungen-und-glossar-einträge) - [Abkürzungen](#abkürzungen) - [Glossar-Einträge](#glossar-einträge) + - [Ganzes Glossar forcieren](#ganzes-glossar-forcieren) - [Weiterführende Dokumentation](#weiterführende-dokumentation) - [Anlagenverzeichnis](#anlagenverzeichnis) - [Verwendung](#verwendung) @@ -294,6 +295,11 @@ Der `dhgefigure` Befehl wird nun auch als Snippet für Visual-Studio-Code mitgel # Abkürzungen und Glossar-Einträge +Das Template verwendet das Paket ``glossaries``. +Entsprechend der Empfehlungen der DHGE im Bereich Technik/Gera wird ein Abschnitt namens "Abkürzungsverzeichnis" generiert, was allerdings auch wie ein volles Glossar verwendet werden kann. + +Für Arbeiten, die von Prof. Dr. Kusche betreut werden, heißt der Abschnitt "Glossar", siehe [Kusche Mode](#kusche-mode) + ## Abkürzungen ```latex @@ -404,13 +410,20 @@ Im Fließtext wird dann referenziert: Eine entsprechende Fehlermeldung war \gls{gls:ereignisanzeige} zu sehen. [...] ``` - -## Weiterführende Dokumentation +### Ganzes Glossar forcieren -[Anfängerfreundliche Glossaries-Doku](https://ctan.mirror.norbert-ruehl.de/macros/latex/contrib/glossaries/glossariesbegin.pdf) +Es ist möglich, alle Glossar-Einträge eintragen zu lassen, unabhängig davon, ob sie referenziert wurden oder nicht. +Nach einer ausführlichen Diskussion [hier](https://github.com/RvNovae/dhge-latex/pull/134) wurde sich dafür entschieden, diese Option nicht in das Template aufzunehmen und stattdessen lediglich zu dokumentieren. +Unter anderem deswegen, weil es den Empfehlungen der DHGE im Bereich Technik/Gera widerspricht. -[Glossaries CTAN-Seite](https://www.ctan.org/pkg/glossaries) +Um das oben beschriebene Verhalten dennoch zu verwenden, ist es notwendig, den Befehl ``\glsaddall`` oberhalb von ``\begin{document}``, aber unterhalb von ``\input{abk.tex}`` im Template zu platzieren. +Andernfalls erhält das Glossar einen ungewollten Seitenumbruch. + +## Weiterführende Dokumentation + +- [Anfängerfreundliche Glossaries-Doku](https://ctan.mirror.norbert-ruehl.de/macros/latex/contrib/glossaries/glossariesbegin.pdf) +- [Glossaries CTAN-Seite](https://www.ctan.org/pkg/glossaries) # Anlagenverzeichnis @@ -501,6 +514,10 @@ Deshalb wurde der ``CKUSCHE``-Schalter in ``config.tex`` eingeführt: diesen auf - Literaturverzeichnis erscheint zuletzt - es gibt kein Anlagenverzeichnis, dafür werden Anlagen im Inhaltsverzeichnis gelistet +Weiterhin wird das Erstellen eines Glossars nahegelegt, in dem Fachbegriffe erklärt werden. +Da das unabhängig vom Kusche-Mode bereits möglich ist, wird lediglich das "Abkürzungsverzeichnis" in "Glossar" umbenannt. +Der wesentliche Unterschied ist natürlich, dass wie im Kapitel [Glossar](#abkürzungen-und-glossar-einträge) nicht nur Abkürzungen, sondern auch Glossar-Einträge erstellt werden sollten. + ## Probleme im Kusche Mode Leider gibt es Anforderungen von Prof. Dr. Kusche, die bislang nicht umgesetzt werden konnten. diff --git a/build/template.tex b/build/template.tex index e959c33..5536a8a 100644 --- a/build/template.tex +++ b/build/template.tex @@ -22,7 +22,6 @@ % nicht als Text, sondern als Variablen definiert werden \input{abk.tex} - % Konfiguration globaler Definitionen % PDF Metadata diff --git a/main.tex b/main.tex index 22ad618..a8cafab 100644 --- a/main.tex +++ b/main.tex @@ -1,2 +1,3 @@ % hier können Sie Ihre Arbeit schreiben. % für ein Beispiel siehe `build/tests/` +\newglossaryentry{gls-id}{name={name},description={desc}} From 99d726bee7f89ddfb28c1387027adf05fe194641 Mon Sep 17 00:00:00 2001 From: Max Date: Wed, 18 May 2022 08:13:06 +0200 Subject: [PATCH 15/18] Update main.tex Co-authored-by: Felix Prillwitz <36958734+photovoltex@users.noreply.github.com> --- main.tex | 1 - 1 file changed, 1 deletion(-) diff --git a/main.tex b/main.tex index a8cafab..22ad618 100644 --- a/main.tex +++ b/main.tex @@ -1,3 +1,2 @@ % hier können Sie Ihre Arbeit schreiben. % für ein Beispiel siehe `build/tests/` -\newglossaryentry{gls-id}{name={name},description={desc}} From d7985b83aada20e3495ebee4c6e1b7f413928722 Mon Sep 17 00:00:00 2001 From: Max Date: Wed, 18 May 2022 12:34:13 +0200 Subject: [PATCH 16/18] Update abk.tex Co-authored-by: Felix Prillwitz <36958734+photovoltex@users.noreply.github.com> --- abk.tex | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/abk.tex b/abk.tex index dc877f9..303ec04 100644 --- a/abk.tex +++ b/abk.tex @@ -1,7 +1,8 @@ % Definieren Sie hier Ihre Abkürzungen und Glossar-Einträge anhand der Beispiele. % Wenn Sie diese dann im Text verwenden, rufen Sie einfach \gls{key} auf, z.B. \gls{ac:dhge}. % LaTeX kümmert sich um den Rest. -% Wenn alle Abkürzungen auch ohne Verweis darauf generiert werden sollen, ist ein Schalter dafür in config.tex verfügbar. +% Alle Abkürzungen auch ohne Verweis darauf generieren ist in der README.md dokumentiert. + % Eine ausführliche, anfängerfreundliche Dokumentation ist unter https://www.overleaf.com/learn/latex/Glossaries abrufbar. \newglossaryentry{gls:gloss}{ From f8c74a0fabe5c662881fe2cffa641fb1fae2413a Mon Sep 17 00:00:00 2001 From: ZeroPointMax Date: Wed, 18 May 2022 12:44:46 +0200 Subject: [PATCH 17/18] use <> around placeholders --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 4410910..df82b7b 100644 --- a/README.md +++ b/README.md @@ -168,7 +168,7 @@ Wer diese Fonts **nicht** verwenden möchte, kann in ``config.tex`` ``CFANCYFONT Dafür wird der `footcite` Befehl genutzt. Dieser besitzt folgende Syntax: ```latex -\footcite[Postnote]{literatur_id} +\footcite[Postnote]{} ``` Beispiel: @@ -182,7 +182,7 @@ Beispiel: Alternativ kann nun auch der `supercite` Befehl verwendet werden: ```latex -\supercite[Postnote]{literatur_id} +\supercite[Postnote]{} ``` Beispiel: @@ -222,7 +222,7 @@ Mehrere Autoren können mit `and` verknüpft werden. Beispielsweise: `author={Fe Wird `\footcite` oder `\supercite` mit beiden optionalen Parametern aufgerufen, so ist die Syntax wie folgt: ```latex -\footcite[Prenote][Postnote]{id} +\footcite[Prenote][Postnote]{} ``` Beispiel: @@ -303,12 +303,12 @@ Für Arbeiten, die von Prof. Dr. Kusche betreut werden, heißt der Abschnitt "Gl ## Abkürzungen ```latex -\newacronym{key}{short}{long} +\newacronym{}{}{} ``` -1. ``key``: ID der Abkürzung, damit wird im Fließtext später referenziert. -2. ``short``: Die Abkürzung selbst -3. ``long``: Der ausgeschriebene Begriff +1. ````: ID der Abkürzung, damit wird im Fließtext später referenziert. +2. ````: Die Abkürzung selbst +3. ````: Der ausgeschriebene Begriff Beispielweise: @@ -353,15 +353,15 @@ An einem Beispiel: Die Pluralform lässt sich mit ```latex -\glspl{key} +\glspl{} ``` aufrufen. -Ebenso kann der erste Buchstabe einer Abkürzung groß geschrieben werden (wenn er in der Abkürzung selbst klein geschrieben ist): ``\Gls{key}``. -Das ist kombinierbar mit ``\glspl{key}``, also: +Ebenso kann der erste Buchstabe einer Abkürzung groß geschrieben werden (wenn er in der Abkürzung selbst klein geschrieben ist): ``\Gls{}``. +Das ist kombinierbar mit ``\glspl{}``, also: ```latex -\Glspl{key} +\Glspl{} ``` Das Abkürzungsverzeichnis wird dann automatisch erstellt. Dabei ist zu beachten, dass unter Umständen bis zu zwei Kompilierungen notwendig sind, wenn eine Abkürzung hinzugefügt oder entfernt wurde, damit das Verzeichnis korrekt erstellt wird. @@ -374,7 +374,7 @@ Für mehr Informationen kann die [Glossaries Package Documentation](https://ctan ## Glossar-Einträge -Glossar-Einträge verhalten sich ähnlich zu den eben vorgestellten Abkürzungen und werden ebenso mit ``\gls{key}`` oder möglichen Alternativ-Formen aufgerufen. +Glossar-Einträge verhalten sich ähnlich zu den eben vorgestellten Abkürzungen und werden ebenso mit ``\gls{}`` oder möglichen Alternativ-Formen aufgerufen. Glossar-Einträge werden im einfachsten Falle wie folgt angelegt: @@ -389,7 +389,7 @@ Glossar-Einträge werden im einfachsten Falle wie folgt angelegt: 2. Der Begriff, der im Glossar erklärt werden soll 3. Die Erklärung des Begriffes -Im Fließtext wird dann mit ``\gls{key}`` der Eintrag verknüpft, wobei der Begriff im Text erscheint. +Im Fließtext wird dann mit ``\gls{}`` der Eintrag verknüpft, wobei der Begriff im Text erscheint. Sollte die Beschreibung des Begriffs allerdings **länger** als die verbleibende **Seitenbreite** sein, muss der Eintrag mit ``\longnewglossaryentry`` angelegt werden. Von den Optionen ändert sich dabei nichts. From a66fd0801d253e3a02c961be5943af96ec7eb9d9 Mon Sep 17 00:00:00 2001 From: Max Date: Mon, 13 Jun 2022 14:33:15 +0200 Subject: [PATCH 18/18] Update README.md Co-authored-by: Felix Prillwitz <36958734+photovoltex@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a140cb6..6839fa5 100644 --- a/README.md +++ b/README.md @@ -410,7 +410,7 @@ Im Fließtext wird dann referenziert: ```latex [...] -Eine entsprechende Fehlermeldung war \gls{gls:ereignisanzeige} zu sehen. +Eine entsprechende Fehlermeldung war in der \gls{gls:ereignisanzeige} zu sehen. [...] ```