goLaTeX - Mein LaTeX-Forum

Mein LaTeX-Forum


Login  | Registrieren
Forum
      Option
[Erweitert]
  • Diese Seite weiterempfehlen
     


Gehe zu:  
Neues Thema eröffnen Neue Antwort erstellen

Vorlage Bachelor-/ Masterarbeit

 

Gast


Beiträge: ---
Anmeldedatum: ---
Wohnort: ---
Version: ---
     Beitrag Verfasst am: 30.06.2017, 17:47     Titel:
  Antworten mit Zitat      
Johannes_B hat Folgendes geschrieben:
Für Lebensläufe gibt es übrigens auch: CreativeCV


Gast


Beiträge: ---
Anmeldedatum: ---
Wohnort: ---
Version: ---
     Beitrag Verfasst am: 01.07.2017, 07:58     Titel:
  Antworten mit Zitat      
Zunächst ein paar formale Anmerkungen.

Name
Du solltest darüber nachdenken, Deiner Vorlage einen eindeutigen Namen zu geben. Gefühlt jede zweite Vorlage für Abschlussarbeiten aller Art nennt sich 'Thesis-Template', das kann leicht zu einer Sprachverwirrung babylonischen Ausmaßes führen. Niemand weiß, was ich meine, wenn ich von 'Thesis-Template' rede, besonders wenn ich das auf Englisch tue.
Denk Dir also einen passenden und vor allem noch nicht vergebenen Namen aus. Idealerweise ist der Name so gewählt, dass nicht der nächste, der eine Vorlage erstellt und sie irgendwie nennt, ohne zu recherchieren, ob der Name schon existiert, seine Vorlage genauso nennt.
Das erleichtert es allen beteiligten ungemein, über deine Vorlage zu reden.

Offizielle Quelle
Wenn Du eine Vorlage veröffentlichst, ist es eine gute Idee, in der Readme anzugeben, wo die Vorlage offiziell Veröffentlicht wird. So kannst Du verhindern, dass Nutzer die Vorlage von anderen Orten in veralteten oder inoffiziell modifizierten Versionen nutzen.

Support
Eine Vorlage ist nur dann wirklich empfehlenswert, wenn der Autor ein gewisses Mindestmaß an Pflege in die Vorlage investiert. Du solltest Dir also überlegen und im Readme klar machen, wie das bei Dir aussieht. Bist Du bereit, die Vorlage kontinuierlich zu testen, aktuell zu halten und anzupassen, falls es Inkompatibilitäten geben sollte?
Generell ist (La)TeX sehr stabil und bedacht drauf abwärtskompatibel zu sein. Je mehr Pakete eine Vorlage aber enthält, desto wahrscheinlicher wird es, dass Updates Probleme bereiten. Besonders bei Paketen, die noch aktiv entwickelt werden.
Du solltest eine Kontaktadresse angeben (das kann z.B. die Github-Seite sein, die besteht ja schon und hat auch einen Bug-Tracker).

Versionierung
Wenn Du die Vorlage pflegen möchtest, kann es sein, dass Du eine neue Version Deiner Vorlage veröffentlichen musst. Github ist natürlich ideal, um die Versionsgeschichte nachzuvollziehen. Dennoch solltest Du in den Dateien direkt eine Versionsnummer angeben. Das ermöglicht es Deinen Nutzern, zu erkennen, welche Version deiner Vorlage sie haben, und zu entscheiden, ob sie ein Update machen müssen oder nicht. Idealerweise enthält jede Datei Deiner Vorlage eine solche Versionierungsinformation.

Als kleiner Unterpunkt dazu: Idealerweise weist sich jede in Deiner Vorlage vorhandene Datei selbst als Teil Deiner Vorlage aus. Du hast in Deiner readme bereits alle enthaltenen Dateien gelistet. Es ist aber nochmal sinnvoll, wenn jede Datei in einer Art kurzem Header die Zugehörigkeit zu Deiner Vorlage und ihre Version klar macht.

Lizenz
Wenn Du etwas veröffentlichst, solltest Du über eine passende Lizenz nachdenken. Die Lizenzinformation sollte gut erkennbar angebracht werden.
Vorlagen sind vom Lizenzstatus natürlich etwas schwierig, da der Nutzer viele Teile selbst ändern können soll. Siehe What license for releasing LaTeX templates Die Standard-Lizenz für LaTeX-Projekte LPPL ist für Vorlagen eher ungeeignet.
Du solltest auch erklären, inwieweit Du bereit bist, für von anderen veränderte Versionen Deiner Vorlage Support anzubieten.

Nutzung
Wie genau soll die Nutzerin Deines Paketes es verwenden. Welche Dateien soll sie verändern und von welchen soll sie die Finger lassen. Es gibt einige Vorlagen, bei denen eine Präambeldatei nicht angerührt werden soll und eine andere für Nutzeränderungen bereitgestellt ist. Wie sieht das hier aus?

Inhaltlich wurde schon Einiges gesagt.

Dein erklärtes Ziel "viele Pakete etc. ab[zu]decken" halte ich für unglücklich. Es gibt verdammt viele LaTeX-Pakete. Ich würde behaupten, niemand nutzt alle davon produktiv im selben Dokument. Es gibt spezielle Pakete für Linguistinnen, Logikerinnen, Mathematikerinnen, Chemikerinnen, Quantenphysikerinnen, Aktuarinnen, ... Natürlich gibt es einige Pakete, die fast alle Dateien laden, aber das sind doch wenige. Paket auf CTANpgfplots gehört wohl eher weniger dazu, ebenso Paket auf CTANepstopdf (zwei willkürliche Beispiele).

Du musst Dir also überlegen, was Deine Vorlage exakt anbietet. Richtet sie sich an Maschinenbauer, Mathematiker, Physiker, Chemiker und versucht dort, die meistgenutzten Pakete abzudecken. Selbst in den unterschiedlichen Subdisziplinen der Mathematik gibt es ganz unterschiedliche Anforderungen und Paketnutzungen.

Als Faustregel gilt: Viele Pakete können viele Probleme verursachen. Je mehr Pakete Du lädst, desto großer ist die Wahrscheinlichkeit für Nebeneffekte und Inkompatibilitäten. Es ist für Nutzer besonders ärgerlich, wenn die Probleme von einem Paket verursacht werden, das sie eigentlich gar nicht brauchen. Performance ist inzwischen kein so großer Faktor mehr, aber es ist doch schon nett, wenn ich pgfplots nur dann lade, wenn ich es wirklich brauche.

Du lädst viele Pakete, zeigst sie dann aber gar nicht in Aktion. Wenn sich Deine Vorlage an Anfänger richten soll, wäre es gut, die Nutzung der Pakete auch zu demonstrieren. Sonst werden sie wirklich nur geladen und nicht genutzt. Ich denke da besonders an die speziellen Float-Pakete, die Du lädst. Aber auch an pgfplots, nicefrac, siunitx (OK, du hast \si ein paar mal da - aber nicht echt in Aktion).

Warum hast Du Paket auf CTANfontenc auskommentiert? Es ist zwar besser Paket auf CTANinputenc und fontenc im Hauptdokument zu laden, damit der Nutzer darüber eine bessere Kontrolle hat und es nicht versteckt wird. Aber wenn Du inputenc schon lädst, dann ruhig auch fontenc. Besonders wenn wir nachher auch nicht auf Englisch schreiben.

Unpassend finde ich es auch, die Sprache in der versteckten Präambel einzustellen. Das ist doch etwas, was die Nutzerin schnell ändern können sollte.

Das Paket Paket auf CTANamssymb lädt intern schon Paket auf CTANamsfonts. Es reicht also, nur Paket auf CTANamssymb zu laden.

Wenn Du ein Literaturverzeichnis mit biblatex anbietest, solltest Du es ruhig auch zeigen. Dafür müsstest Du aber auch etwas zitieren. Die bis auf einen Kommentar von Citavi leere .bib-Datei ist da natürlich nicht wirklich hilfreich. Für Anfänger wäre es übrigens gut darauf hinzuweisen, wie das Dokument zu kompilieren ist (Stichwort Biber).

codeZ3ro
Forum-Newbie
Forum-Newbie

Beiträge: 1
Anmeldedatum: 29.06.17
Wohnort: ---
Version: ---
     Beitrag Verfasst am: 01.07.2017, 17:16     Titel:
  Antworten mit Zitat      
Puh, danke für die vielen Antworten. Ich hätte nicht gedacht, dass ich hiermit so große Resonanz auslöse. Aufgrund dessen werde ich auch nicht detailliert auf alle Punkte eingehen (wobei sich viele Anmerkungen ja überschneiden).

Vorweg, um noch einmal die Intention klar zustellen: Ich habe hier eine für mich funktionierende Vorlage hochgeladen, um Anforderungen für eine naturwissenschaftliche Arbeit abzudecken. Somit kann auch Jemand ohne große LaTeX Kenntnisse eine Arbeit erstellen. Wie Anfangs geschrieben ist die Vorlage nicht perfekt - jedoch zweckmäßig.

Zu einigen Punkten:
User Gast:
Fancyhdr und KOMA-Script-Klasse:
Einer der Punkte, die noch überarbeitet werden. Steht so sogar mehrfach in der Vorlage. Warum verwendet? Mit der KOMA-Script Klasse habe ich nicht, die für mich benötigten, Kopf-und Fußzeilen erhalten. Damals hatte ich auch nciht die Zeit tiefer in KOMA einzusteigen, um das gewünschte Ergebnis zu erzielen. --> Wird jetzt nachgeholt

\parindent= 0 setzen:
Dass es hier das Paket parskip gibt, wusste ich nicht. Wird eingepflegt.

Umschalten der Seitennumerierung nach dem Titel:
Ob man das tut oder nicht tut ist völlig irrelevant, wenn dies so von deinem betreuenden Professor so vorgeschrieben wird. Dann wird das eben so gemacht, Punkt. Und von dieser Sorte Professor gibt es mehr als man denkt Smile Da man dies jedoch eigentlich nicht tut, ist die Option auch auskommentiert. Jemand, der die Vorgabe aber bekommen hat, kann die Option einfach einfügen.
\cleardoubleoddpage wird aufgenommen.

\flushleft und \flushright werden durch \raggedright u. \raggedleft ersetzt. Danke für den Hinweis.

\hyperref muss ich mir zunächst anschauen.

markusv:

Zum Thema Pakete laden:
Jemand, der die Pakete nicht benötigt, kann sie rauswerfen und andere einfach nachladen. Jedoch werden im Kern bereits viele wichtige Pakete bereitgestellt. Für einen Neuling erspart dies zunächst einiges an Recherche, über die pure Existenz dieser Pakete, um eine bestimmte Aufgabe zu erledigen. Es gibt schlichtweg zu viele, teils ähnliche Pakete, die bei der Recherche eher verwirren als helfen, welches man denn nun einsetzen soll. Da ist es doch besser eines in der Vorlage stehen zu haben u. dann zu recherchieren wie dieses eingesetzt wird.

KOMA-Script und fancyhdr:
Siehe weiter oben.

Werde in Zukunft xcolor mit Option table verwenden, danke.

Eigene Datei für \listoffigures:
Ja, really. Das ist doch Geschmackssache. Ich nutze für jeden in sich geschlossene logische Einheit eine Datei, also auch dafür. Führt zu keinen Problemen und kann doch jeder handeln wie er möchte, so what? Confused

Werde subfig durch subcaption ersetzten. Danke für den Hinweis.

Die Problematik mit fontenc und inputenc werde ich berücksichtigen.

Zu Bartman:
Das ist schlicht eine Unachtsamkeit meinerseits, da ich kurzfristig das Sprachpaket umgestellt habe. Werde ich nachbessern, guter Punkt.

Zu Gast #2:

Name:
Guter Punkt, werde einen treffenderen Namen wählen.

Quelle:
Wird angegeben

Support:
Hier ist in allererster Instanz mein GitHub Account die Anlaufstelle. Kann in die readme-Datei noch aufgenommen werden. Kompatibilität wird unter MikTeX 2.9 gewährleistet, so auch angegeben.

Versionierung:
Guter Punkt, werde ich in die einzelnen Dokumente mit aufnehmen.

Lizenz:
Halte ich in dem Fall für nicht notwendig eine Lizenz anzubringen.

Nutzung:
Muss ich noch klarer definieren. Danke für den Hinweis. Auch an welche Fächergruppe sich die Vorlage richtet, dann wird die Paketzusammenstellung auch klarer.

Auch werde ich die Vorlage um Beispiele für die Nutzung erweitern.

Sehr guter Hinweis zur Kompilierung mit Biber - da hatte ich tatsächlich nicht (mehr) drangedacht.


Summa summarum: Danke für die vielen Hinweise (auch wenn ich mir doch gedacht hätte, dass es weniger sind). Dann habe ich definitiv noch ein großes Stückchen Arbeit vor mir die Vorlage entsprechend aufzubereiten. Nun kann ich auch verstehen, warum viele von Vorlagen abraten.
Private Nachricht senden Benutzer-Profile anzeigen

Gast


Beiträge: ---
Anmeldedatum: ---
Wohnort: ---
Version: ---
     Beitrag Verfasst am: 01.07.2017, 17:37     Titel:
  Antworten mit Zitat      
codeZ3ro hat Folgendes geschrieben:
\parindent= 0 setzen:
Dass es hier das Paket parskip gibt, wusste ich nicht. Wird eingepflegt.

Das hast du nicht richtig gelesen. Mit einer KOMA-Script-Klasse verwendet man nicht das Paket Paket auf CTANparskip sondern die KOMA-Script-Option parskip, die diverse Einstellungen bietet.

codeZ3ro hat Folgendes geschrieben:
\flushleft und \flushright werden durch \raggedright u. \raggedleft ersetzt. Danke für den Hinweis.

Auch da hast du den entscheidenderen Punkt möglicherweise übersehen: Du sollst im Titel auf die figure-Umgebung verzichten!

Bartman
Forum-Meister
Forum-Meister


Beiträge: 1032
Anmeldedatum: 16.07.09
Wohnort: Hessische Provinz
Version: Windows 7 64 Bit MiKTeX 2.9 32-Bit
     Beitrag Verfasst am: 01.07.2017, 23:07     Titel:
  Antworten mit Zitat      
@codeZ3ro

Sieh Dir auch mal die Sammlung von Johannes_B für den Entwurf der Titelseite an.
Private Nachricht senden Benutzer-Profile anzeigen

Johannes_B
Moderator
Moderator


Beiträge: 4864
Anmeldedatum: 01.11.12
Wohnort: ---
Version: ---
     Beitrag Verfasst am: 02.07.2017, 02:20     Titel:
  Antworten mit Zitat      
Keine Lizenz heißt prinzipiell keine Nutzung durch andere. Eine Lizenz ist wichtig.
Schließlich ist das ja dein geistiges Eigentum, das sollte man schon ein wenig schützen, bzw. genauer gesagt, anderen erlauben es nutzen zu dürfen.


Übrigens solltest du dich informieren, an welcher Stelle man \\ wirklich einsetzt.
_________________

TeXwelt - Fragen und Antworten Schaut vorbei und stellt Fragen.
LaTeX-Vorlagen?

Der Weg zum Ziel: Ruhe bewahren und durchatmen, Beiträge und unterstützende Links aufmerksam lesen, Lösungsansätze verstehen und ggf. nachfragen.
Private Nachricht senden Benutzer-Profile anzeigen

Gast #2
Gast

Beiträge: ---
Anmeldedatum: ---
Wohnort: ---
Version: ---
     Beitrag Verfasst am: 02.07.2017, 17:51     Titel:
  Antworten mit Zitat      
Was den Support angeht solltest Du Dir auch überlegen, was Du bereit bist zu tun.

Wirst Du in absehbarer (und idealerweise ferner) Zukunft dafür sorgen, dass Deine Vorlage wirklich aktuell bleibt und keine Kompatibilitätsprobleme bekommt? Oder verlierst Du nach ein paar Wochen das Interesse und lässt die Vorlage in einem Dämmerzustand dahinvegetieren? Wirst Du Deine Vorlage an Entwicklungen anpassen, also neue Pakete verwenden, Pakete austauschen, keine veralteten Befehle und Optionen nutzen ...?

Mit welchen Problemen dürfen sich Nutzer an Dich wenden? Was, wenn sie eine andere Kopfzeile möchten? Einen anderen Stil für Zitate und das Literaturverzeichnis. Was wenn "das Literaturverzeichnis nicht geht" oder jemand "ganz viele Fehler bekommt"?

Ein Punkt noch: 'Kompatibilität mit MikTeX 2.9' ist keine hilfreiche Aussage. MikTeX ist eine TeX-Distribution, so wie auch TeX live. Die Version 2.9 bezieht sich bei MikTeX aber nur auf die Version der Verwaltungssoftware von MikTeX selbst, es hat mit den Versionen der installierten Pakete, die für die Kompatibilität entscheidend sind, nichts zu tun. (Das ist bei TeX live etwas anders, da kann man an der Versionsnummer, die ein Jahr ist, immerhin grob Aussagen über die Paketversionen machen - genau geht es aber auch dort nicht.) Wichtig ist, ob Deine Vorlage mit den aktuellen CTAN-Versionen der Pakete zusammenarbeitet.

IANAL, dennoch würde mir das mit der Lizenz gut überlegen. Ich sehe das nicht ganz so streng wie Johannes, dass keine Lizenz keine Nutzung bedeutet. Zumindest private Nutzung ohne Veröffentlichung des Ergebnisses wäre wohl schwer zu unterbinden. Ich weiß auch nicht, was der gesetzliche Status von einem Fork bei github ist. Aber es kann Nutzer vor erhebliche Probleme stellen, wenn sie deine Vorlage nutzen wollen und sie womöglich ändern möchten/müssen. Wenn sie ihr Dokument dann öffentlich verfügbar machen wird es womöglich kritisch. Außerdem musst Du Dir überlegen, was Du davon halten würdest, wenn ich Deine Vorlage nehme und sie morgen als 'Super-Template' für 10€ pro Download verhökere.

Was die Pakete angeht, ist Dein Standpunkt, dass jeder, der die Pakete nicht nutzt, sie ja rauswerfen kann, meiner Meinung nach nicht ideal. Was da ist, könnte für die Funktionsweise ja wichtig sein. Woher soll jetzt ein Neuling (das ist Deine Zielgruppe) das erkennen können. Stattdessen wird er mit einer Wand an Paketen konfrontiert, von denen er unter Umständen nur zwei braucht. Ich bin mir auch nicht sicher, ob Du wirklich Recherche ersparst. Entweder muss der Neuling zunächst alle geladenen Pakete selbst googeln und ihren Nutzen feststellen, sowie, wenn er sie benötigt, sich daran erinnern und sie nutzen. Oder es wird drauf hinauslaufen, dass er bei Bedarf nach einer Lösung sucht, eine findet und dann feststellt, dass Du das Paket bereits geladen hast - im Idealfall. Wenn es schlecht läuft, gibt es mehrerer Alternativen und er lädt eine, die mit Deinen Paketen inkompatibel ist, bekommt viele Fehler und wundert sich (woher soll er auch wissen, was Du alles lädst). Im mediumguten Fall googelt der Nutzer, findet mehre Vorschläge, vergleicht mit Deinen Paketen und nutzt dann Deinen Vorschlag, weil der Dir vertraut - das kann aber mehr Aufwand bedeuten, als zu googeln und dann die Wahl selbst zu treffen.
Es kann also sein, dass Deine Vorlage für mehr Aufwand sorgt und dann auch noch selbstbewusst Vorschläge gibt, ohne diese zu diskutieren.

Wenn es darum geht, aufzuzeigen, welche Pakete für welche Zwecke gut sind, ist eine Vorlage die denkbar schlechteste Form, diese Information darzustellen. In vielen Fällen ist die Frage, welches von ähnlichen Paketen in einem bestimmten Fall "besser" ist, recht nuanciert. Und eine Vorlage ist keine Diskussion von Paketen.

Neues Thema eröffnen Neue Antwort erstellen Gehe zu Seite Zurück  1, 2



Options and Permissions
Beiträge der letzten Zeit anzeigen:

Du kannst Beiträge in dieses Forum schreiben.
Du kannst auf Beiträge in diesem Forum antworten.
Du kannst deine Beiträge in diesem Forum nicht bearbeiten.
Du kannst deine Beiträge in diesem Forum nicht löschen.
Du kannst an Umfragen in diesem Forum nicht mitmachen.
Du kannst Dateien in diesem Forum nicht posten
Du kannst Dateien in diesem Forum herunterladen
.

goLaTeX ist Teil der goForen
goForen.de goMATLAB.de goLaTeX.de goPCB.de


  Impressum | FAQ | goLaTeX RSS Button RSS-Feed

Copyright © 2008 - 2017 goLaTeX.de