Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

Table of Contents

Table of Contents

...

Verwenden Sie Referenzierungen im Ihrer Arbeit so, dass sie kein grammatikalischer Bestandteil des Satzes sind - der Text sollte auch nach Eliminieren aller geklammerten Bestandteile, einschließlich der in eckigen Klammern befindlichen Referenzen, noch grammatikalisch korrekt sein. Üblicherweise erreicht man dies durch die Nennung der Autoren eines Werkes, gefolgt von der Referenz. Im Text sollten Autoren typischerweise ohne Vornamen genannt werden (jedoch sollten Autorenvornamen bei den Referenzen selbst vollständig genannt werden, siehe unten). Bei mehreren Autoren sollten entweder alle genannt werden, oder es sollte die Existenz weiterer Autoren durch „et al.“ kenntlich gemacht werden.

The citation comes at the end of the sentence, yet it appears inside the period (because it is part of the sentence). If the citation is preceded by a quotation from the cited work, then the citation is placed outside the quotation marks (because it isn’t part of the quotation) [LitWeb]

Schlecht:

„Wie in [42] beschrieben, ...“

Gut:

„Wie von Harel et al. [42] beschrieben beschrieben, ...

Die Referenzen selbst sollten vollständig sein - also mehr sein als eine Sammlung von Suchbegriffen für google. Grundsätzlich sollten Angaben so vollständig wie möglich sein. So gehören z.B. zu einer Artikelreferenz nicht nur Autoren und Titel des Artikels, sondern auch bei Jahr/Monat des Erscheinens, bei Journalartikeln auch Name des Journals und gegebenenfalls Nummer und Herausgeber, sowie bei Tagungs-/Workshopartikeln der Name und Ort der Tagung. Vermeiden Sie Abkürzungen. Tagungsnamen sollten sowohl in ausgeschriebener Form als auch mit ihrem Kürzel genannt werden.

Schlecht:

„A. Mooij and N. Goga and J. Romijn. Non-local Choice and Beyond: Intricacies of MSC Choice Nodes. FASE'05, pages 273-288, 2005.“ „A. Mooij and N. Goga and J. Romijn. Non-local Choice and Beyond: Intricacies of MSC Choice Nodes. In Fundamental Approaches to Software Engineering, pages 273-288, April 2005.“

Gut:

„Arjan J. Mooij and Nicolae Goga and Judi Romijn. Non-local Choice and Beyond: Intricacies of MSC Choice Nodes. In Fundamental Approaches to Software Engineering (FASE '05), pages 273-288, Edinburgh, Scotland, April 2005.“

Achten Sie auf die Konsistenz der Einträge. So sollten z.B. alle Referenzen für ein Journal dieses Journal gleich referenzieren. Autoren sollten so referenziert werden, wie sie in der referenzierten Arbeit erscheinen; so sollten Vornamen nicht abgekürzt werden, wenn sie in der Arbeit selbst ausgeschrieben sind, ebenso sollten angegebene Mittelinitialen übernommen werden. Bei der Verwendung von URLs sollten Sie darauf achten, dass diese nicht über den Satzspiegel hinausragen; das Paket breakurl sorgt für den entsprechenden Zeilenumbruch von URLs.

Schlecht:

[1] Alur, Etessami, and Yannakakis. Inference of message sequence charts. IEEETSE: IEEE Transactions on Software Engineering, 29, 2003.

[2] Alan W. Biermann and Ramachandran Krishnaswamy. Constructing programs from example computations. IEEE Transactions on Software Engineering, 2(3):141-153, September 1976.

Gut:

[1] Rajeev Alur, Kousha Etessami, and Mihalis Yannakakis. Inference of message sequence charts. IEEE Transactions on Software Engineering, 29:304NAK313, 2003.

[2] Alan W. Biermann and Ramachandran Krishnaswamy. Constructing programs from example computations. IEEE Transactions on Software Engineering, 2(3):141-153, September 1976.

Die Bibliographie sollte nach Nachnamen des Erstautors sortiert sein. Bei der (stark empfohlenen) Verwendung von BibTeX sollten Sie für jede Referenz den richtigen, möglichst spezifischen Referenztyp verwenden (z.B. @InProceedings statt @Misc). Die für den jeweiligen Referenztyp vorgesehenen Pflichtfelder geben bereits einen ersten Hinweis für die Mindestinformationen; die weiteren optionalen Eintragsfelder sollten aber auch so weit wie möglich verwendet werden. Falls bibtex bei Erzeugung der Referenzen einen Fehler meldet, z.B. aufgrund eines fehlenden Pflichtfeldes, sollte dieses auf alle Fälle korrigiert werden. Für Ihre Arbeitserleichterung sollten Sie ein konsistentes Schema für die Indizierung verwenden, so dass Sie den Index möglichst aus Autoren & Erscheinungsjahr erschließen können, und Referenzierungen in Ihren Text einfügen können, ohne den Index in der BibTeX-Datei nachsehen zu müssen. Die Verwendung eines bestimmten Schemas ist insbesondere dann erforderlich, falls Sie eine gemeinsam genutzte BibTeX-Datei bearbeiten. So gibt z.B. die am Lehrstuhl genutzte cau-rt.bib-Datei ein Schema vor, welches am Anfang dieser Datei beschrieben ist.

  • Literaturangaben möglichst als integrierten Teil des Satzes (nicht außerhalb des Satzes anbringen).
  • Literaturangaben keinesfalls hinter das Satzendzeichen (z.B. nach dem Punkt).
  • Auch in Abbildungen, die nicht selbst/selbständig erstellt wurden darf die Literaturangabe nicht fehlen (z.B. (nach Schmidt [3])).
  • Für URLs, Verweise auf Webseiten (z.B. www.eclipse.org) eignen sich am besten Fußnoten.
  • Bib-Eintränge kontrollieren (Titel, Autoren (durch and getrennt, nicht kommasepariert!), Datum, Ort!).
  • Bib-Einträge: Wörter, die groß geschrieben werden sollten in geschweifte Klammern setzen.
  • Bib-Einträge auf Englisch oder Deutsch (je nach Arbeit!).
  • Literaturangaben nicht als Nomen in den Satz einbetten. 
    Merkregel: Der Satz sollte sich auch ohne die Literaturangabe sinnvoll lesen lassen.
  • Nur Primärliteratur oder (bewährte) Fachbücher: Z.B. keine Foliensätze/Lectures referenzieren.

Acronyms

  • Das Akronympaket ist zu verwenden (z.B. \ac{kieler}).
  • Indentierung bei Akronymverzeichnis ist einheitlich und linksbündig zu gestalten.
  • In Überschriften (gilt auch für Bildunterschriften) explizit die Langform verwenden (\acl). Achtung: Hier darauf achten, daß das Akronym im Text dennoch eingeführt wird!
  • Ausnahmeregelung: Allgemein bekannte Abkürzungen wie GUI. Hier die Langform gar nicht verwenden.
  • Akronyme konsistent halten.
  • Allgemein übliche Akronyme nicht so üblichen Akronymen vorziehen.
  • Akronyme niemals trennen.

Figures and Listings

...

 [42]

The citation comes at the end of the sentence, yet it appears inside the period (because it is part of the sentence). If the citation follows a quotation from the cited work, then the citation is placed outside the quotation marks (because it isn’t part of the quotation).

Vor Referenzen steht eine Leerstelle, hier sollte aber nicht umgebrochen werden  (in Latex: ~).

Schlecht:

„Wie von Harel[42] beschrieben, ...“

Gut:

„Wie von Harel [42] beschrieben, ...“

Die Referenzen selbst sollten vollständig sein - also mehr sein als eine Sammlung von Suchbegriffen für google. Grundsätzlich sollten Angaben so vollständig wie möglich sein. So gehören z.B. zu einer Artikelreferenz nicht nur Autoren und Titel des Artikels, sondern auch bei Jahr/Monat des Erscheinens, bei Journalartikeln auch Name des Journals und gegebenenfalls Nummer und Herausgeber, sowie bei Tagungs-/Workshopartikeln der Name und Ort der Tagung. Vermeiden Sie Abkürzungen. Tagungsnamen sollten sowohl in ausgeschriebener Form als auch mit ihrem Kürzel genannt werden.

Schlecht:

„A. Mooij and N. Goga and J. Romijn. Non-local Choice and Beyond: Intricacies of MSC Choice Nodes. FASE'05, pages 273-288, 2005.“ „A. Mooij and N. Goga and J. Romijn. Non-local Choice and Beyond: Intricacies of MSC Choice Nodes. In Fundamental Approaches to Software Engineering, pages 273-288, April 2005.“

Gut:

„Arjan J. Mooij and Nicolae Goga and Judi Romijn. Non-local Choice and Beyond: Intricacies of MSC Choice Nodes. In Fundamental Approaches to Software Engineering (FASE '05), pages 273-288, Edinburgh, Scotland, April 2005.“

Achten Sie auf die Konsistenz der Einträge. So sollten z.B. alle Referenzen für ein Journal dieses Journal gleich referenzieren. Autoren sollten so referenziert werden, wie sie in der referenzierten Arbeit erscheinen; so sollten Vornamen nicht abgekürzt werden, wenn sie in der Arbeit selbst ausgeschrieben sind, ebenso sollten angegebene Mittelinitialen übernommen werden. Bei der Verwendung von URLs sollten Sie darauf achten, dass diese nicht über den Satzspiegel hinausragen; das Paket breakurl sorgt für den entsprechenden Zeilenumbruch von URLs.

Schlecht:

[1] Alur, Etessami, and Yannakakis. Inference of message sequence charts. IEEETSE: IEEE Transactions on Software Engineering, 29, 2003.

[2] Alan W. Biermann and Ramachandran Krishnaswamy. Constructing programs from example computations. IEEE Transactions on Software Engineering, 2(3):141-153, September 1976.

Gut:

[1] Rajeev Alur, Kousha Etessami, and Mihalis Yannakakis. Inference of message sequence charts. IEEE Transactions on Software Engineering, 29:304NAK313, 2003.

[2] Alan W. Biermann and Ramachandran Krishnaswamy. Constructing programs from example computations. IEEE Transactions on Software Engineering, 2(3):141-153, September 1976.

Die Bibliographie sollte nach Nachnamen des Erstautors sortiert sein. Bei der (stark empfohlenen) Verwendung von BibTeX sollten Sie für jede Referenz den richtigen, möglichst spezifischen Referenztyp verwenden (z.B. @InProceedings statt @Misc). Die für den jeweiligen Referenztyp vorgesehenen Pflichtfelder geben bereits einen ersten Hinweis für die Mindestinformationen; die weiteren optionalen Eintragsfelder sollten aber auch so weit wie möglich verwendet werden. Falls bibtex bei Erzeugung der Referenzen einen Fehler meldet, z.B. aufgrund eines fehlenden Pflichtfeldes, sollte dieses auf alle Fälle korrigiert werden. Für Ihre Arbeitserleichterung sollten Sie ein konsistentes Schema für die Indizierung verwenden, so dass Sie den Index möglichst aus Autoren & Erscheinungsjahr erschließen können, und Referenzierungen in Ihren Text einfügen können, ohne den Index in der BibTeX-Datei nachsehen zu müssen. Die Verwendung eines bestimmten Schemas ist insbesondere dann erforderlich, falls Sie eine gemeinsam genutzte BibTeX-Datei bearbeiten. So gibt z.B. die am Lehrstuhl genutzte cau-rt.bib-Datei ein Schema vor, welches am Anfang dieser Datei beschrieben ist.

  • Literaturangaben möglichst als integrierten Teil des Satzes (nicht außerhalb des Satzes anbringen).
  • Literaturangaben keinesfalls hinter das Satzendzeichen (z.B. nach dem Punkt).
  • Auch in Abbildungen, die nicht selbst/selbständig erstellt wurden darf die Literaturangabe nicht fehlen (z.B. (nach Schmidt [3])).
  • Für URLs, Verweise auf Webseiten (z.B. www.eclipse.org) eignen sich am besten Fußnoten.
  • Bib-Eintränge kontrollieren (Titel, Autoren (durch and getrennt, nicht kommasepariert!), Datum, Ort!).
  • Bib-Einträge: Wörter, die groß geschrieben werden sollten in geschweifte Klammern setzen.
  • Bib-Einträge auf Englisch oder Deutsch (je nach Arbeit!).
  • Literaturangaben nicht als Nomen in den Satz einbetten. 
    Merkregel: Der Satz sollte sich auch ohne die Literaturangabe sinnvoll lesen lassen.
  • Nur Primärliteratur oder (bewährte) Fachbücher: Z.B. keine Foliensätze/Lectures referenzieren.

Acronyms

  • Das Akronympaket ist zu verwenden (z.B. \ac{kieler}).
  • Indentierung bei Akronymverzeichnis ist einheitlich und linksbündig zu gestalten.
  • In Überschriften (gilt auch für Bildunterschriften) explizit die Langform verwenden (\acl). Achtung: Hier darauf achten, daß das Akronym im Text dennoch eingeführt wird!
  • Ausnahmeregelung: Allgemein bekannte Abkürzungen wie GUI. Hier die Langform gar nicht verwenden.
  • Akronyme konsistent halten.
  • Allgemein übliche Akronyme nicht so üblichen Akronymen vorziehen.
  • Akronyme niemals trennen.

Figures and Listings

  • Größe: Nicht unter 80% der Seitenbreite, möglichst 100% (Textbreite ausnutzen!)
  • Ähnliche Abbildungen sollten auch vergleichbar/gleich groß sein.
  • Schriftgröße in Abbildungen sollte ca. der Schriftgröße des Textes entsprechen.
  • Wenn Textteile der Abbildung im Text zitiert werden, ist auf ein konsistentes Schriftbild zu achten, ggf. \sf verwenden.
  • Abbildungen immer mit Nummer und sinnvoller Überschrift versehen.
  • Überschrift abstrakt und so kurz wie möglich, so lang wie nötig halten (es sollte ohne Lesen des Textes verständlich sein, was die Abbildung zeigt).
  • Diagramme sollten i.d.R. eine Legende haben (Bedeutung von Farben/Formen nicht nur im Text erläutern).
  • Abbildungen immer in der selben Reihenfolge im Dokument anordnen, in welcher sie im Text referenziert werden.
  • Abbildungen möglichst immer in der Nähe des erklärenden Textes anordnen.
  • Jede Abbildung muss auch beschrieben werden.
  • Autolayout einsetzen für entsprechende Diagrammtypen (z.B. Klassendiagramm).
  • Einheitliche Schriftgröße für alle Listings verwenden.
  • Akronyme in Bildunterschriften s.o.
  • Listings in Figures vermeiden (dies kann zu speziellen Latex-Problemen führen)
  • For listings, use a \sf (sans serifs) or \tt (typewriter/courier) font. For an \sf font, use flexible column spacing (\lstset{columns=flexible} or \lstset{columns=fullflexible})
  • And perhaps the most common issue: when referring to statements, variable names, etc. from a listing, use a formatting that is consistent with the listing. Eg, if you use \sf in your listings, write "then \textsf{x} is set to 17". (Not: "then x is set to 17" or "then \textsf{x} is set to \textsf{17}".) The same applies to graphical languages. Eg, if a Statechart transition has a transition label "x / y" and is formatted in \sf, then references to x and y should also be formatted set in \sf.

Cross References

  • Bezeichnung sollte korrekt sein: z.B. Kapitel 2, Unterkapitel 2.1, Abschnitt 2.3.4, Absatz
    • Nicht: z.B. Kapitel 2.1
  • Rückwärtsverweise sind ok, Vorwärtsverweise sind zu vermeiden.
  • Zu viele Verweise stören den Lesefluss, wichtige Dinge sollten an geeigneter Stelle auch (evtl. kürzer) wiederholt werden.
  • Abbildungen/Tabellen immer konkret benennen.

...