Ausgezeichnet schreiben

Oft ist das Denken schwer,
indes, das Schreiben geht auch ohne es.
Wilhelm Busch

2004-12-12/24, 2005-01-04/08, 2005-02-05, 2005-07-02, 2007-07-01/09, 2007-12-25, 2008-04-06, 2008-11-29

Strukturierte Texte mit einer XML-Auszeichnungssprache wie XHTML erstellen

XHTML-Beispiele

Etwas beunruhigen tut mich schon, wie schlecht durchschnittliche internet-Projekte erstellt sind. Daher dachte ich mir, ich zeige hier einmal einfache Beispiele für strukturierte XHTML-Dokumente oder -Fragmente.

Dokumentstruktur

Ein Beispiel für ein Einzeldokument zeigt, daß man schon mit wenigen verschiedenen Elementen relativ weit kommt. Solch ein für sich selbst stehendes Dokument eignet sich besonders für ein abgeschlossenes Thema. Ein Beispiel mit Inhalt ist etwa der Projekt-Artikel.

Letzteres Beispiel geht schon etwas über ein Einzeldokument hinaus, zeigt aber auch, daß innerhalb von größeren Einzeldokumenten Navigationsmenüs sinnvoll sein können. Diese werden dann bei ganzen Projekten unverzichtbar, wo zum Beispiel in jedem Einzeldokument ein einzelnes Kapitel untergebracht wird - oder wie bei diesem Projekt hier ein mehr oder weniger abgeschlossenes Thema aus einem Gesamtthemenkomplex, im Falle von Ausgezeichnet schreiben sogar mit Unterkapiteln versehen. Prinzipiell kann die gesamte Navigation mittels des Elementes link realisiert werden. Praktisch liegt da aber eine mangelhafte Interpretation bei einigen Darstellungsprogrammen vor, bei anderen eine nicht vorhandene, so daß auf Indexseiten zurückgegriffen wird oder auf Teildokumente in jedem einzelnen Dokument, welche nur der Navigation dienen und daher nur peripher mit dem eigentlichen Inhalt der Einzelseite zu tun haben. Da es sich bei einem solchen Menü in der Regel um eine Liste von Verweisen handelt, kommen dabei auch die in XHTML vorgesehenen Listenelemente zum Einsatz: dl, ul oder ol. Wegen mangelnder Originalität in der Darstellung bei diversen Programmen wurde das eigentlich für Menüs vorgesehene Element menu als veraltet gekennzeichnet - schade eigentlich.

Ein Beispiel mit Menü. Sinnvoller Weise gibt es in dem Menü Verweise auf die anderen Themenseiten des Projektes, jedoch nicht auf die Seite, auf der sich der Nutzer gerade befindet. Für diese gibt es aber gegebenenfalls ein Untermenü. Bequem lassen sich solche Menüs etwa mit PHP erstellen, mit dem ein einmal erstelltes auf jeder Seite eingefügt werden kann. Mit PHP kann auch bestimmt werden, welche Untermenüs angezeigt werden sollen und welche nicht. Zusätzlich können ähnliche Strukturen auch für das Seitennavigationsmenü des Darstellungsprogrammes mit dem link-Element innerhalb des head-Elementes erstellt werden, siehe das Seitennavigationsmenü dieser Seite und dessen Quelltext.

Zitate und Quellen

Knifflig ist auch die Behandlung von Textquellen und Zitaten. Deswegen dazu noch ein paar konkrete Beispiele. Im internet kann einfach ein Verweis auf eine Informationsquelle angegeben werden, ohne explizit damit etwas zu zitieren, sofern diese Informationsquell auch im internet verfügbar ist. Dazu dient das a-Element, wie im folgenden Beispiel:

<p><cite>O. Hoffmann</cite> stellt einen 
<a href="http://hoffmann.bplaced.net/svgtest/" 
title="externer Verweis">systematischen 
Test zur deklarativen Animation von 
<abbr>SVG</abbr></a> bereit.</p>

Das Element cite ist ein wenig mehrdeutig. Prinzipiell ist nicht angegeben, ob damit ausgezeichnet wird, von wem zitiert wird oder woraus. Letzeres ist allerdings meist hilfreicher, sofern verfübar. Ersteres ist dann sinnvoll, wenn keine weitere Referenz vorliegt, hier etwa gibt es zwar den Verweis auf die konkrete internet-Seite, eine Referenz dafür, daß O. Hoffmann diese erstellt hat, wäre hier an sich ein möglicher Inhalt von cite, ist an dieser Stelle aber überflüssig, weil das ohnehin auf der angegebenen internet-Seite steht. Im fließenden Text kann man oft auch ganz auf die Angabe des Autors verzichten und innerhalb von cite direkt auf die Quelle verweisen, über die man etwas aussagen möchte. Zweifellos ist der Autor selbst immer eine mögliche Quellenangabe, allerdings ist die nicht von allen Lesern gleichermaßen nachvollziehbar. Bei konkret diskutierten Aussagen ist natürlich eine allgemein zugängliche, schriftliche Quelle eines bereits veröffentlichten Textes für den Leser meist hilfreicher. Den Autor als Quellenangabe anzugeben ist strenggenommen nur dann korrekt, wenn man die diskutierte Information auch wirklich vom Autor selbst bekommen hat und die Information nicht nur aus einem Dokument stammt, welches dem Autor zugeschrieben wird, in dem Falle wäre das Dokument als Quelle anzugeben, nicht der Autor. Sofern nur der Name des Autors bekannt ist, die Quellenlage also dubios ist, kann allerdings auch nur der Autorenname als Quelle angegeben werden, auch wenn man die Information nicht direkt vom Autor bekommen hat. Man kann das im Bedarfsfalle und insbesondere, wenn es wichtig ist, im Begleittext darstellen ('persönliche Mitteilung').

Wie auch sonst bei Verweisen, ist es wichtig, daß der eigentliche Inhalt des Elementes a Bezug zur Referenz hat und nicht so belanglos wie etwa 'hier' ist.

Die nächste Variante ist das Referieren aus der Quelle in indirekter Rede. Der Inhalt wird mit eigenen Worten wiedergegeben, was auch potentielle Streitereien mit Autoren vermeidet, die es nicht als Ehre sehen, zitiert zu werden, sondern eher als eine Chance, einen Rechtsstreit anzustrengen oder Geld aus dem Zitierenden durch eigenartige Forderungen zu pressen. Das sieht dann etwa so aus:

<p>Olaf Hoffmann belegt durch systematische Tests, 
da&szlig; deutliche Verbesserungen der F&auml;higkeiten bei der 
deklarativen Animation von <abbr>SVG</abbr> bei diversen 
Darstellungsprogrammen notwendig seien, damit Autoren das 
spezifizierte Verhalten von ihnen bei der Interpretation ihrer 
Dokumente erwarten k&ouml;nnen. <br />
<cite>
Siehe dazu &quot;<a href="http://hoffmann.bplaced.net/svgtest/" 
title="externer Verweis">Beispiele und Tests zur 
Animation mit <abbr>SVG</abbr></a>&quot;
(Im Dezember 2007 in diesem Zusammenhang referenziert).</cite></p>

In beiden Beispielen ist jeweils nur ein Element cite in dem jeweiligen Absatz vorhanden, dadurch ist der Bezug eindeutig, das ist natürlich wesentlich, damit klar ist, auf welche Quelle sich die Zitierung bezieht. Im ersteren Fall ist der Autor selbst die Quelle der Information, im zweiten Falle die angegebene internet-Seite.

Eine elegantere Variante bei längeren Texten kann sein, daß das Element cite nur einen Verweis auf einen Eintrag in einer anschließenden Bibliographie enthält:

<p>Olaf Hoffmann belegt durch systematische Tests, 
da&szlig; deutliche Verbesserungen der F&auml;higkeiten bei der 
deklarativen Animation von <abbr>SVG</abbr> bei diversen 
Darstellungsprogrammen notwendig seien, damit Autoren das 
spezifizierte Verhalten von ihnen bei der Interpretation ihrer 
Dokumente erwarten k&ouml;nnen 
<cite><a href="OH2007-12">[OH2007-12]</a></cite>. 
</p>

<div> ... viel Text ... </div>

<h6>Bibliographie </h6>

<ul>
<li> ... diverse Eintr&auml;ge ... </li>
<li id="OH2007-12">[OH2007-12] 
<a href="http://hoffmann.bplaced.net/svgtest/" 
title="externer Verweis">Beispiele und Tests zur 
Animation mit <abbr>SVG</abbr></a> 
(Version vom Dezember 2007)</li>
<li> ... diverse Eintr&auml;ge ... </li>
</ul>

Im deutschen Urheberrecht ist auch das Zitatrecht festgelegt. Danach kann in wissenschaftlichen Artikeln auch ohne Nachfrage beim Autor und ohne weitere rechtliche Probleme aus anderen veröffentlichten Werken zitiert werden, sofern es sich bei dem zitierenden Werk um ein wissenschaftliches Werk handelt, in dem das Zitat zur Erläterung des Inhaltes (entweder des zitierten oder des zitierenden Werkes) verwendet wird. Bei einem kurzen, inzeiligen Zitat wird dazu das Element q verwendet:

<p>Olaf Hoffmann untersucht in einem 
<cite><a href="http://hoffmann.bplaced.net/svgtest/" 
title="externer Verweis">systematischen 
Test zur deklarativen Animation von 
<abbr>SVG</abbr></a></cite> verschiedene 
Darstellungsprogramme und 
kommt zu dem Schlu&szlig;
(Version vom Dezember 2007):<br />
<q cite="http://hoffmann.bplaced.net/svgtest/?s=de#abstract">Eine 
signifikante Verbesserung der Darstellungsprogramme 
ist notwendig, damit sich Autoren auf ihre Werke 
konzentrieren k&ouml;nnen und nicht auf die 
F&auml;higkeiten der Darstellungsprogramme.</q>
</p>

Weil aktuelle Darstellungsprogramme das Attribut cite entweder gar nicht oder nicht sinnvoll interpretieren, ist hier der wesentliche Teil der Quelle nochmal als Verweis angegeben. Ansonsten ist das cite mit dem Verweis redundant, weil das Attribut cite bereits die notwendige Information enthält. Die Zusätzliche Angabe ist hier nur eine Hilfe für Nutzer von fehler- oder lückenhaften Darstellungsprogrammen.

Zitiert werden sollte nicht mehr als für den jeweiligen Zweck erforderlich. Details sollte der Leser ohnehin besser im Original nachlesen. Dennoch kann es in seltenen Fällen vorkommen, daß etwa ein Fragment mit mehreren Absätzen zitiert werden müß, oder bei einer Gedichtinterpretation vielleicht gar das ganze Gedicht. In solchen Fällen ist blockquote das Element der Wahl:

<p>Olaf Hoffmann untersucht in einem 
<cite><a href="http://hoffmann.bplaced.net/svgtest/" 
title="externer Verweis">systematischen 
Test zur deklarativen Animation von 
<abbr>SVG</abbr></a></cite> verschiedene 
Darstellungsprogramme und fa&szlig;t den 
Artikel wie folgt zusammen
(Version vom Dezember 2007, 
Hervorhebungen vom Autor):
</p>
<blockquote cite="http://hoffmann.bplaced.net/svgtest/?s=de#abstract">
<p>
Angeboten  wird ein Testensemble zur <strong>deklarativen
Animation mit SVG
<span xml:lang="en">Tiny</span> 1.1</strong>, 
<strong>SVG 1.1</strong> und <strong>SVG 
<span xml:lang="en">Tiny</span> 1.2</strong>
mit mehr als 1000 Beispielen f&uuml;r alle animierbaren 
Attribute und Eigenschaften und alle Attribute und
Elemente zur Animation.<br />
<strong>Testergebnisse</strong> f&uuml;r SVG 1.1 
liegen f&uuml;r folgende Darstellungsprogramme
als Beispiele vor:
Amaya 9.51, KSVG 1 (eingebundenes Programm im 
KDE-<span xml:lang="en">browser</span>
Konqueror 3.3.2), das <span xml:lang="en">Adobe 
plugin</span> 3.01 beta 3 vom 2003-12 und 
Opera 8.02, 8.50 und <span xml:lang="en">Opera 9 
Technology Preview 1, 2, beta1, 2, Opera 9.00, 9.10 
und Opera 9.50 alpha</span>.
Die Testergebnisse werden einschlie&szlig;lich einer 
Wahrscheinlichkeitsangabe f&uuml;r die korrekte
Anzeige eines zuf&auml;llig gew&auml;hlten 
Animationsbeispiels diskutiert.<br />
Eine signifikante Verbesserung der Darstellungsprogramme 
ist notwendig, damit sich Autoren auf
ihre Werke konzentrieren
k&ouml;nnen und nicht auf die F&auml;higkeiten der 
Darstellungsprogramme.
</p>
</blockquote>

Sofern keine eindeutig referenzierbare Quelle vorliegt, aber der Autor bekannt ist, kann das Attribut cite immerhin noch das Element cite referenziert werden, um den Bezug klar zu machen:

<p>
<q cite="#WilhelmBusch">Eins, 
zwei, drei im Sauseschritt<br />
eilt die Zeit - wir eilen mit.</q><br />
<cite id="WilhelmBusch">Wilhelm Busch</cite>
</p>

Oder alternativ mit der Referenz außerhalb von blockquote. Im vorliegenden Falle einer lebenden Referenzperson bietet es sich an, auch Kontaktinformationen anzubieten oder allgemein auch eine Referenz zu einer Biographie der zitierten Person:

<p>Bei teils langweiligen, sich jedenfalls
oft wiederholenden Vorg&auml;ngen denke ich oft
an einen Ausspruch von 
<a href="http://hoffmann.bplaced.net/ich.php" 
title="externer Verweis"><cite id="Olaf">Olaf Hoffmann</cite></a>:
</p>
<blockquote cite="#Olaf">
<p>
Das &uuml;bt ja auch...
</p>
</blockquote>

Jedenfalls sollte eine Person nicht mit seiner (Auto)biographie, seinem blog oder seiner internet-Seite verwechselt werden, weswegen hier cite innerhalb von a steht und nicht umgekehrt, denn man wird beim angegebenen Verweis den zitierten Text nicht finden, wohl aber Informationen zur zitierten Person.

Oder alternativ im fraglichem blockquote:

<blockquote>
<p>
Alles ist in Bewegung und nichts bleibt stehen.<br />
<cite>Heraklit von Ephesus</cite>
</p>
</blockquote>

In diesem Falle ist aus dem historischen Zusammenhang heraus klar, daß es sich um eine Übersetzung handelt und die zitierte Person der zitierenden Person nicht persönlich bekannt ist. Ansonsten täte man den Zusammenhang explizit erwähnen, etwa: 'freie Übersetzung eines Ausspruchs, der Heraklit von Ephesus zugeschrieben wird'.

Nächstes Kapitel
Kapitel: Kurzbeschreibung · 1 · 2 · 3 · 4 · 5 · 6 · 7 · 8 · 9 · 10 · 11