Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ersetzen von Acro durch Glossaries #131

Open
3 of 4 tasks
ZeroPointMax opened this issue Apr 11, 2022 · 11 comments · May be fixed by #134
Open
3 of 4 tasks

Ersetzen von Acro durch Glossaries #131

ZeroPointMax opened this issue Apr 11, 2022 · 11 comments · May be fixed by #134
Assignees
Labels
enhancement New feature or request

Comments

@ZeroPointMax
Copy link
Collaborator

ZeroPointMax commented Apr 11, 2022

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:

  • Implementieren von Glossaries
  • Entfernen von acro
  • Dokumentation der Befehle
  • Tests

@RvNovae @photovoltex was haltet ihr von dem Plan?

@ZeroPointMax ZeroPointMax added the enhancement New feature or request label Apr 11, 2022
@ZeroPointMax ZeroPointMax self-assigned this Apr 11, 2022
@RvNovae
Copy link
Owner

RvNovae commented Apr 13, 2022

Klingt nach nem Plan :D

@ZeroPointMax
Copy link
Collaborator Author

@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:

  • Glossar immer erzeugen
  • Referenzen auf DHGE oder so zählen
  • Config-Schalter

@RvNovae
Copy link
Owner

RvNovae commented May 10, 2022

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

@photovoltex
Copy link
Collaborator

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

  • aktuell werden Einträge im Glossar nicht eingerückt und stehen ziemlich "unordentlich" dort (vorraussichtliche Lösung)
    • \usepackage[...]{glos...} -> \usepackage[style=super,...]{glos...}
    • vor \make... -> \renewcommand{\glsnamefont}[1]{\textbf{#1}} (damit bold Text für die Shortver. beibehalten wird)
  • Das Glossar bzw. die Abk. Einträge scheinen aktuell nicht erzeugt zu werden
    • hatte bei den zuvorigen Klausurersatzleistungen schon etwas hiermit rumgespielt und dort hat es mit
      • \glsaddall weglassen (hatte ich zuvor nirgends gesehen)
      • \printglossaries -> \makenoidxglossaries
      • \printglossaries -> \printnoidxglossary

    mit den Optionen wird das Glossar auch nicht erzeugt wenn nichts eingetragen ist^^

  • Man könnte sich noch streiten ob die package option nopostdot verwendet werden soll.

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
Copy link
Collaborator Author

@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
Copy link
Collaborator Author

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

@photovoltex
Copy link
Collaborator

photovoltex commented May 11, 2022

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
Copy link
Collaborator Author

Achso bin auf ein zwei Sachen nicht eingegangen:

  • ja, wenn nichts im Glossar steht, wird nix ausgegeben, man hat aber trotzdem noch die \cleardoublepage
  • Das Glossar sollte genau da stehen, wo das AbkVZ früher war
    Wie hast du das Glossar noch gleich zum laufen gebracht, sodass es nicht immer leer war? Da konnte ich nicht ganz folgen

@ZeroPointMax
Copy link
Collaborator Author

@photovoltex hab mal den Link in deinem Beitrag gefixt

@photovoltex
Copy link
Collaborator

@.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.

  • remove \glsaddall
  • ...

@ZeroPointMax
Copy link
Collaborator Author

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 👍

@ZeroPointMax ZeroPointMax linked a pull request May 12, 2022 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants