Seitenumbrüche im Quellcodebeispiel - ja oder nein?

Layout von Seiten, Rändern, Fusszeilen, usw, modifizieren


(umge/er)brochen

Seitenumbrüche im Quellcodebeispiel - ja oder nein?

Beitrag von (umge/er)brochen »

Hallo Allerseits!

Ich schreibe an einem Dokument mit vielen, unterschiedlich langen Quellcodebeispielen (1 bis ca. 100 Zeilen) und verwende dafür listings.

Manchmal passen die Quellcodebeispiele nicht mehr auf eine Seite, hier sehe ich drei Möglichkeiten, die man sich als Reaktion von Latex wünschen könnte:

1.) Seitenumbruch – Quelltext geht einfach auf der nächsten Seiten weiter, Seite ist voll, gelesen kann weiterhin schön simpel "der Reihe nach", ohne komplizierten Verweis.

2.) Gleitumgebung – zumindest für Beispiele die kürzer als eine Seite sind, der Quellcode wäre am Stück, es käme nicht zu "Verwirrungen" des Lesers, weil mitten im Lesen im schlimmsten Fall eine Seite umgeschlagen werden müsste. Allerdings müsste man dann einem Verweis auf den Quelltext folgen und er wäre nicht an der Stelle, wo man ohnehin schon hinschaut.

3.) Neue Seite – unter Umständen extrem große Lücken auf den Seiten, sieht richtig kotig aus, aber dafür wird man beim Lesen weder durch Umblättern noch durch Suchen des Quelltextes gefordert.

Wie würdet ihr die verschiedenen Möglichkeiten bewerten?

Seht ihr weitere Möglichkeiten? Abgesehen von einem Druck auf Endlospapier, das dann auf zwei Rollen befestigt wird, damit man ja nicht umblättern muss?

Viele Grüße,
Bruch

sudo
Forum-Guru
Forum-Guru
Beiträge: 459
Registriert: Mi 3. Okt 2012, 11:32

Beitrag von sudo »

Ich würde auf jeden Fall ein einheitliches Verhalten empfehlen. Nur kürzere Codes gleiten zu lassen fällt also aus. Ansonsten kommt es wahrscheinlich auf deine Vorlieben an. Ich persönlich mag Gleitumgebungen gern. Allerdings muss dann auch eine Über- oder Unterschrift dazu.
Ein vollständiges Minimalbeispiel (VM) zu erzeugen, ist gar nicht schwer und hilft ganz oft, Fehler selber zu finden. Ohne bekommt man selten gute Antworten. Anleitungen findest du z.B. im golatex Wiki auf TeXWelt oder minimalbeipiel.de
Außerdem hilft das Lesen dieser Seite, Fragen richtig zu stellen.

Benutzeravatar
Johannes_B
Moderator
Moderator
Beiträge: 5079
Registriert: Do 1. Nov 2012, 14:55
Kontaktdaten:

Beitrag von Johannes_B »

Die Beschriftung deiner Code-Beispiele würde ich dir so oder so anraten.
Wenn deine Beispiele länger als eine Seite werden ist Gleiten nicht mehr möglich (vergleiche auch Longtable), vielleicht ist also eine statische Umgebung empfehlenswerter.
Aber wie sudo schon sagte: Am wichtigsten ist die Einheitlichkeit.
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.

(umge/er)brochen

Beitrag von (umge/er)brochen »

Einen Titel haben die Quellcodebeispiele bereits, ebenso einen Querbalken am Anfang und am Ende (man könnte also meinen, dass der Leser nach 2-3 Beispielen gemerkt hat, dass die Quellcodes erst dann enden, wenn der Endbalken kommt).

Außerdem machen die Quellcodes einen Großteil des Inhalts aus, neben Grafiken und Tabellen (deren Gleiten und bei letzterem auch Umbrechen schon für Überforderung sorgt).

Antworten