Struktur von LaTeX-Dokumenten

Fragen und Probleme, die nicht den obigen Kategorien zugeordnet werden können


duerrto
Forum-Newbie
Forum-Newbie
Beiträge: 4
Registriert: Do 15. Apr 2010, 14:06

Struktur von LaTeX-Dokumenten

Beitrag von duerrto »

Guten Tag

Die Frage ist, wie dass ihr eure LaTeX-Dokumente strukturiert. Ich mache es Beispielsweise so:

Angenommen, ich schriebe eine Arbeit über "Mineralwasser":

Jede Arbeit bekommt einzeln einen Ordner:
/home/Dokumente/Arbeiten/Mineralwasser
Im Ordner "Mineralwasser" befinden sich 4 weiter Ordner und 2 Dateien.

Die 2 Dateien:
Mineralwasser.tmproj %Texmate Projekt-Datei
Eine sehr zentrale Datei in der Strukturierung. Wenn ich an einem Projekt arbeiten möchte, öffne ich nur diese und habe sofort eine Übersicht über alle Dateien – Kapitel, Literaturverzeichnis usw.
Mineralwasser.tex %Hauptdatei
In dieser Datei wird eigentlich nur mit dem Befehl \input eingebunden:

Die "Mineralwasser.tex" im Detail:
% Präambel einbinden
\include{Includes/Preamble}

% Hier beginnt das Dokument
\begin{document}

% Titelseite einbinden
\include{Includes/Titlepage}

% Das Inhaltsverzeichnis wird gesetzt
\tableofcontents

% Seitenumbruch
\newpage

% Sections einbinden
\include{Sections/Section1}

% Literaturverzeichnis einfügen
% \bibliography{References/Bibliography}{}
% \bibliographystyle{unsrt}

% Glossars einfügen
% \printgloss{References/Glossar}

% Abbildungsverzeichnis einfügen
% \listoffigures

% Tabellenverzeichnis einfügen
% \listoftables

% Hier endet das Dokument
\end{document}
Die ganzen Verzeichnisse können bei Bedarf eingefügt werden, indem ich nur die Kommentarzeichen (%) entferne.

Die 4 Ordner:
Includes
% In diesem Ordner befinden sich zwei Dateien: "Titlepage.tex" und "Preamble.tex"
Multimedia
% In diesem Ordner befinden sich Grafiken und Bilder
Reference
%In diesem Ordner befindet sich Dateien wie "Bibliography.bib" oder "Glossary.tex"
Sections
% In diesem Ordner befinden sich die verschiedenen Abschnitte meines Arikels. Beispielsweise "MineralwasserGeschichte.tex" oder MineralwasserHerstellung.tex" die ich jeweils mit dem Befehl \input in "Mineralwasser.tex" einbinde

Die ganze Struktur habe ich natürlich als Vorlage abgespeichert. Bei Bedarf kopiere ich ein ganzes Paket Ordner an den richtigen Platz und muss es anschliessend nur noch umbenennen.

Wie handelt ihr die ganze Struktur bei grösseren Arbeiten?


Gruss
duerrto

Benutzeravatar
bloodworks
Moderator
Moderator
Beiträge: 1425
Registriert: Mo 19. Jan 2009, 10:52
Wohnort: /dev/null

Beitrag von bloodworks »

Hallo

Das Strukturieren von Dokumenten hängt sehr von der Arbeitsweise, der Anzahl der Mitautoren etc etc ab. Auch davon ob du ein Versioning oder Tracking System verwendest wie git cvs...

Ich konstruiere mal den folgende Fall:
Kapitel inhaltlich unabhängig
Bilder nur in einem Kapitel
Pro Kapitel nur 1 Autor.


ich würde folgendes vorschalgen
/Projekt
 Header.tex
 Hauptdatei.tex
|--/Kapitel1
   Kapitel2_haupt.tex
   Abschnitt1.tex
   Abschnitt2.tex
   Kapitel1.bib
   /Bilder/
...
|--/Kapitel2
   Kapitel2_haupt.tex
   Abschnitt1.tex
   Abschnitt2.tex
   Kapitel2.bib
    /Bilder/
....


Ich habe das immer so gemacht, dass ich die Bilder in den Kapitel habe, die Pfade relativ zum Hauptdokument angebe. Das hat den Grund, dass die Kapitelautoren nur in dem jeweiligen Kapitelordner rumasen und nicht auf einen globalen Bilderordner zugreifen und dort sachen überschreiben etc. Zudem kann ich dann einem Autor auch nur Schreibrechte auf dem Ordner geben. wir sind bisher mit der Ordnung ganz gut gefahren.


Da wir immer nur die KapitelN_haupt.tex in das Hauptdokument einbinden und der erste Befehl immer! (-> Policy) \chapter ist, verwenden wie im übrigen nur input anstatt includes. Ach ja wir verwenden nie newpages.

Wichtig ist beim erstellen eines Projekts:

- Policies festschreiben
- Ordnung so machen, dass auch nur Teilzugriff möglich ist,
- sich daran halten

Ich halte es für relativ sinnlos, eine Struktur zu speichern, da man eigentlich die Struktur den Gegebenheiten anpsssen muss. Dazu gehören u.a. :
Anzahl Autoren
Menge an Überschneidungen in Einzeldokumenten
Anzahl Seiten/Umfange
Versioning System ja/nein
Verständnis der Autoren

Wenn ich zB ein Buch herausgeben würde und Autoren hätte die sich nie gesehen haben, würde ich NIE denen erlauben sich den Hauptstamm (Hauptdatei, Header etc) anzuschauen.

Wenn ich mit 2 Mitarbeitern, die in dem Büro neben mir sitzen was schreiben würde, dann sieht das natürlich ganz anderst aus.
[1] Nützliche Webdokumente für Anfänger und Fortgeschrittene
[2]Minimalbeispiel | [3]FAQ
[4]Regelwerk | [5] Knigge
Wenn nicht anderst angegeben ist mein System: texlive 2012, pdflatex, x86-64, Snow Leopard utd.
Angehöriger der Liga zur Verwendung von texdoc
texdoc mathmode koma l2picfaq l2tabu lshort-en
Achtung: Aufforderungen ein Minimalbeispiel oder mehr Erklärungen zu einer Frage zu liefern sind keine persönlichen Angriffe. Sie dienen viel mehr dazu die Kommunikation zwischen Fragendem und potentiellen Helfern zu erleichtern und zu präzisieren.


duerrto
Forum-Newbie
Forum-Newbie
Beiträge: 4
Registriert: Do 15. Apr 2010, 14:06

Beitrag von duerrto »

Hallo

Die Anzahl der Mitautoren habe ich nicht bedacht da ich bis jetzt immer alleine gearbeitet habe. Ich brauche LaTeX vor allem für die Schule; für Zusammenfassungen von Themen oder ähnlichem. Die Form bewegt sich immer etwa im gleichen Rahen und daher empfinde ich es für mich als sinnvoll mit einer Vorlage zu arbeiten.

Zum Thema CVS oder allgemein Versionsverwaltung habe ich noch eine Frage. Und zwar grundsätzlich: Wie stellt ihr das an? Welche Software nehmt ihr zu Hilfe?

Gruss
duerrto

Benutzeravatar
bloodworks
Moderator
Moderator
Beiträge: 1425
Registriert: Mo 19. Jan 2009, 10:52
Wohnort: /dev/null

Beitrag von bloodworks »

Also ich für meine privaten Zwecke nehme ich gar nichts. Das mache ich von Hand wenn ich das will. Zumindest bisher. (Ich hab da so ne Spiegelung meiner Festplatte, damit kann ich zumindest nen Teil einer Version wieder hohlen...)

Für andere Projekte bietet sich das sicher an, besonders wenn es an der Stelle/Institution schon was gibt, so was wie Subversion, git oder baazar.

Für lediglich ein Dokument ist die Einrichtung und das Lernen von git etc. etwas too much, zumindest für meine Verhältnisse. Baazar solle etwas leichter sein, das würde sich vll anbieten. Im Prinzip gilt, dass die ganzen Systeme sehr sehr umfangreich sind und man sollte sich deshalb gut überlegen, ob man sich das antut, bzw. ob es sich lohnt. Außerdem sind sie alle für Software gedacht.


http://en.wikipedia.org/wiki/Comparison ... l_software
[1] Nützliche Webdokumente für Anfänger und Fortgeschrittene
[2]Minimalbeispiel | [3]FAQ
[4]Regelwerk | [5] Knigge
Wenn nicht anderst angegeben ist mein System: texlive 2012, pdflatex, x86-64, Snow Leopard utd.
Angehöriger der Liga zur Verwendung von texdoc
texdoc mathmode koma l2picfaq l2tabu lshort-en
Achtung: Aufforderungen ein Minimalbeispiel oder mehr Erklärungen zu einer Frage zu liefern sind keine persönlichen Angriffe. Sie dienen viel mehr dazu die Kommunikation zwischen Fragendem und potentiellen Helfern zu erleichtern und zu präzisieren.


Artur
Forum-Fortgeschrittener
Forum-Fortgeschrittener
Beiträge: 56
Registriert: Mi 24. Mär 2010, 15:43

Beitrag von Artur »

deine Strukturierung ist gut, meine ist quasi dieselbe.

Falls du dich nicht in diese Versionisierungsprogramme einarbeiten willst, du alleiniger Autor bist, du TeXnicCenter benutzt und du trotzdem automatische Backups haben willst empfehle ich dir folgendes:

http://www.golatex.de/viewtopic.php?p=16915#16915

Klappt wunderbar, wenn man mal ausversehen an den Einstellungen rumgespielt hat und irgendwelche hundert Fehler aufeinmal auftauschen und du keine Lust auf Fehlersuche hast, kann man schnell auf eine alte Version zurückgreifen....

Antworten