Eigenes Paket oder Klasse

Gast · Beitrag von **Gast** » Do 26. Mai 2016, 11:28

Hallo alle zusammen,
wir verwenden bei uns derzeit eine LaTeX Vorlage für die Erstellung von Berichten und Reports. Diese Vorlage besteht aus einer tex-Datei mit Include und Inputs, in welchen beispielsweise die Pakete geladen werden oder Kopf- und Fußzeile, Schriftart, Absätze... definiert werden.
Jetzt kam die Frage auf, ob es nicht möglich wäre, all diese Definitionen auszulagern und in eine eigene Klasse oder Paket zu schieben. Das Ziel ist es, dass alle ein einheitliches Design für die Erstellung des Berichts verwenden.

Was wäre eurer Meinung sinnvoller für diese Vorhaben? Oder gibt es gar noch eine andere Alternative?

Eventuell wäre es auch Interessant zu wissen, ob es eine geeignete Literatur für die Erstellung von eigenen Paketen bzw Klassen gibt.

Vielen Grüße und vielen Danke
Felix

iTob · Beitrag von **iTob** » Do 26. Mai 2016, 12:40

Hi,

ich denke schon, dass es hilfreich sein kann, eine eigene Klasse/Paket zu verwenden, um den Wildwuchs etwas einzudämmen, aber auch damit kann man Änderungen am Layout durch den Endnutzer nicht wirklich unterbinden. Für die Klasse/Paket spricht, dass die Trennung zwischen Inhalt und Layout noch etwas sauberer ist, als wenn man normale Dateien per \include einbindet.

Klasse oder Paket? Ich würde eine Klasse benutzen, da es hier um die Umsetzung eines Layouts geht. Pakete sind eher für in sich geschlossene Funktionssammlungen, die mit verschiedenen Klassen funktionieren, gedacht. Beim Paket hätte man außerdem das problem, dass man nicht weiß, mit welcher Klasse der Nutzer es verwendet und muss entsprechend mit Abfragen darauf reagieren.

Der LaTeX-Begleiter hat ein Kapitel dazu, wie man eigene Klassen/Pakete schreibt. Ansonsten siehe z.B. Reference guide to begin writing a class and/or a package

Falls es für sowas ein Budget gibt und ihr euch nicht selber damit rumschlagen wollt, stehe ich euch auch gerne zur Verfügung, um eine Klasse zu schreiben (und dabei ggf. auch das Layout zu überarbeiten …)

Viele Grüße
Tobi

Gast · Beitrag von **Gast** » Do 26. Mai 2016, 20:15

Danke für deine schnelle Antwort Tobi,
Ziel ist es hauptsächlich, wie von dir beschrieben, den Wildwuchs einzudämmen anstatt keine Änderungen zuzulassen.
Das Problem ist, dass unsere Studenten regelmäßig Berichte in LaTeX schreiben müssen und dafür die erwähnte Vorlage verwenden. Von daher wird es wahrscheinlich auch eine Aufgabe eines Studenten, eine Klasse als Vorlage zu erstellen.
Des Weiteren soll es durch die Vorlage neuen Studenten erleichtert werden, einen Bericht mit wenig LaTeX Kenntnissen zu erstellen.

Danke für die erwähnte Literatur und für dein Angebot.

Viele Grüße
Felix

iTob · Beitrag von **iTob** » Fr 27. Mai 2016, 12:37

Tja … also mir Vorlagen ist es eben immer so ne Sache … diejenigen, die damit arbeiten sollen verstehen nicht was sie tut und das führt früher oder später zu Problemen, spätestens, wenn (unverstandener) Code aus dem Netz dazu kopiert wird. Bei ner Klasse wäre das etwas gekapselter, da passiert das nicht so leicht. Wichtig ist, dass die Klasse ordentlich dokumentiert wird und noch viel wichtiger, dass die Studenten, die TeX benutzen sollen (müssen?) es auch beigebracht bekommen, von jemandem der sich auskennt …

Der Vorteil einer Klasse wäre außerdem, dass ihr sie öffentlich über CTAN verteilen könnt und die Studenten sich dann nicht damit rumschlagen müssen, irgendwas extra zu installierten, weil die Klasse dann schon bei der TeX-Installation mitgeliefert würde. Nachteil ist, dass eben jeder Fremde die Vorlage auch nutzen kann, das spielt aber für euch keine so große Rolle denke ich, denn hier geht es ja nicht um die Umsetzung eines exklusiven Designs oder so.

Viele Grüße
Tobi

Johannes_B · Beitrag von **Johannes_B** » Fr 27. Mai 2016, 13:00

Eine Vorlage die von vielen genutzt wird und auf die sich viele verlassen sollen.
Eine Fußgängerbrücke wird auch nicht mal eben so von einem Studenten konstuiert, da muss man schon Kenntnisse haben; sonst geht das nach hinten los.

Die Ergebnisse stolzer Studenten, eine Vorlage, sieht man hier häufiger. Leider. Denn der größte Teil ist schlicht murks.

Dann doch lieber von einem erfahrenen LaTeX/TeX-Nutzer unter die Arme greifen lassen. Neben Tobi gibt es noch Troubleshooting-tex und weitere.
Natürlich bedeutet das nicht, dass alle Dienste, welche vorgeben gute LaTeX-Vorlagen (Templates) zu erstellen, das auch wirklich können (Ich war nämlich früher auch Balletttänzer am Hofe des chinesischen Kaisers). Natürlich möchte ich hier keine Negativbeispiele nennen.

Des Weiteren soll es durch die Vorlage neuen Studenten erleichtert werden, einen Bericht mit wenig LaTeX Kenntnissen zu erstellen.

Wenn die Stundenten ein Programm nutzen sollen, dann sollten sie auch dementsprechend ausgebildet werden.
DANTE e.V. kann hier weiterhelfen, sofern keiner vor Ort mit hinreichend Kenntnissen zur Verfügung steht.

u_fischer · Beitrag von **u_fischer** » Fr 27. Mai 2016, 13:38

iTob hat geschrieben:Tja … also mir Vorlagen ist es eben immer so ne Sache … diejenigen, die damit arbeiten sollen verstehen nicht was sie tut und das führt früher oder später zu Problemen, spätestens, wenn (unverstandener) Code aus dem Netz dazu kopiert wird. Bei ner Klasse wäre das etwas gekapselter,

Ob etwas eher (generische) Klasse oder eher Vorlage ist, hängt nicht so sehr von der Dateistruktur oder der Dateiendung sondern vom Inhalt ab. Ich kann ja die Präambel jeder Vorlage in eine cls-auslagern.

Wenn eine Klasse viele Entscheidungen fest trifft (Layout, Schriften, Sprachen, Bibliographiestyle) und viele Nutzerpakete lädt (hyperref, tikz, cleveref, amsmath, inputenc, fontspec, chemie, siunitx usw) dann bewegt sie sich Richtung Vorlage. Das muss nicht schlecht sein, aber den Komfort, dass vieles schon eingestellt ist, erkauft man sich mit weniger Flexibilität und weniger Hilfe in den normalen Foren. Man sollte sowas also nur benutzen, wenn es aktiven Support gibt.

Der Vorteil einer Klasse wäre außerdem, dass ihr sie öffentlich über CTAN verteilen könnt und die Studenten sich dann nicht damit rumschlagen müssen, irgendwas extra zu installierten, weil die Klasse dann schon bei der TeX-Installation mitgeliefert würde.

Auch Vorlagen und Beispiele kann man auf CTAN hochladen.

Beinschuss · Beitrag von **Beinschuss** » Fr 27. Mai 2016, 14:47

u_fischer hat geschrieben: Man sollte sowas also nur benutzen, wenn es aktiven Support gibt.

Hier spricht Ulrike einen weiteren, sehr wichtigen Punkt an: Sowohl der aktive Support für die Studierenden als auch die Pflege der neuen Klasse/der Vorlage sollten möglichst dauerhaft sichergestellt werden. Jetzt einen Studi zu beauftragen, was zusammenzustoppeln, und keinen zu haben, der bei in drei Monaten oder drei Jahren auftretenden Fehlern die Vorlage reparieren kann, ist kein erfolgversprechender Weg. Zumindest sollte möglichst sorgfältig dokumentiert sein, was warum gemacht wurde.

Gast · Beitrag von **Gast** » Mo 30. Mai 2016, 18:00

Danke für all die vielen Antworten.
Ich kann die Bedenken verstehen, dass die Klasse bzw. das Paket anschließend auch gepflegt werden muss. Neben der Erstellung der eigenen Klasse soll außerdem eine Dokumentation sowie eine Machbarkeitsstudie erstellt werden, ob es überhaupt sinnvoll ist.

Wenn eine Klasse viele Entscheidungen fest trifft (Layout, Schriften, Sprachen, Bibliographiestyle) und viele Nutzerpakete lädt (hyperref, tikz, cleveref, amsmath, inputenc, fontspec, chemie, siunitx usw) dann bewegt sie sich Richtung Vorlage. Das muss nicht schlecht sein, aber den Komfort, dass vieles schon eingestellt ist, erkauft man sich mit weniger Flexibilität und weniger Hilfe in den normalen Foren. Man sollte sowas also nur benutzen, wenn es aktiven Support gibt.

Genau darum geht es eigentlich für uns im Moment. Es soll mit dieser Vorlage immer ein und das gleiche Dokument von unterschiedlichen Personen mit ähnlichem Aufbau und Inhalt erstellt werden. Aus diesem Grund ist für diese spezielle Anwendung derzeit keine zu große Flexibilität erforderlich.

Da dante.de angesprochen wurde, wie sinnvoll ist es denn eine Mitgliedschaft bzw. eine Schulung zu machen, falls sich die eigenen Klasse durchsetzen sollte und ausgebaut werden muss.

Viele Grüßen und besten Danke für die Hilfe
Felix