HTML-Benutzung auf den Debian-Webseiten

Diese Seite ist noch im Entwurfsstadium.

Vorwort

Diese Seite wurde erstellt, um Autoren und Übersetzern zu helfen, gut formatierte Webseiten zu erstellen. Es werden Hilfestellungen zur Verwendung von Tags gegeben und wie man Seiten erstellt, die sich leichter übersetzen lassen.

Einige allgemeine Hilfestellungen

Für neue Seiten oder Übersetzungen folgt eine Liste von allgemeinen Ratschlägen.

Verwenden Sie keine langen Zeilen.
Die WML-Dateien und die anderen Dateien sollten Zeilen haben, die sich in einem normalen Terminalfenster anzeigen lassen. Solche Dateien sind einfacher in vi zu bearbeiten, lassen sich leichter durchsuchen und sind einfacher zu übersetzen. Da CVS zeilenorientiert arbeitet und in langen Zeilen Konflikte schwerer zu beheben sind, ist es wichtig, Zeilen nicht zu lang werden zu lassen.
Tags nach Möglichkeit in eine eigene Zeile setzen.
Die meisten HTML-Tags können in eigene Zeilen geschrieben werden. Hierzu zählen unter anderem: <div>, <p>, <table> und <ul>. Um die Arbeit der Übersetzer zu erleichtern, sollte dies immer eingehalten werden, da es sonst passieren kann, dass Tags versehentlich gelöscht und später nicht wieder eingefügt werden.
Verwenden Sie keine Leerzeichen oder Zeilenumbrüche in Inline-Tags
Einige Tags erzeugen ein Leerzeichen, wenn sie über verschiedenen Zeilen aufgeteilt werden. Eines dieser Tags ist das <q>-Tag für kurze Zitate oder wörtliche Rede. Sie sollten solche Tags nur als Ganzes in eine eigene Zeile setzen (das komplette Tag und mindestens das erste bzw. letzte Wort sollten in einer Zeile sein). Sonst kann es vorkommen, dass ein Leerzeichen zwischen dem Tag und dem darauffolgenden Wort in der resultierenden HTML-Seite zu sehen ist. Zwischen Worten innerhalb solcher Tags können beliebig viele Leerzeichen oder Zeilenumbrüche vorkommen.

Abkürzungen und Akronyme

Für Abkürzungen und Akronyme sollte das HTML-Tag <acronym> genutzt werden. Das <abbr>-Tag ist aus den folgenden beiden Gründen nicht zu empfehlen: Erstens unterstützen nicht alle Browser dieses Tag und zweitens existieren sich widersprechende Definitionen, was ein Akronym und was eine Abkürzung ist.

Ein Akronym wird zu einer Webseite durch folgende Syntax hinzugefügt: <acronym lang="Sprachcode" title="vollständige Definition des Akronyms">AKRONYM</acronym>. Der Titel gibt alle gesprochen Worte wieder. Sollte das Akronym aus den Anfangsbuchstaben von Worten bestehen, sollten diese in Großbuchstaben geschrieben werden. Das lang-Attribut wird nur benötigt, wenn es sich um eine Abkürzung oder ein Akronym in einer Fremdsprache handelt.

Es gibt bereits eine Anzahl vordefinierter Akronyme, die in den WML-Vorlagen enthalten sind und zur Nutzung auf einer Seite zur Verfügung stehen. Um diese nutzen zu können, muss die Zeile #use wml::debian::acronyms zur WML-Datei hinzugefügt werden. So wäre beispielsweise <acronym_DD /> das WML-Tag für DD.

Zitate

Es gibt in den unterschiedlichen Sprachen abweichende Definitionen, was ein Zitat ist. Bei kurzen Zitaten im Text sollten Sie das <q>-Tag verwenden. Die Darstellungsweise wird von einem CSS festgelegt. <q>-Tags dürfen keine Leerzeichen oder Zeilenumbrüche zwischen dem öffnenden beziehungsweise dem schließenden Tag und dem Inhalt haben.

Für längere Zitate wird das <blockquote>-Tag verwendet. Ein <blockquote> umschließt einen oder mehrere Absätze, die mit einem <p>-Tag ausgezeichnet sind. Bitte verwenden Sie keine <blockquote>-Tags um Texte, die keine Zitate sind, zu zentrieren. Dieses Tag ist ausschließlich für längere Zitate gedacht und wird in Zukunft von einem sprachabhängigen CSS formatiert.

Außerdem gibt es in HTML noch das <cite>-Tag. Es ist nicht für Zitate selbst gedacht, sondern um deren Quelle anzugeben. Dies kann zum Beispiel der Name der Person, die diese Aussage gemacht hat und wird dem <blockquote>-Tag als Attribut in Form einer URL hinzugefügt.

Programmnamen und Quellcode

Für Programmnamen und Quellcode wird das Tag <code> genutzt. Im Allgemeinen wissen Browser, wie Programmnamen und Quellcode dargestellt werden soll, dieses Verhalten kann aber durch ein CSS geändert werden. Man sollte nicht <tt> stattdessen nutzen, da es nichts über die Art des Inhalts aussagt.

Beispiele von Bildschirmausgaben

Für die Bildschirmausgaben eines Computers existiert das spezielle <samp>-Tag. Sollten Sie einen größeren Abschnitt einer solchen Ausgabe haben, sollten Sie sich die CSS-Datei ansehen und überprüfen, ob eine Klasse für dieses Tag existiert.

Tastatureingabe

Wenn es Beispiele von Tastatureingaben in Ihrem Text gibt, sollte das <kbd>-Tag hierfür genutzt werden. Bitte lesen Sie auch den Abschnitt zu Variablen, um zu erfahren, wie variable Eingaben ausgezeichnet werden.

Variablen

Manchmal ist es notwendig zu betonen, dass ein bestimmter Teil eines Programmaufrufes auf der Befehlszeile variabel ist (wie zum Beispiel eine IP-Adresse oder ein Benutzername). Für diese veränderlichen Eingaben wird das <var>-Tag verwandt.

Vorformatierter Inhalt

Das <pre>-Tag ist nur für vorformatierten Text gedacht. Hierbei werden Zeilenlänge, Leerzeichen und andere Formatierungen erhalten. Selbstverständlich kann dieses Tag die meisten anderen HTML-Tags nicht enthalten.

Bilder

Wenn Bilder zu einer Webseite hinzugefügt werden sollen, gibt es keinen Grund, das ungültige border-Attribut zu verwenden. Nach Möglichkeit sollten das Größenattribut (size) und ein Alternativtext (alt) angegeben werden. Die Größe wird von WML hinzugefügt, wenn sie nicht explizit angegeben wurde, dies erfordert aber Rechenzeit. Das alt-Attribut sollte einen Text enthalten, der für Benutzer von lynx oder Blinde beschreibt, was auf dem Bild zu sehen ist.