Standards und Konventionen

Um allen Autoren zu ermöglichen, möglichst unkompliziert Quelltexte lesen sowie ändern zu können, und eine gewisse Konsistenz zu gewährleisten, sollten die im folgenden angeführten Standards/Konventionen eingehalten werden.

Quelltexte allgemein

max. Zeilenlänge: 80 Zeichen

Terminals haben i.d.R. eine Zeilenbreite von 80 Zeichen. D.h. längere Zeilen werden entweder vom jeweiligen Editor entweder abgeschnitten oder umgebrochen. Das wirkt fast immer sich negativ auf die Lesbarkeit/Editierbarkeit des Textes aus. Ebenso ist ohne Verwendung spezieller Druckvorstufen (z.B. mp) die Zeilenlänge von gedruckten Textdateien ebenfalls i.d.R. auf max. 80 Zeichen begrenzt, was bei längeren Zeilen somit zum Abschneiden des jeweiligen Zeilenendes (und nicht zum automatischen Umbruch) führt.

Sicher, manchmal sind längere Zeilen unumgänglich (z.B. bei sehr langen Link-Angaben), aber das sollten die Ausnahmen sein, die die Regel bestätigen ;-)

Einrückung: Tabulatoren

Moderne Editoren/Pager lassen es zu, die Breite eines Tabulators in Anzahl von Leerzeichen (tab width; default = 8) zu setzen. Ergo ist die Verwendung von Leerzeichen zur Einrückung aka indentation nicht mehr notwendig und trifft das oftmals in älteren Projekten angeführte Argument der "unterschiedlichen Darstellung des Textes" nicht mehr zu (jeder Entwickler sollte sein Werkzeug so kennen, daß er diese Einstellung problemlos vornehmen kann)! Vorteil ist, daß durch Verwendung von Tabulatoren der Quelltext volumenmäßig bedeutend kleiner wird (nur noch 1 statt N Zeichen) und damit schneller von entsprechenden Programmen verarbeitet/übertragen werden kann.

Tabulatoren-Breite: 4 Leerzeichen

Die Tabulatoren-Breite aka "tab width" ist die Anzahl von Leerzeichen, die von einem Editor/Anzeigegerät stellvertretend für die Darstellung eines Tabulators verwendet wird. Hinsichtlich Lesbarkeit hat sich hier der Wert 4 als optimal erwiesen.

Zeilenende (EOL): Zeilenvorschub (linefeed = LF = 0xA)

Sicher ist bekannt, daß unter UNIX basierten Systemen in Textdateien das Zeilenende durch einen Zeilenvorschub (engl. linefeed, gebräuchliche Abkürzung <LF>, hexadezimal 0xA) gekennzeichnet wird. In DOS/Windows ist es dagegen ein Wagenrücklauf (carriage return, <CR>, 0xD) gefolgt von einem <LF> (also <CR><LF>). Unter MacOS < 10.x ist es dagegen nur ein <CR>. Sprich, verwendet jeder, daß was er will, wird sich der Kollege freuen, wenn sein Editor plötzlich am Zeilenende ein Steuerzeichen (^M für <CR>) darstellt, in einem anderen sämtlicher Text nur in einer einzigen Zeile erscheint (DOS-Editor). Ergo ist es von Vorteil, wenn man sich rechtzeitig auf ein Format einigt, und jeder einen entsprechenden Editor nutzt, der die Darstellung korrekt wiedergibt und beibehält (nicht wie die "pseudo"-intelligente Editoren von Winzigweich, die ohne zu fragen, alle Zeilenenden durch das ihnen beliebende Format - DOS - ersetzen).

Da unser Server ein UNIX-basierter Server ist, die Verarbeitung von Quelltexten auch mittels simplen Tools wie awk, sed oder vi (z.B. zwecks Hotfixes oder Restrukturierung) problemlos verarbeitbar sein sollen, XML-Prozessoren die EOL-Markierungen der unterschiedlichen Systeme eh auf ein einzige <LF> reduzieren müssen, ist es sinnvoll, grundsätzlich nur <LF> als Zeilenende-Markierung zuzulassen.

HTML/XHTML

Formatierung: siehe oben
Kodierung: iso-8859-1

Jede Seite hat grundsätzlich mit der Deklaration der verwendeten Kodierung zu beginnen. Soweit nicht Zeichen eines spezifischen Zeichensatzes (z.B. UTF-8) benötigt werden, ist der Latin-1 Zeichensatz zu verwenden:

<?xml version="1.0" encoding="iso-8859-1"?>

Damit können und sollen zwecks besserer Lesbarkeit alle Zeichen westeuropäischer Sprachen direkt verwendet werden. Also schreibt man direkt ß statt &slzig; bzw. ä statt &auml;, usw.

Definiert ist der Zeichensatz im RFC 1345. In SELFHTML: Zeichensätze (ISO-8859-Familie und andere) kann man sich einen visuellen Überlick davon verschaffen.

Dokument-Typ: XHTML 1.x

Als Dokument-Typ verwenden wir XHTML 1.1, welches im Prinzip die modularisierte Form von XHTML 1.0 ist, wobei XHTML 1.0 als HTML 4.01 in XML Version 1.0 definiert verstanden werden kann.

Ergo sollte asl zweite Zeile (nach dem Encoding) folgender code auftauchen:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

Vorteil gegenüber dem bisher verwendeten HTML ist, daß Dokumente zuverlässig auf ihre Korrektheit überprüft und damit auch maschinell besser verarbeit werden können. Ebenso haben Webbrowser weniger Interpretations-Spielraum, den aufgrund der verwendung von XML steht eindeutig fest, welches Element zu welchem gehört. Das ist bei HTML nicht der Fall, da dort oftmals die Beendigung eines Elements aka Tags optional ist (und damit auch oftmals weggelassen wird) ...

Wem anfangs XHTML schwerfallen sollte (z.B. weil die DTDs nicht sonderlich gut lesbar/verständlich sind), kann im Prinzip immer bei HTML 4.01 nachschlagen, sollte aber darauf achten, daß die jeweiligen Elemente immer beendet werden. Also beispielsweise <img src="/image/logo.gif"/> oder <hr/>.

Java

Formatierung: siehe oben
Code-Konventionen: Code Conventions for the Java Programming Language
weitere Detailierung: t.b.d.