RvNovae / dhge-latex

Inoffizelles LaTeX-Template für Projektarbeiten an der Dualen Hochschule Gera Eisenach
8 stars 5 forks source link

Ersetzen von Acro durch Glossaries #131

Open ZeroPointMax opened 2 years ago

ZeroPointMax commented 2 years ago

Aktuell wird durch das Paket acro ein Abkürzungsverzeichnis generiert. Das mag seinen Zweck als solches erfüllen, ist allerdings ungeeignet, wenn ein ganzes Glossar generiert werden soll. Prof. Kusche regt ja mindestens stark dazu an, ein Glossar anstelle eines AbkVZ zu machen und bei Arbeiten mit hohem (Fach-)Chinesisch-Anteil ist das ja auch so empfehlenswert.

Deshalb schlage ich vor, das acro Paket durch das glossaries Paket zu ersetzen, was ich in meiner Projektarbeit 4 auch getan habe. Durch das Glossaries-Paket können Abkürzungen und Glossar-Einträge wahlweise in einem oder zwei getrennten Verzeichnissen verwaltet werden. Optisch ändert sich recht wenig, wenn man nur Abkürzungen einträgt; der Titel des Verzeichnisses ist mMn auch einstellbar. Für Nutzer ändert sich jedoch relativ viel: die Befehle heißen anders und es sind insgesamt mehr - eben für Abkürzungen und Glossareinträge. Das muss also unbedingt dokumentiert werden. Ansonsten ist die Implementierung des Paketes aber recht einfach - das Verzeichnis ist von Haus aus vernünftig formatiert und Prof. Dorendorf lässt das ja durchaus offen, wie es auszusehen hat.

Ich halte also mal folgende Ziele fest:

@RvNovae @photovoltex was haltet ihr von dem Plan?

RvNovae commented 2 years ago

Klingt nach nem Plan :D

ZeroPointMax commented 2 years ago

@RvNovae @photovoltex es scheint keine einfache Methode zu geben, das Glossar konditional auszugeben, da glossaries keinen Counter bereitstellt, wie viele Einträge insgesamt mal referenziert wurden. Man kann aber bestimmte Einträge zählen. Ich weiß nicht, ob das was bringen würde... Wie wollen wir hier vorgehen? Wir hätten ein paar Auswahlmöglichkeiten:

RvNovae commented 2 years ago

@photovoltex und ich denken, dass ein config Schalter wahrscheinlich am einfachsten wär.

photovoltex commented 2 years ago

Hey @ZeroPointMax^^, ich hab mir mal die bereits bestehende Umsetzung angeschaut und hab ein paar Anmerkungen.

Ansonsten steht nur noch die Frage im Raum wo das Glossar positioniert werden sollte. Vor TOC oder vor dem Literaturverz.?

Auch sollte man im Hinterkopfbehalten das nur Kusche ein Glossar direkt fordert und die DHGE wahrscheinlich weiterhin ein Abkverz. (Glossaries würde die Möglichkeit haben das zu machen)

\usepackage[acronym,...]{glossaries}
\printnoidxglossary[type=\acronymtype,title={Abkürzungsverzeichnis}]
ZeroPointMax commented 2 years ago

@photovoltex vielen Dank fürs reinschauen. Den Super-Style hatte ich noch nicht auf dem Schirm, vielen Dank.

Dass die Einträge nicht erzeugt werden, habe ich bereits auf dem Schirm. Persönlich habe ich das in der mit dem Kommandozeilen-Aufruf makeglossaries gelöst, angeblich funktioniert es nach dem dritten Bauen auch so, andernfalls solle man \makeglossaries vor dem printen einfügen. Muss ich noch untersuchen.

Zu nopostdot: Puh, wenn der Post-Dot drinnen bleibt, muss es dokumentiert werden. Ansonsten kann es für "Anfänger" lieber ohne Post-Dot eingerichtet werden.

Zu Glossar vs. AbkVZ: gerade Projektarbeiten driften gerne ins Fachchinesisch ab, insofern ist ein Glossar eigentlich unabh. vom Kusche-Mode sinnvoll, auch wenn es nicht explizit gefordert ist, wie seht ihr das?

ZeroPointMax commented 2 years ago

Also was da auf der Branch rumliegt ist weder aktuell noch in irgendeiner Weise fertig :D

photovoltex commented 2 years ago

Zu Glossar vs. AbkVZ: gerade Projektarbeiten driften gerne ins Fachchinesisch ab, insofern ist ein Glossar eigentlich unabh. vom Kusche-Mode sinnvoll, auch wenn es nicht explizit gefordert ist, wie seht ihr das?

Ja die Frage ist inwiefern man es trennen kann, dass es auch einfach für neue texer ist. Evtl. könnte man es konfigurierbar machen, ob es gewollt ist oder nicht. (der Kusche mode hard forced es dann halt) \ Bspw. ( abk | gls | abk_gls | ) als mögliche Optionen um es halt dem Author einfach zu überlassen. Default wäre dann wahrscheinlich trotzdem DHGE default damit es nicht verwirrend ist.

Dass die Einträge nicht erzeugt werden, habe ich bereits auf dem Schirm. Persönlich habe ich das in der mit dem Kommandozeilen-Aufruf makeglossaries gelöst, angeblich funktioniert es nach dem dritten Bauen auch so, andernfalls solle man \makeglossaries vor dem printen einfügen. Muss ich noch untersuchen.

Hier werden die Möglichkeiten aufgezählt nach kurzem überfliegen (halbwissen also evlt. wie du schon meintest nochmal reinschauen)

Ansonsten vielen Dank^^

ZeroPointMax commented 2 years ago

Achso bin auf ein zwei Sachen nicht eingegangen:

ZeroPointMax commented 2 years ago

@photovoltex hab mal den Link in deinem Beitrag gefixt

photovoltex commented 2 years ago

@.photovoltex hab mal den Link in deinem Beitrag gefixt

Aktuell geht es nicht... Es schaut im Repo aber es ist ein externer Link.

Das Glossar sollte genau da stehen, wo das AbkVZ früher war

In Kusches Angaben soll es vor dem Literaturverz. stehen.

Wie hast du das Glossar noch gleich zum laufen gebracht, sodass es nicht immer leer war? Da konnte ich nicht ganz folgen

Deine Umsetzung plus die Aenderungen in dem ersten Kommentar von mir.

ZeroPointMax commented 2 years ago

Aktuell geht es nicht... Es schaut im Repo aber es ist ein externer Link.

Ei verdammt 😅

In Kusches Angaben soll es vor dem Literaturverz. stehen.

Gut, dann denke ich mir nochmal was aus 🤔

Deine Umsetzung plus die Aenderungen in dem ersten Kommentar von mir.

Ah, der Doku-Link hat geholfen 👍