rvnovae / dhge-latex Goto Github PK

• Allgemeine Sections
• ToC
• FoC
• ToT

Hey ihr, eine kurze Frage:
Wie bewerkstellige ich am besten das Einfügen eines mehrseitigen PDF-Dokumentes in den Anhang? Ich probiere mit /begin{figure} sowie /includegraphics und /includepdf Rum, da habe ich aber das Problem, dass ich jede Seite manuell einfügen muss, und, wenn ich die Unterschrift erst unter der letzten Seite haben möchte, der Link im Anhangsverzeichnis auch auf die letzte Seite zeigt (und nicht auf die erste).

Sorry fürs komplizierte Erklären, aber habt ihr ne Idee?

Wenn man auf Abbildungsverzeichnis drückt, sollte auch das Abbildungsverzeichnis kommen.

Wenn man mal was anderes haben will, wirds schwierig.
Mir ists bspw. auf die Füße gefallen, als ich eine minted environment über die Seitengrenze hinweg haben wollte.

Hab auch schon mindestens einen Lösungsvorschlag dafür (siehe #120)
Bessere Vorschläge sind jedoch gern gesehen 😉

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?

Die verwendet doch eh keiner...

• update.bat entfernen
• update.sh entfernen
• Dokumentation in README.md entfernen

Ziel ist, dass in der config die Studienrichtung gewählt werden kann.
Dann soll sich das Layout dementsprechend ändern.

Das hat aber erstmal keine hohe Priorität.

• Gera
• Eisenach

Vielleicht könnte man eine Variable setzen, die den Campus definiert (das könnte man dann auch direkt fürs Deckblatt nehmen), und eine für die Studienrichtung.

Wie der Title schon sagt ist das Abkürzungsverzeichnis nicht erwartungsgemäß sortiert.
Dies kann beim Leser Verwirrung stiften wenn dieser nach einer Abkürzung sucht.

Tasks:

• package austauschen
• wiki updaten
• abk.tex updaten
• Sortierung konfigurieren

• Aufbau Übersicht
• Config
• Custom Commands
• Wichtige Package Dokus verlinken (und die wichtigsten Funktionen auflisten)
• Einheitlich auf Deutsch

• Minted Documentation

Ich würd mal folgendes vorschlagen:

• master branch wegwerfen
• develop in main umbenennen
• update scripts anpassen
• orga fork action anpassen

Sobald man weiß, wie man alles einstellen will, sollte das eigentlich gar nicht so schwierig sein.

Hauptsächlich erstmal so Sachen wie Build Prozesse.

Aber das kann erstmal noch warten 😄

• add recommendations
• add .editorconfig
  • format every file after .editorconfig
• grammar check

Die in dem Screenshot aufgeführten Warnings sollten mal untersucht und, wenn möglich, behoben werden.

Das Template baut jedes mal ziemlich lange.
Evtl. besteht die Möglichkeit diesen Prozess mittel ein paar Tricks und Entfernungen von unnötigen Packages zu verbessern.

• Anpassung des Deckblatts
• Freigabeerklärung
• Text in der Ehrenwörtlichen Erklärung entsprechend schalten

Ähnlich Abbildungs- und Tabellenverzeichnis

• Anlagenverzeichnis
• Literaturverzeichnis
• Abkürzungsverzeichnis

Keine Ahnung, wie das passiert ist. Fällt mir aber jetzt erst auf ...

Ist:
Pfade müssen explizit mit ../img/imagefile.png angegeben werden.
Soll:
Der Dateiname reicht als Pfad.

In Wahrheit scheint das Template mit CFANCYFONTS 1 nicht Bera, wie gedacht, sondern mathpazo zu verwenden, weil es nach beraserif geladen wird.

Der Coding-Aufwand beschränkt sich mMn auf kleine Aufräum-Arbeiten, da wir ja Palladio-L-Roman (mathpazo) fälschlicherweise für Bera gehalten haben.

Mein Lösungsvorschlag:

• beraserif entfernen
• prüfen, ob berasans gebraucht wird und ggf. entfernen
• In der Doku vermerken, dass Palladio / Palatino verwendet wird

P.S.: Danke an Prof. Kusche für den Hinweis. Darauf wären wir wahrscheinlich nie von alleine gekommen 😅

Grundgedanke

Da die aktuelle "Continuous Integration" nur den Bau des Templates garantiert, sollte für die neuen und schon vorhanden Funktionen ein, gleichzeitig beispielhaftes, Testdokument gebaut werden.
Dieses soll die Funktionalität der eigenen implementierten Funktionen garantieren.

Vorschlag:

einen Ordner erstellen welcher ein komplett fertiges Projekt kompiliert.
Dieser soll folgendes enthalten:

• alle Funktionen welche in einem Projekt verwendet werden sollen/können, diese sollen in den entsprechenden .tex Dateien beispielhaft eingefügt werden.
• aktuell \dhgefigure{<datei>}{<options>}{<caption>}{<label>}, \anlagen{<type>}{<flag>}, \doubleunderline{<word>}

Hier muss man zwischen Funktionen unterscheiden, welche das erstellen des Templates vereinfachen und Funktionen die das schreiben der Projektarbeiten vereinfachen. ( Siehe com.tex -> \markBox{<number>} )

Für mich als Anfänger wäre es schön, wenn in der Wiki steht, wie man richtig indirekt zitiert.

Der richtige Syntax scheint zu sein: \footcite[Vgl.][]{Computerphile.2020}

Mit der Umstellung auf das neue ac package ist das wohl kaputt gegangen.
Die Indentation sollte gleichmäßig sein.
Werde mich damit selbst nochmal beschäftigen, aber wenn jemand eine zündende Idee hat, gern her damit :^)

• fix indentation
• potentielles Entfernen von \def\CABKL prüfen

Gescheite Formatierung, zumindest für gängige Typen.
@book, @misc, @article, @online fürs erste.

https://tex.stackexchange.com/questions/10808/using-a-corporate-author-in-the-author-field-of-a-bibliographic-entry-spell

DockerHub -> rate limiting
travis -> domain wechsel

Vielleicht direkt als Github Action umsetzen.
Direkt für die main branch umsetzen (#79 berücksichtigen)

• bei PR auf main einmal durchbauen (mit tests)
• bei merge auf main einmal durchbauen (mit tests)

Aktuell besteht das Problem, dass Quellen nur referenziert werden wenn auch eine Seite zu der Quelle angegeben werden.

Dies funktioniert, da beide optionalen Parameter angegeben sind

\dhgefigure{bildName}{scale=.8}{Caption}{fig:labelName}[quelle][S. 69]

Dies fügt keine Quelle hinzu, da der zweite optionale Parameter fehlt.

\dhgefigure{bildName}{scale=.8}{Caption}{fig:labelName}[quelle]

Es wäre schön auf dem Deckblatt auch die Anschrift des Ausbildungsbetriebs (siehe Hinweise der DHGE, Anhang A2) und einen zweiten Betreuer (zB in PA4 ein Betreuer vom Unternehmen und ein Betreuer von der DHGE) angeben zu können.

Schaue gerade woran das liegt ...

Da beim wiki außenstehende nicht contributen können (#80), wäre es sinnvoll, die Doku in das Readme zu verlagern.

Was sich dann automatisch erstellt und so ein Kram.

Könnte man vielleicht sogar so bauen, dass nur ein Anlagenverzeichnis angelegt wird, sobald mehr als eine Anlage vorhanden ist.

Da gibt es, glaube ich, sogar irgendwie ein appendix package oder so.

Soll genauso sein, wie in Abbildungs-/Tabellenverzeichnis.

Aus der Diskussion in #120 ist hervorgangen, dass eine generischere Lösung von longfigure besser wäre.

Dazu würde man etwas ähnliches, wie die longfigure definieren, allerdings mit parametrisierbarem Typen (also zu welcher Auflistung er dazugezählt wird).

Als Namen schlage ich nonfloat vor, bin aber gerne für Diskussionen offen 😄

• Befehl definieren
• einen (Anlagen-)Test hinzufügen (eigentlich sollte es egal sein, wo der Befehl aufgerufen wird)
• Anpassung der Doku
• https://github.com/RvNovae/dhge-latex/pull/126/files#r805210044 beachten

Man soll das Verzeichnis nicht mehr in der LaTeX Console hinzufügen müssen.

Vielleicht kann man den Code direkt in das template einbinden?

Vielleicht main directory mit main file

Die Verlinkung der beiden oben genannten Abschnitte ist nicht funktional und bringt einen nicht zur gewollten stelle.

\newcommand{\conditionalLoF}{\@ifundefined{r@fig:was:used:in:doc}{}
	{\addcontentsline{toc}{section} {\listfigurename} \listoffigures \cleardoublepage}}%
\newcommand{\conditionalLoT}{\@ifundefined{r@tab:was:used:in:doc}{}
	{\addcontentsline{toc}{section} {\listtablename} \listoftables \cleardoublepage}}%
\makeatother

"addcontentline" müsste weiter hinten stehen ist aber nicht so leicht möglich da es Compiler Fehler gibt.

Ich bin mittlerweile nicht mehr so wirklich ein Freund von H-Figures.
Deswegen würd ich mal den H Default von dem dhgefigure Befehl entfernen.

Meinungen dazu hör ich mir gerne an.

• update command
  • center -> centering
• update snippet

• Seitenzahlen nach rechts unten
  • kusche mode beachten
• Schriftgröße 10/11pt
• Footnotesize 9pt (Kusche 10pt)
• Abstand / Einrückung bei Abschnitten
• Durchlaufende Nummerierung bei "vielen" Fig./Tab.
• ?

Erstmal sollten die ganzen Änderungen mal zusammengetragen werden.

Ich habe mir hier was gebastelt, sprich von StackOverflow abgeschrieben, was aktuell in meiner preamble.tex lebt:

\usepackage{tikz}

\newcommand*{\codeinline}[1]{\tikz[baseline=(X.base)]
	\node[fill=black!10] (X) {#1};}

\newcommand*{\todo}[1]{\tikz[baseline=(X.base)]
	\node[fill=red!42] (X) {#1};}

Der erste Command markiert Text grau, sodass er zumindest spartanisch an ne Codebox erinnert (funktioniert so nur inline).

Der zweite Command markiert Text rot und etwas stärker, sodass man seine Todos leichter finden kann.

Wäre das auch interessant für Andere?

Es soll ein Verweis auf die recommended Extension für vscode in der readme/doku erwähnt werden.

Wenn in den Extension nach @recommended gesucht wird, werden alle recommended Extension angezeigt.
Auch ist dies der fall wenn man das repo in code öffnet in der unteren rechten Ecke

evtl. Bild hinzufügen

Moinsen, ich hab mir mal erlaubt, das Template mitzunutzen und finde eure Arbeit super.
Mir ist bei der Paketdefinition von footmisc (in der package.config.tex) aufgefallen, dass ihr das Argument perpage nutzt, was ja bei jeder Seite die Fußnoten neubeginnt. Das entspricht nicht ganz den Anforderungen der DHGE. Habt ihr euch was dabei gedacht? Sonst würde ich nen Pullrequest machen, um das rauszunehmen.

Danke schonmal!