LaTeX-Quelltext optisch übersichtlicher gestalten - wie?

[KloBoBBerLe]

Liebe Leser,

welche Möglichkeiten habt Ihr denn für Euch gefunden, um Euren LaTeX-Quelltext bei längeren Arbeiten möglichst übersichtlich zu strukturieren und gestalten?

Mir geht es nicht darum, das zu erstellende Dokument aufzuhübschen, sondern ausschließlich um den geskripteten LaTeX-Quelltext, welcher dann anschließend kompiliert werden soll. Interessant wären beispielsweise Strukturierungsideen für Überschriften, bestimmte Texteinheiten, etc.


Folgende Möglichkeiten würden mir einfallen:

• Erstellung optisch markanter Merkmale, z.B. durch die Nutzung der Kommentarfunktion und Schreiben von Zeichenketten (z.B. ----------------------------------)
• Nutzung von Leerzeilen
• Einrücken bestimmter Quelltext-Kategorien anhand von Tabs oder Leerzeichen

Gibt es bessere Alternativen? Wie löst Ihr solche Übersichtlichkeitsproblemchen?

Besten Dank für Eure Antworten!

Viele Grüße
KloBoBBerLe

[Noch so einer]

Leerzeilen sind Absätze und sollten deshalb auch wirklich nur dort eingesetzt werden, wo Absätze sind. Ansonsten verwendet man horizontalen Einzug, um Definitions-, Gruppen- und Umgebungsebenen zu kennzeichnen, etwa:

\newcommand*{\foo}{%
  Tue hier irgend etwas.
  Und mache das.
}

oder

\begin{bar}
  Das ist der Inhalt der Umgebung und deshalb links\footnote{Rechts
    ist dagegen kein Einzug notwendig.}
  eingezogen.
\end{bar}

Viel mehr braucht man bei einem vernünftigen Editor, der Syntax-Hervorhebung wie hier im Forum beherrscht, auch nicht. Was ich immer besonders lästig finde, sind Dokumente, in denen drei und mehr Leerzeilen verwendet werden, um Code irgendwie abzusetzen. Das stört für mich den Überblick mehr als es hilft.

[Stefan Kottwitz]

Hier ist eine Liste von Vorschlägen.

• Klar: Syntax-Hervorhebung verwenden, ein Editor sollte das beherrschen
• Einrücken von Verschachtelungen wie z.B. Code in Umgebungen, stets um die gleiche Breite je öffnender Umgebung. So behält man den Überblick, in welchem Level man ist, vergisst das Schließen einer Umgebung nicht, und man sieht auf einen Blick, wie lange lokale Einstellungen gelten.
• Zeilen nicht zu lang werden lassen. Ist das Fenster mal zu schmal im Editor oder im Browser in einem LaTeX-Forum, wird sonst automatisch umgebrochen und die Einrückungen sind gestört. Also lieber Umbruch nach max. 60 Zeichen und dann deutlich einrücken.
• Nach dem Zeilenumbruch einer Tabellenzeile durch \\ sollte auch die Zeile im Code umgebrochen werden, so passt Code-Struktur besser zur Ausgabe (statt Platz zu sparen).
• In Tabellen und mehrzeiligen mathematischen Umgebungen die Spaltentrenner "&" vertikal ausrichten
• Mehrere Leerzeichen im Code wirken genau wie eins, also gern Leerzeichen einfügen um Code-Struktur besser lesbar zu machen (wie vor &, vor Koordinaten mit verschiedener Länge, vor Optionen von gleichartigen Befehlen in mehreren aufeinanderfolgenden Zeilen, um = auszurichten in langen Optionenlisten bei TikZ, ...)
• Leerzeichen um = in Optionen, insbesondere wenn die keys schon Leerzeichen im Namen haben, ist es besser lesbar.
• Öffnende und schließende Klammern leicht erkennbar machen, z.B. jeweils auf eigener Zeile und gleicher horizontaler Position, so kommt man nicht durcheinander bei vielen Klammern. Achtung, Zeilenumbrüche, die ja wie Leerzeichen wirken, ggf. auskommentieren! Z.B. % nach öffnender Klammer am Zeilenende.
• Im Mathematik-Modus sind Leerzeichen unbedeutend, hier kannst Du viele einfügen, damit komplexe Formeln besser lesbar sind.
• Leerzeilen im Code bewirken Absatzumbruch, wenn Du wirklich vertikal trennen willst, dann mit % am Beginn der ansonsten leeren Zeile. Achtung dennoch, das könnte im Fließtext-Code fälschlich den Eindruck eines Absatzes erwecken.
• Kommentare verwenden - einerseits zur Erklärung von Code, andererseits kann man auch die Struktur klären, z.B. nach schließender Klammer ein Kommentar mit dem zugehörigen Makronamen.

Stefan

[Besserwisser]

[*] Leerzeichen um = in Optionen, insbesondere wenn die keys schon Leerzeichen im Namen haben, ist es besser lesbar.[/list]

Das sehe ich durchaus kritisch, da das Ignorieren von Leerzeichen vor und nach Gleichheitszeichen oder vor und nach Komma kein zwingender Automatismus ist, sondern explizit implementiert sein muss. Da sollte man also besser in die Anleitung schauen, ob das offiziell erlaubt ist.

[Stefan Kottwitz]

da das Ignorieren von Leerzeichen vor und nach Gleichheitszeichen oder vor und nach Komma kein zwingender Automatismus ist, sondern explizit implementiert sein muss.

Gute Anmerkung, ich schrieb das vor allem aus der Sicht auf TikZ und verwandte Pakete wie pgfplots, wo man jeweils oft sehr viele Optionen angibt und es von Vorteil ist und es auch funktioniert.

Stefan