diff --git a/de_DE.ISO8859-1/books/fdp-primer/book.sgml b/de_DE.ISO8859-1/books/fdp-primer/book.sgml
index 7e5472ed9b..460b6fc302 100644
--- a/de_DE.ISO8859-1/books/fdp-primer/book.sgml
+++ b/de_DE.ISO8859-1/books/fdp-primer/book.sgml
@@ -1,303 +1,303 @@
%books.ent;
%chapters;
]>
Die Fibel für neue Mitarbeiter des
FreeBSD-Dokumentationsprojekts19981999200020012002200320042005200620072008The FreeBSD Documentation Project19981999200020012002200320042005200620072008The FreeBSD German Documentation Project$FreeBSD$$FreeBSD$
&bookinfo.legalnotice;
Vielen Dank für Ihr Interesse und Ihre Mitarbeit an
der FreeBSD-Dokumentation. Jeder Beitrag ist für uns sehr
wichtig.In dieser Fibel wird von der eingesetzten Software bis hin
zu den Vorstellungen des FreeBSD-Dokumentationsprojekts alles
behandelt, was Sie wissen müssen, wenn Sie sich am
FreeBSD-Dokumentationsprojekt beteiligen wollen.Bitte beachten Sie, dass diese Fibel
jederzeit unter Bearbeitung und noch
nicht vollständig ist.BenutzungshinweiseDie EingabeaufforderungenDie folgende Tabelle zeigt die normale Eingabeaufforderung
des Systems und die Eingabeaufforderung des Superusers. Die in
diesem Buch vorkommenden Beispiele benutzen die jeweilige
Eingabeaufforderung, um zu zeigen, unter welchem Benutzer die
Beispiele ausgeführt werden sollten.BenutzerEingabeaufforderungNormaler Benutzer&prompt.user;Superuser&prompt.root;Typographische FestlegungenUm die Lesbarkeit zu erhöhen, werden in diesem
Dokument die im folgenden genannten typographischen
Festlegungen verwendet:BedeutungBeispielKommandonamenGeben Sie ls -a ein, um alle
Dateien anzuzeigen.Datei- und VerzeichnisnamenBearbeiten Sie die Datei
.login.Bildschirmein- und ausgabenYou have mail.Referenzen auf HilfeseitenMit &man.su.1; können Sie sich als ein anderer
Benutzer anmelden.Benutzer- und GruppennamenIch bin root, ich darf
das.HervorhebungenHier müssen Sie
vorsichtig sein.Argumente auf der Kommandozeile, die durch
existierende Namen, Dateien oder Variablen ersetzt
werden müssenDateien können Sie mit dem Befehl
rm
Dateiname
löschen.Umgebungsvariablen$HOME ist Ihr
Benutzerverzeichnis.Anmerkungen, Tips, wichtige Hinweise, Warnungen und
BeispielAn einigen Stellen innerhalb dieses Buchs werden
wichtige oder nützliche Hinweise gegeben, die besonders
hervorgehoben sind. Hier ein kurzer Überblick über
die verwendeten Darstellungen.Anmerkungen werden so dargestellt. Sie enthalten
Informationen die Sie nur zu lesen brauchen, wenn Sie direkt
davon betroffen sind.Tipps sind Informationen, die vielleicht hilfreich sein
könnten oder aufzeigen, wie bestimmte Dinge einfacher
zu bewerkstelligen sind.Besonders wichtige Punkte werden so hervorgehoben. Meist
enthalten sie Hinweise auf vielleicht zusätzlich auszuführende
Schritte oder Dinge, die besonders zu beachten sind.Warnungen werden wie dieser Abschnitt dargestellt und
weisen auf mögliche Schäden hin, die entstehen
können, falls die beschriebenen Schritte nicht genau
befolgt oder Hinweise nicht beachtet werden. Die Palette der
möglichen Schäden reicht von Hardwareschäden
bis hin zu Datendatenverlust durch ein versehentliches
Löschen von wichtigen Dateien oder ganzen
Verzeichnissen.Ein BeispielBeispiele, die so wie hier dargestellt werden, enthalten
meist kleine Übungen, die nachvollzogen werden sollten,
um das vorher beschriebene besser zu verinnerlichen oder mit
den erzeugten Ausgaben vertraut zu werden.DanksagungenIch möchte mich bei Sue Blake, Patrick Durusau, Jon
Hamilton, Peter Flynn und Christopher Maden bedanken, die sich
die Zeit genommen haben, die frühen Entwürfe dieses
Dokuments zu lesen und viele hilfreiche Hinweise und
Ratschläge gegeben haben.
&chap.overview;
&chap.tools;
&chap.sgml-primer;
&chap.sgml-markup;
&chap.stylesheets;
&chap.structure;
&chap.doc-build;
&chap.the-website;
&chap.translations;
&chap.writing-style;
&chap.psgml-mode;
&chap.see-also;
&app.examples;
diff --git a/de_DE.ISO8859-1/books/fdp-primer/overview/chapter.sgml b/de_DE.ISO8859-1/books/fdp-primer/overview/chapter.sgml
index b41a5877b3..de4e32c364 100644
--- a/de_DE.ISO8859-1/books/fdp-primer/overview/chapter.sgml
+++ b/de_DE.ISO8859-1/books/fdp-primer/overview/chapter.sgml
@@ -1,348 +1,348 @@
ÜberblickHerzlich Willkommen beim FreeBSD-Dokumentationsprojekt.
Qualitativ hochwertige Dokumentation ist ein wichtiger
Erfolgsfaktor und sehr bedeutend für die Verbreitung von
FreeBSD. Die wichtigste Quelle dafür ist das
FreeBSD-Dokumentationsprojekt (FDP). Jeder Beitrag, der zu diesem
Projekt geleistet wird, ist ungemein wertvoll.Es ist das Anliegen dieser Fibel, den Leser mit dem FDP
vertraut zu machen und zu erklären, wie das FDP
organisiert ist, wie man selber Dokumente
erstellt und an das FDP einreicht und wie
die verfügbaren Werkzeuge effektiv beim Schreiben
eingesetzt werden können.Wie jedes Opensourceprojekt, ist auch das FDP auf die Mithilfe
vieler angewiesen. Deshalb ist jeder herzlich eingeladen
mitzuarbeiten. Die dafür erforderlichen Voraussetzungen sind
gering und es gibt keine Verpflichtung eine bestimmte Menge an
Dokumenten pro Monat oder Jahr beizusteuern. Das Einzige was Sie
tun müssen, ist sich auf der Mailingliste &a.doc; einzutragen.Nach dem Lesen der FDP-Fibel sollte man wissen:welche Dokumente durch das FDP betreut werden,wie man SGML-Dokumente liest und den SGML-Quellcode der
durch das FDP betreuten Dokumente versteht,wie man selbst Änderungen an Dokumenten vornehmen
kann undwie man Änderungen zur Begutachtung durch das FDP
einreichen kann.Die FreeBSD-DokumentationsreiheDas FDP umfaßt vier verschiedene Kategorien:HilfeseitenDie englischen Hilfeseiten wurden nicht vom FDP
geschrieben, da sie ein Teil des Basissystems sind. Jedoch
können bzw. wurden bereits Teile von existierenden
Hilfeseiten umformuliert, um sie verständlicher zu
machen oder um Fehler zu beheben.Für die Übersetzung der Hilfeseiten des
Systems in die verschiedenen Sprachen sind die einzelnen
Übersetzergruppen verantwortlich. Alle dabei
entstandenen Übersetzungen gehören zum
FDP.Die FAQDas Ziel der FAQ ist es, Fragen, die auf den
verschiedenen Maillinglisten und in Newsgruppen
regelmäßig diskutiert werden, nach einem
einfachen Frage- und Antwort-Muster zu behandeln. Das
schließt nicht aus, das auf bestimmte Fragen
ausführlich und umfassend eingegangen wird.Das HandbuchDas Ziel des Handbuches ist es, die
umfassende Quelle und Referenz im Netz für
FreeBSD-Benutzer zu sein.Die WebseiteDie Webseite http://www.FreeBSD.org
und ihre vielen Spiegel auf der ganzen Welt vertreten das
FreeBSD-Projekt im WWW. Für viele Menschen
ist sie der erste Kontakt mit FreeBSD.Jede dieser vier Kategorien wird im FreeBSD-CVS-Baum
verwaltet. Das bedeutet, dass alle Änderungen an den
Dateien für jeden verfügbar sind und jeder sich
mittels eines Programms wie CVSup
oder CTM eine lokale Kopie der
Dokumentation anlegen kann.Parallel zum FDP haben viele Menschen Anleitungen
geschrieben und Webseiten mit Bezug zu FreeBSD erstellt. Einige
davon werden im CVS-Archiv verwaltet, sofern der Autor dem
zugestimmt hat. In anderen Fällen hat sich der Autor
entschlossen, seine Dokumentation außerhalb des zentralen
FreeBSD-CVS-Archivs zu verwalten. Das FDP bemüht sich, so
viele Verweise wie möglich auf solche Quellen
bereitzustellen.Bevor es losgehtZum Verständnis der folgenden Kapitel sollte folgendes
bereits bekannt sein:Wie eine aktuelle Kopie der FreeBSD-Dokumentation
entweder auf Basis des FreeBSD-CVS-Archivs mittels
CVS,
CTM oder
CVSup angelegt und gepflegt wird,
oder wie mit CVSup eine frische
Kopie des CVS-Archivs heruntergeladen wird.Wie neue Programme mit Hilfe des
FreeBSD-Portsystems oder mittels &man.pkg.add.1;
heruntergeladen und installiert werden.Der SchnellstartFalls man einfach loslegen möchte und sich sicher genug
fühlt, um alles weitere erst bei Bedarf nachzusehen, kann
man einfach den folgenden Anweisungen folgen:Zuerst muß der Metaport textproc/docproj auf dem
betreffenden Arbeitsrechner installiert werden.&prompt.root; cd /usr/ports/textproc/docproj
&prompt.root; make JADETEX=no installAnschließend sollte eine lokale Kopie des
FreeBSD-doc-Verzeichnisbaumes angelegt
werden. Hierfür kann man entweder auf
CVSup im
checkout-Modus zurückgreifen oder
mittels cvs eine komplette Kopie
des CVS-Archivs anlegen.Wenn man lieber mit einer Kopie des CVS-Archivs arbeiten
möchte, werden als Minimum die Verzeichnisse
doc/share und
doc/de_DE.ISO8859-1/share
benötigt.&prompt.user; cvs checkout doc/share
&prompt.user; cvs checkout doc/de_DE.ISO8859-1/shareFür den Fall, dass ausreichend Platz auf der
Festplatte vorhanden ist, kann auch eine eine
vollständige Arbeitskopie des gesamten CVS-Baumes anlegt
werden.&prompt.user; cvs checkout docSollte geplant sein, ein existierendes Buch oder einen
existierenden Artikel zu ändern, muß
natürlich noch zusätzlich das betreffende
Verzeichnis aus dem CVS-Archiv geholt werden. Soll hingegen
ein neues Buch oder ein neuer Artikel geschrieben werden,
empfiehlt es sich, auf bestehende Bücher und Artikel
zurückzugreifen und diese als Vorlage zu nutzen.Ein Artikel über die Konfiguration eines VPNs
zwischen FreeBSD und Windows 2000 kann wie
folgt erstellt werden:Zuerst wird das Verzeichnis
articles aus dem FreeBSD-CVS-Archiv
lokal angelegt:&prompt.user; cvs checkout doc/de_DE.ISO8859-1/articlesAnschließend kopiert man einen bereits
existierenden Artikel und nutzt ihn als Vorlage. In
diesem Beispiel soll der neue Artikel im Verzeichnis
vpn-w2k liegen:&prompt.user; cd doc/de_DE.ISO8859-1/articles
&prompt.user; cp -R committers-guide vpn-w2kBereits exisitierende Dokumente, die geändert
werden sollen, können direkt aus dem CVS-Archiv
geholt werden. Das folgende Beispiel zeigt das
für die FAQ aus dem Verzeichnis
doc/de_DE.ISO8859-1/books/faq:&prompt.user; cvs checkout doc/de_DE.ISO8859-1/books/faqJetzt können die .sgml Dateien
mit einem beliebigen Texteditor bearbeitet werden.Danach ist make mit dem Ziel
lint aufzurufen, um das gesamte
Dokument auf Auszeichnungsfehler hin zu untersuchen, ohne
dass zeitaufwändige Transformationen vorgenommen
werden.&prompt.user; make lintSoll anschließend das Zieldokument erstellt
werden, kann mit Hilfe der Variable
FORMATS bestimmt werden, welche
Ausgabeformate erzeugt werden sollen. Unterstützt werden
momentan html,
html-split, txt,
ps, pdf und
rtf. Die aktuelle Liste der
unterstützten Formate befindet sich am Anfang der Datei
doc/share/mk/doc.docbook.mk. Bei der
Verwendung dieser Variable ist es wichtig, darauf zu achten,
dass die Angabe der gewünschten Formate in
Anführungszeichen eingeschlossen wird, sofern mehr als
nur ein Format gleichzeitig erstellt werden soll.Wenn das Dokument beispielsweise nach
HTML konvertiert werden soll, kann dies
so vorgenommen werden:&prompt.user; make FORMATS=htmlSoll es hingegen in den Formaten html
und txt erzeugt werden,
kann man entweder
&man.make.1; zweimal hintereinander aufrufen:&prompt.user; make FORMATS=html
&prompt.user; make FORMATS=txtoder beide Formate mit einem Aufruf von &man.make.1;
erzeugen:&prompt.user; make FORMATS="html txt"Zum Schluß müssen die Änderungen an das
FDP mittels &man.send-pr.1; eingesandt werden.
diff --git a/de_DE.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml b/de_DE.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml
index 094e3aed96..6ece8429b0 100644
--- a/de_DE.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml
+++ b/de_DE.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml
@@ -1,3012 +1,3004 @@
SGML-Dokumente erstellenIn diesem Kapitel werden die beiden vom FDP eingesetzen
Auszeichnungssprachen HTML und DocBook behandelt. Hierbei
beschränkt sich dieses Kapitel auf die Elemente, die bei der
täglichen Arbeit am ehesten zum Einsatz kommen werden.Beide Sprachen besitzen eine große Anzahl von Elementen.
Das erschwert es, das richtige Element in der richtigen Situation
auszuwählen. Aus diesem Grund werden zu jedem Element auch
immer Beispiele angeboten, die den richtigen Einsatz des Elements
verdeutlichen sollen.Es ist nicht das Ziel dieses Kapitels möglichst viele
Elemente beider Sprachen zu behandeln – dies wäre nur
eine Wiederholung der eigentlichen Sprachreferenz. Sofern es
Unklarheiten zur Verwendung einzelner Elemente und Auszeichnung
von bestimmten Sachverhalten gibt, können diese an &a.doc;
geschickt werden.Fluß- kontra BlockelementeWenn im folgenden von
Flußelementen die Rede ist, sind
damit Elemente gemeint, die in einem Blockelement auftreten
können und keinen Zeilenumbruch hervorrufen.
Blockelemente hingegen erzeugen unter
anderem einen ZeilenumbruchDie englische
Bezeichnung inline element
wurde in Anlehnung an das Wort Fließtext
mit Flußelement
übersetzt..HTMLHTML, die HyperText Markup
Language, ist die Auszeichnungssprache des
Internets. Weitere Informationen zu HTML finden sich unter
.Sie kommt bei der Erstellung der Webseiten des
FreeBSD-Projektes zum Einsatz. Für technische Dokumentationen
sollte HTML jedoch nicht eingesetzt werden, da DocBook eine
größere und bessere Auswahl an Elementen bietet. Folglich
sollte HTML nur für die FreeBSD-Webseiten verwendet werden.Die HTML-Spezifikation liegt bis jetzt in mehreren Versionen
vor: 1, 2, 3.0, 3.2 und (die aktuelle) 4.0. Von letzterer
existieren zwei Varianten: streng (HTML 4.0
Strict) und locker (HTML 4.0
Transitional).Die HTML-DTDs sind über den Port textproc/html verfügbar und werden
automatisch als Teil des Metaports textproc/docproj
mitinstalliert.Formale Öffentliche BezeichnerDa es mehrere Version von HTML gibt, existieren auch
mehrere FÖPs, zu denen ein HTML-Dokument konform
erklärt werden kann. Die Mehrzahl der sich auf der
FreeBSD-Webseite befindenen HTML-Seiten sind zu der lockeren
Version von HTML 4.0 konform.PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"Die Elemente head und
bodyEin HTML-Dokument unterteilt sich normalerweise in zwei
Bereiche: head und body. Der
Kopf (head) enthält Metadaten
wie den Dokumententitel und Angaben zum Autor. Der Rumpf
(body) umfaßt den eigentlichen
Dokumenteninhalt, der für den Leser bestimmt ist. In einem
HTML-Dokument werden diese Bereiche über die Elemente
head und body
voneinander abgegrenzt. Beide sind Kinder des Wurzelelementes
html.Die Struktur eines HTML-Dokumentes<html>
<head>
<title>Der Dokumententitel</title>
</head>
<body>
…
</body>
</html>BlockelementeÜberschriftenHTML kennt sechs verschiedene Elemente, mit denen
Überschriften ausgezeichnet werden können. Das bekannteste
Element ist h1, das sich am Anfang der
Überschriftenhierarchie befindet. h1
folgen die Überschriftenelemente h2 bis
h6. Der Inhalt von
hN stellt den
Text der Überschrift dar.h1, h2…Fügen Sie in eine der existierenden Übungsdateien folgendes ein:Erstes Kapitel
Das ist die Überschrift des ersten Kapitels
Das ist die Überschrift des ersten Unterkapitels
Das ist die Überschrift des zweiten Kapitels
]]>Eine HTML-Seite sollte immer nur eine Überschrift
h1 haben. Dieser Überschrift können
beliebig viele Kapitel mit einer Überschrift
h2 folgen, die selbst wiederum eine
beliebige Anzahl von Kapiteln mit einer Überschrift
h3 enthalten können. Diese
Verschachtelung setzt sich bis zu Kapiteln mit einer
h6-Überschrift fort. Es sollte vermieden
werden, Elemente in der Überschriftenhierarchie
auszulassen.Falsche Verschachtelung von ÜberschriftenFügen Sie in eine der existierenden Übungsdateien folgendes ein:Erstes Kapitel
Unterkapitel
]]>AbsätzeAbsätze können in HTML mit Hilfe des Elementes
p ausgezeichnet werden.Absätze mit dem Element pFügen Sie in eine der existierenden Übungsdateien folgendes ein:Das hier, das ist ein Absatz. Absätze können
andere Elemente enhalten.
]]>
BlockzitateEin Blockzitat ist ein etwas umfangreicheres Zitat aus
einem anderen Text, das nicht zum aktuellen Absatz
gehört.BlockzitatFügen Sie in eine der existierenden Übungsdateien
folgendes ein:
Artikel 1: Menschenwürde; Grundrechtsbindung der
staatlichen Gewalt
Die Würde des Menschen ist unantastbar. Sie zu achten
und zu schützen ist Verpflichtung aller staatlichen
Gewalten.
Das Deutsche Volk bekennt sich darum zu unverletzlichen
und unveräußerlichen Menschenrechten als Grundlage jeder
menschlichen Gemeinschaft, des Friedens und der
Gerechtigkeit in der Welt.
Die nachfolgenden Grundrechte binden Gesetzgebung,
vollziehende Gewalt und Rechtsprechung als
unmittelbar geltendes Recht.
]]>ListenHTML kennt drei Arten von Listen: sortierte, unsortierte
und Definitionslisten. Ein Eintrag in einer sortierten Liste
wird üblicherweise mit einer Nummer versehen, Einträge in
unsortierten Listen hingegen mit einem Aufzählungspunkt.
Definitionslisten wiederum bestehen aus zwei Teilen: Der
erste enthält den Begriff der definiert werden soll und der
zweite dessen Erläuterung.Sortierte Listen werden mit dem Element
ol (für
ordered
list) ausgezeichnet,
unsortierte Listen mit ul (für
unordered
list) und
Definitionslisten mit dl.Listenpunkte sortierter und unsortierter Listen werden
mit dem Element li ausgezeichnet,
welches Text oder andere Blockelemente enthalten kann.
Begriffe, die in einer Definitionslisten enthalten sind,
werden mit dem Element dt (für
definition
term) ausgezeichnet.
Die Erklärung zu diesem Begriff wird mit Hilfe des Elementes
dd (für definition
description) markiert. So wie
li, kann das Element
dd ebenfalls andere Blockelemente
aufnehmen.Listen mit ul und
ol erstellenFügen Sie in eine der existierenden Übungsdateien
folgendes ein:Jetzt folgt eine unsortierte Liste. Wahrscheinlich werden
die einzelnen Einträge mit einem vorangehenden Punkt dargestellt.
Erster Eintrag
Zweiter Eintrag
Dritter Eintrag
Die zweite Liste ist sortiert und ihre Einträge bestehen aus mehreren Absätzen.
Jeder Listeneintrag ist nummeriert.
Das ist der erste Eintrag mit nur einem Absatz.
Das ist der erste Absatz des zweiten Eintrags.
Und das ist der zweite Absatz des zweiten Eintrags.
Der dritte Eintrag besteht ebenfalls nur aus einem Eintrag.
]]>Definitionslisten mit dl erstellenFügen Sie in eine der existierenden Übungsdateien folgendes ein:
Erster Begriff
Erster Absatz der Erklärung
Zweiter Absatz der Erklärung.
Zweiter Begriff
Erster Absatz der Erklärung.
Dritter Begriff
Erster Absatz der Erklärung zum dritten Begriff.
]]>Vorformatierter TextIn einigen Fällen ist es gewollt, dass die Formatierung
eines Textes im Quelldokument erhalten bleibt, damit der
Leser diesen genau so sieht, wie ihn der Autor erstellt hat.
In der HTML-Spezifikation ist dafür das Element
pre vorgesehen, welches dafür sorgt, dass
Zeilenumbrüche erhalten bleiben und Leerzeichen nicht
zusammengefaßt werden. Browser verwenden für den
Inhalt des Elementes pre
üblicherweise eine Fixschrift.Vorformatierten Text mit pre erstellenDer Originaltext einer E-Mail läßt sich beispielsweise
wie folgt einbinden: From: nik@FreeBSD.org
To: freebsd-doc@FreeBSD.org
Subject: Neue Version verfügbar
Es ist eine neue Version der Fibel für neue Mitarbeiter am
FreeBSD-Dokumentationsprojekt verfügbar:
<URL:http://people.FreeBSD.org/~nik/primer/index.html>
Kommentare und Anmerkungen sind willkommen.
N]]>Beachten Sie, dass < und
& nach wie vor als Sonderzeichen
erkannt werden. Daher wird in diesem Beispiel auch
< an Stelle von
< verwendet. Aus dem gleichen
Grund wurde auch > an Stelle
von > verwendet. Achten Sie also
stets auf Sonderzeichen, wenn Sie normalen Text
aus E-Mails, Programmcode oder einer anderen Quelle
kopieren.TabellenDie meisten Textbrowser, beispielsweise Lynx, können
Tabellen nicht besonders gut darstellen. Deshalb sollten
Auszeichnungsalternativen in Betracht gezogen werden, um
eine angemessene Darstellung sicherzustellen.Tabellen lassen sich in HTML mit Hilfe des Elements
table auszeichnen. Eine Tabelle setzt
sich aus einer oder mehreren Zeilen (tr)
zusammen, von denen jede mindestens eine Zelle
(td) enthält. Zellen können wiederum
andere Blockelemente, wie Absätze oder Listen, enthalten.
Auch können sie auch andere Tabellen aufnehmen, wobei die
Verschachtelungstiefe unbegrenzt ist. Soll die Tabellenzelle
nur einen Textabsatz enthalten, ist es nicht notwendig den
Text mit einem p zu umschließen.Einfache Tabelle mit tableFügen Sie in eine der existierenden Übungsdateien folgendes ein:Eine einfache 2x2 Tabelle.
Obere linke Zelle
Obere rechte Zelle
Untere linke Zelle
Untere rechte Zelle
]]>HTML kennt die Möglichkeit, dass sich eine
Zelle mehrere Zeilen und/oder Spalten erstrecken kann.
Sollen beispielsweise mehrere Spalten zusammenfassen werden,
kann dies mit mit Hilfe des Attributes
colspan erreicht werden, indem man ihm
die Anzahl der zusammenzufassenden Spalten zuweist.
Ähnliches gilt für die Zusammenfassung von Zeilen:
Hierfür wird dem Attribut rowspan
die Anzahl der zusammenzufassenden Zeilen zugewiesen.Anwendung des Attributes rowspanDiese Tabelle besteht aus einer langen Zelle auf der
linken Seite und zwei kleineren Zellen auf der rechten.
Lang und dünn
Obere Zelle
Untere Zelle
]]>Anwendung des Attributes colspanEine breite Zeile oben und zwei schmalere Zeilen
darunter.
Obere Zelle
Linke untere Zelle
Rechte untere Zelle
]]>Gemeinsame Anwendung der Attrbute rowspan und
colspanEine Tablle mit 3-mal-3 Zellen. Oben links
werden 2 mal 2 Zelle zusammengezogen.
Große obere linke Zelle
Obere rechte Zelle
Mittlere rechte Zelle
Untere linke Zelle
Untere mittlere Zelle
Untere rechte Zelle
]]>FlußelementeHervorheben von InformationSollen sich bestimmte Informationen von anderen optisch
abheben, kann dies mit den HTML-Tags
strong und em erreicht
werden. strong stellt dabei eine
stärkere Hervorhebung als em dar,
wobei mit strong ausgezeichnete Elemente
fett und mit em ausgezeichnete Elemente
kursiv dargestellt werden. Allerdings ist diese Aussage
nicht verläßlich, da die Darstellung vom Browser
abhängig ist.Text mit em und strong
hervorhebenDieses Wort ist hervorgehoben,
während dieses noch stärker hervorgehoben ist.]]>Fett- und SchrägschriftDa mittels HTML auch Festlegungen über die
Darstellung getroffen werden können, gibt es die
Möglichkeit direkt zu bestimmen, dass bestimmte
Inhalte fett oder kursiv dargestellt werden sollen. Mit
b eingefaßte Inhalte werden fett
und mit i eingefaßte kursiv
dargestellt.Text mit b und i
formatierenDieses Wort wird fett dargestellt,
während dieses kursiv dargestellt wird.]]>Nicht-proportionale Schrift für TexteDer Tag tt erlaubt es,
Text in einer schreibmaschinenähnlichen
Schrift darzustellen.Nicht-proportionale Schrift mit
ttDieses Dokument wurde ursprünglich von
Nik Clayton geschrieben. Nick Clayton kann unter der E-Mail-Adresse
nik@FreeBSD.org erreicht werden.]]>Änderung der SchriftgrößeHTML bietet auch Möglichkeiten, um Einfluß
auf die Schriftgröße zu nehmen, das heißt,
zu bestimmen, ob die Schrift größer oder kleiner
als die Standardschrift dargestellt werden soll. Es gibt
drei verschiedene Wege, dies zu erreichen:Mittels der Tags big und
small kann die
Darstellungsgröße des eingeschlossenen Textes
vergrößert respektive verkleinert werden.
HTML erlaubt es zudem, diese Tags zu verschachteln, so
dass auch <big><big>Das ist
wesentlich
größer.</big></big>
geschrieben werden kann.Das gleiche Ergebnis kann über die Zuweisung der
Werte 1 und -1 an
das Attribut size
des Tags font erreicht werden. Diese
Vorgehensweise sollte allerdings als veraltet betrachtet
werden, da der Einsatz eines CSS hierfür die bessere
Lösung darstellt.Über die Zuweisung von absoluten Werten im Bereich
von 1 bis 7 an das
Attribut size des Tags
fontDer Standardwert für size ist
3.. Diese
Herangehensweise ist ebenfalls veraltet und sollte nicht
mehr angewandt werden.Schriftgröße ändern mit
big, small und
fontDie folgenden HTML-Schnipsel bewirken alle das gleiche:Dieser Text ist etwas kleiner. Dieser
jedoch ein wenig größer.
Dieser Text ist etwas kleiner. Dieser
jedoch ein wenig größer.
Dieser Text ist etwas kleiner. Dieser
jedoch ein wenig größer.
]]>LinksBei Links handelt es sich ebenfalls Flußelemente.Auf andere Dokumente im WWW verweisenUm auf ein anderes Dokument im WWW zu verweisen,
müssen Sie die URL dieses Dokuments kennen.Links auf andere Dokumente im WWW werden in HTML durch
den Tag a und dessen Attribute href, das die Zieladresse
enthält, angelegt. Der Inhalt des Elementes wird selbst
zum Link und seine Darstellung erfolgt verschieden vom
übrigen Text. Meist geschieht das durch eine andere
Schriftfarbe oder dadurch, dass der Linktext
unterstrichen wird.<a href="..."> benutzenWeitere Informationen stehen auf der
FreeBSD-Webseite zur Verfügung.]]>Beim Aufruf dieses Links wird das referenzierte Dokument vom
Browser geladen und mit dessen Seitenanfang dargestellt.Auf bestimmte Dokumentenabschnitte verweisenHTML unterstützt neben einfachen Links auch solche, die
auf einen bestimmten Abschnitt innerhalb eines Dokumentes
verweisen. Dazu müssen die Abschnitte, auf die verwiesen
werden soll, mit Hilfe von sogenannten Ankern
markiert werden. Diese Anker können ebenfalls mit Hilfe des
Tags a gesetzt werden, nur das anstelle
von href das Attribut
name gesetzt werden
muss.Anwendung von <a name="...">Auf diesen Absatz kann mit
Hilfe seines Namens (absatz1) verwiesen werden.]]>Um auf einen so gekennzeichneten Abschnitt zu verweisen,
muss die URL des Dokumentes um das Zeichen
# und den Namen des Zielankers erweitert
werden.Auf einen Abschnitt eines anderen Dokumentes
verweisenFür dieses Beispiel wird davon ausgegangen, dass der mit
absatz1 gekennzeichnete Absatz sich in
der HTML-Datei foo.html
befindet.Weitere Informationen können im
ersten Absatz der Datei
foo.html gefunden werden.]]>Die DocBook DTDDocBook wurde ursprüglich von HaL Computer Systems and
O'Reilly & Associates als DTD für das Erstellen von
technischen Dokumenten entwickelt
Einen kurzen historischen Abriss finden Sie unter
..
Seit 1998 wird es vom
DocBook Technical Committee gewartet. DocBook ist sehr
stark auf die Beschreibung von Inhalten, und nicht auf die
Darstellung des Inhalts ausgerichtet. Damit steht es im Gegensatz
zu LinuxDoc und HTML.Formelle und informelle ElementeEinige Elemente der DocBook DTD sind in zwei Varianten
vorhanden: formell und
informell. Üblicherweise besitzt die
formelle Variante einen Titel, dem der eigentliche
Elementeninhalt folgt. Die informelle Variante hingegen hat
keinen Titel.
- Die DocBook DTD ist in der Portssammlung im Port Die DocBook DTD ist in der Ports-Sammlung im Port textproc/docbook enthalten und wird
- bei der Installation von textproc/docproj automatisch
mitinstalliert.Die FreeBSD-ErweiterungenFür das FDP wurde die DocBook DTD durch das
FreeBSD-Dokumentationsproject um zusätzliche Elemente
erweitert, um damit präzisiere
Auszeichnungsmöglichkeiten zur Verfügung zu haben.
Sofern im folgenden FreeBSD-spezifische Elemente genutzt
werden, wird explizit darauf hingewiesen werden.Wenn nachfolgend im Text der Begriff
DocBook verwendet wird, ist damit die durch das
FDP erweiterte Version der DocBook DTD gemeint.Die durch das FDP vorgenommenen Erweiterungen sind nicht
FreeBSD-spezifisch. Sie wurden lediglich vorgenommen, da sie
für die Arbeit des FDPs als nützlich erschienen.
Für den Fall, das in den anderen *nix-Lagern (NetBSD,
OpenBSD, Linux,…) Interesse daran besteht, gemeinsam
eine Standarderweiterung für die DocBook DTD zu
entwickeln, kann mit dem &a.doceng; Verbindung aufgenommen
werden.Zum jetzigen Zeitpunkt sind die FreeBSD-Erweiterungen
- nicht Bestandteil der Portssammlung. Sie werden im
- FreeBSD-CVS-Archiv (doc/share/sgml/freebsd.dtd)
verwaltet.Formelle Öffentliche BezeichnerIn Übereinstimmung mir der DocBook-Richtlinie zur
Erstellung von Bezeichnern für DocBook-Erweiterungen lautet
der Bezeichner der erweiterten FreeBSD-Variante:PUBLIC "-//FreeBSD//DTD DocBook V4.1-Based Extension//EN"Die Struktur von DocBook-DokumentenDocBook erlaubt es, Dokumente auf verschiedene Weise zu
strukturieren. Innerhalb des FDPs werden hauptsächlich zwei
Arten von DocBook-Dokumenten verwendet: Buch und Artikel.
Beide unterscheiden sich darin, dass ein Buch auf der obersten
Ebene durch chapter-Elemente strukturiert
wird. Sollte das noch nicht ausreichend sein, können die
einzelnen Kapitel eines Buches mit Hilfe des Elementes
part in Teile aufgespalten werden. Das
- Handbuch zum Beispiel ist auf diese Weise aufgebaut.
+ Handbuch ist beispielsweise auf diese Weise aufgebaut.
Kapitel (chapter) können weiterhin in
Unterkapitel unterteilt werden. Diese werden durch die
Elemente sect1 ausgezeichnet. Soll ein
Unterkapitel selbst weitere Unterkapitel enthalten, kann das
über das Element sect2 geschehen. Diese
Unterteilung kann bis zur Tiefe von fünf Unterkapiteln –
über die Elemente sect3,
sect4 und sect5 –
fortgeführt werden. Der eigentliche Inhalt, um den es ja in
dem Artikel oder Buch geht, wird unterhalb der hier genannten
Elemente eingefügt.Vom Aufbau her ist ein Artikel ist einfacher strukturiert
als ein Buch. So kann ein Artikel beispielsweise keine Kapitel
(chapter) enthalten. Stattdessen kann der
Inhalt eines Artikels nur durch die schon bekannten
sectN-Elemente
in einen oder mehrere Abschnitte gegliedert werden.
Überlegen Sie sich vor dem Schreiben eines Textes,
ob der zu schreibende Text am
besten als Buch oder als Artikel angelegt wird. Artikel eignen
sich besser für Texte, die nicht in mehrere Kapitel
aufgeteilt werden müssen und mit einem Umfang von
ungefähr 20 bis 25 Seiten vergleichsweise kurz sind.
Natürlich ist das nur eine Richtlinie. Bücher sind
dementsprechend am besten für lange Texte geeignet, die
sich sinnvoll in Kapitel unterteilen lassen und
möglichweiser noch Anhänge und ähnliches
enthalten können.Alle Tutorien von
FreeBSD sind als Artikel verfaßt, während
hingegen die FreeBSD-FAQ und das FreeBSD-Handbuch als
Bücher verfaßt wurden.Bücher schreibenDer Inhalt eines Buches wird in einem
book-Element abgelegt. Neben dem
Textteil des Buches kann dieses Element weitergehende
Informationen über das Buch selbst,
wie Meta-Informationen zum Erstellen eines
Stichwortverzeichnisses oder zusätzliche
Inhalte zum Erstellen einer Titelei, enthalten. Diese
zusätzlichen Inhalte sollten in einem
bookinfo-Element abgelegt werden.Buchvorlage book mit
bookinfo<book>
<bookinfo>
<title>Titel</title>
<author>
<firstname>Vorname</firstname>
<surname>Nachname</surname>
<affiliation>
<address><email>E-Mail-Adresse</email></address>
</affiliation>
</author>
<copyright>
<year>1998</year>
<holder role="mailto:E-Mail-Adresse">Vollständiger Name</holder>
</copyright>
<releaseinfo>$FreeBSD$</releaseinfo>
<abstract>
<para>Kurze Zusammenfassung des Buchinhaltes.</para>
</abstract>
</bookinfo>
…
</book>Artikel schreibenDer Inhalt eines Artikels wird in einem
article-Element abgelegt. Neben
dem Textteil kann dieses Element weitere Teile,
wie Meta-Informationen zum Erstellen eines
Stichwortverzeichnisses oder zusätzliche
Inhalte zum Erstellen einer Titelei, enthalten.
Analog zu einem Buch, sollten diese Informationen in einem
articleinfo-Element abgelegt
werden.Artikelvorlage article mit
articleinfo<article>
<articleinfo>
<title>Titel</title>
<author>
<firstname>Vorname</firstname>
<surname>Nachname</surname>
<affiliation>
<address><email>E-Mail-Adresse</email></address>
</affiliation>
</author>
<copyright>
<year>1998</year>
<holder role="mailto:E-Mail-Adresse">Vollständiger Name</holder>
</copyright>
<releaseinfo>$FreeBSD$</releaseinfo>
<abstract>
<para>Kurze Zusammenfassung des Artikelinhalts.</para>
</abstract>
</articleinfo>
…
</article>KapitelKapitel werden mit dem
chapter-Element angelegt und müssen ein
title-Element enthalten. Verwendet werden
können sie nur in Büchern.Ein einfaches KapitelKapitelüberschrift
…
]]>Kapitel können nicht leer sein. Nebem einem
title-Element müssen sie weiteren Inhalt
beinhalten. Falls ein leeres Kapitel benötig wird, kann dies
durch das Einfügen eines leeren Absatzes
(para) erreicht werden.Ein leeres KapitelDas ist ein leeres Kapitel
]]>UnterkapitelBücher werden auf der obersten Gliederungsebene
durch chapter-Elemente in Kapitel
unterteilt. Eine weitergehende Untergliederung kann durch
das Anlegen von Unterkapiteln erreicht werden. Im Gegensatz
zu Kapiteln, die durch chapter-Elemente
ausgezeichnet werden, erfolgt die Auszeichnung von
Unterkapitel mit dem Element
sectn. Das
n in Elementnamen trifft eine
Aussage über die Gliederungstiefe, auf der sich das
Unterkapitel befindet. Ein sect1-Element
kann mehrere Elemente vom Typ sect2
enthalten, die die Unterkapitel der
nächsten Gliederungsebene darstellen.
sect5 ist das letzte Element, das auf
diese Art zur Gliederung eingesetzt werden kann.UnterkapitelEin BeispielkapitelEin beliebiger Text.Erster Abschnitt (1.1)
…
Zweiter Abschnitt (1.2)Erster Unterabschnitt (1.2.1)Erster Unterunterabschnitt (1.2.1.1)
…
Zweiter Unterabschnitt (1.2.2)
…
]]>Die Unterkapitel dieses Beispiels wurden zu
Demonstrationszwecken manuell durchnummeriert. In
normalen Dokumenten wird diese Aufgabe von
den Stylesheets übernommen.Bücher mittels part
unterteilenIn den Fällen, in denen die Unteilung eines Buches in
Kapitel nicht ausreichend ist, können mehrere
Kapitel mit dem Element part zu
einem Teil zusammengefasst werden.EinführungÜberblick
…
Was ist FreeBSD?
…
Die Geschichte von FreeBSD
…
]]>BlockelementeAbsätzeDocBook kennt drei Arten von Absätzen: Absätze
mit Überschrift (formalpara),
normale Absätze (para) und einfache
Absätze (simpara).Normale Absätze und einfache Absätze
unterscheiden sich dadurch, dass innerhalb von
para Blockelemente erlaubt sind,
innerhalb von simpara hingegen nicht. Es
ist empfehlenswert, para den Vorzug
zu geben.Absatz mit paraDas ist ein Absatz. Absätze können fast jedes andere
Element aufnehmen.]]>Darstellung:Das ist ein Absatz. Absätze können fast jedes andere
Element aufnehmen.BlockzitateBlockzitate sind textlich umfangreichere Zitate aus
einem anderen Text, die nicht innerhalb des aktuellen
Absatzes angezeigt werden sollen. Wahlweise können
Blockzitate eine Überschrift haben und die Zitatquelle
nennen.blockquoteEin Auszug aus dem Grundgesetz:
Menschenwürde; Grundrechtsbindung der staatlichen GewaltAus dem GrundgesetzDie Würde des Menschen ist unantastbar. Sie zu achten
und zu schützen ist Verpflichtung aller staatlichen
Gewalten.Das Deutsche Volk bekennt sich darum zu unverletzlichen
und unveräußerlichen Menschenrechten als Grundlage jeder
menschlichen Gemeinschaft, des Friedens und der
Gerechtigkeit in der Welt.Die nachfolgenden Grundrechte binden Gesetzgebung,
vollziehende Gewalt und Rechtsprechung als
unmittelbar geltendes Recht.
]]>Darstellung:
Menschenwürde; Grundrechtsbindung der
staatlichen GewaltAus dem GrundgesetzDie Würde des Menschen ist unantastbar. Sie
zu achten und zu schützen ist Verpflichtung
aller staatlichen Gewalten.Das Deutsche Volk bekennt sich darum zu
unverletzlichen und unveräußerlichen
Menschenrechten als Grundlage jeder menschlichen
Gemeinschaft, des Friedens und der Gerechtigkeit in
der Welt.Die nachfolgenden Grundrechte binden
Gesetzgebung, vollziehende Gewalt und Rechtsprechung
als unmittelbar geltendes Recht.
Tipps, Anmerkungen, Warnungen, wichtige Informationen
und RandbemerkungenIn bestimmten Fällen kann es nützlich sein,
dem Leser zusätzliche Informationen zu geben, die sich
vom Haupttext abheben, damit der Leser sie besser wahrnimmt.
Abhängig von der Art der Information, können
solche Stellen mit einem der Elemente tip
(für Tipps), note (für
Anmerkungen), warning (für
Warnungen), caution (für besonders
ernstzunehmende Warnungen) und important
(für wichtige Anmerkungen) ausgezeichnet werden. Trifft
keines dieser Element für die auszuzeichnende Stelle
zu, sollte diese mit dem Element sidebar
ausgezeichnet werden.Da die richtige Einordnung einer auszuzeichnenden
Textstelle nicht immer leicht zu treffen ist, werden in der
DocBook-Dokumentation folgende Empfehlungen gegeben:Eine Anmerkung (note) ist eine
Information, die von jedem Leser beachtet werden
sollte.Eine wichtige Anmerkung
(important) eine Variation einer
Anmerkung.Eine Warnung (warning)
betrifft einen möglichen Hardwareschaden
oder weist auf eine Gefahr für Leib und Leben
hin.Eine besonders ernstzunehmende Warnung
(caution) betrifft einen möglichen
Datenverlust oder Softwareschaden.warningWenn Sie FreeBSD auf Ihrer Festplatte installieren,
kann es sein, daß Sie Windows nie mehr benutzen wollen.
]]>
-
+ Eine Warnung wird wie folgt dargestellt:
+
Wenn Sie FreeBSD auf Ihrer Festplatte installieren,
kann es sein, dass Sie Windows nie mehr benutzen wollen.Listen und HandlungsanweisungenListen sind ein oft gebrauchtes Hilfsmittel, wenn es
darum geht, Informationen für den Benutzer
übersichtlich darzustellen oder eine Abfolge von
Arbeitsschritten zu beschreiben, die notwendig sind, um ein
bestimmtes Ziel zu erreichen. Zur Auszeichnung von Listen
stellt DocBook die Elemente itemizedlist,
orderedlist und
procedure zur Verfügung.DocBook kennt noch andere Elemente für die
Auszeichnung von Listen, die an dieser Stelle jedoch
nicht behandelt werden..itemizedlist und
orderedlist ähneln sehr stark ihren
HTML-Gegenstücken ul und
ol. Beide Listenarten müssen
mindestens ein Element listitem
enthalten. Das listitem Element
muss mindestens ein weiteres Blockelement
enthalten.procedure unterscheidet sich ein
wenig von den vorhergehenden. Es enthält
step-Elemente, die wiederum
step- oder
substel-Elemente enthalten können.
Ein step-Element kann nur Blockelemente
aufnehmen.itemizedlist,
orderedlist und
procedureDas ist das erste Listenelement.Das ist das zweite Listenelement.Das ist das erste Aufzählungselement.Das ist das zweite Aufzählungselement.Machen Sie zuerst dies.Und dann machen Sie das..Und jetzt noch das…]]>Darstellung:Das ist das erste Listenelement.Das ist das zweite Listenelement.Das ist das erste Aufzählungselement.Das ist das zweite Aufzählungselement.Machen Sie zuerst dies.Und dann machen Sie das..Und jetzt noch das…Dateiinhalte auszeichnenTechnische Dokumente enthalten oft auch
Konfigurationsbeispiele oder Quellcodeschnipsel. Zur
Auszeichnung dieser Inhalte, stellt Docbook das Element
programmlisting zur Verfügung. Im
Gegensatz zu anderen DocBook-Elementen wird der
Elementinhalt von programmlistingnicht normalisiert, das heißt,
dass alle Leerzeichen, Tabulatoren und
Zeilenumbrüche unverändert übernommen werden.
Aus diesem Grund ist es unter anderem wichtig, dass
sich der öffende Tag in der selben Zeile wie der Anfang
des darzustellenden Textes befindet. Gleiches gilt für
den schließenden Tag: Er muss sich am Ende der
letzten Zeile befinden. Wird das nicht beachtet, kann es
sein, dass unerwartete Leerzeichen und Leerzeilen in
der Ausgabe auftauchen.programlistingAm Ende sollte Ihr Programm wie folgt
aussehen:
#include <stdio.h>
int
main(void)
{
printf("Hallo Welt!\n");
}]]>Die spitzen Klammern der
#include-Anweisung können nicht direkt
verwendet werden, sondern müssen über ihre Entitäten
eingebunden werden.Darstellung:Am Ende sollte Ihr Programm wie folgt aussehen:#include <stdio.h>
int
main(void)
{
printf("Hallo Welt!\n");
}TextanmerkungenTextanmerkungen
auf Englisch:
callout
sind ein Mechanismus, um auf bestimmte Stellen in einem
vorhergehenden Beispiel oder Text zu verweisen.Um solche Verweise anzulegen, müssen die betreffenden
Stellen in den Beispielen
(programlisting,
literallayout, …) mit
co-Elementen markiert werden, wobei jedes
Element ein eindeutiges id-Attribut
besitzen muss. Anschließend sollte ein
calloutlist-Element eingefügt werden,
dessen Elemente sich auf die co-Elemente
des Beispiels beziehen und die jeweiligen Anmerkungen
enthalten.Das co- und das
calloutlist-ElementAm Ende sollte Ihr Programm wie folgt
aussehen:
#include <stdio.h>
int
main(void)
{
printf("Hallo Welt\n");
}Bindet die Headerdatei stdio.h ein.Bestimmt den Typ des Rückgabewertes von main().Ruft die Funktion printf() auf, die
Hallo Welt! auf der Standardausgabe ausgibt]]>Darstellung:Am Ende sollte Ihr Programm wie folgt aussehen:#include <stdio.h>
int
main(void)
{
printf("Hallo Welt\n");
}Bindet die Headerdatei stdio.h ein.Bestimmt den Typ des Rückgabewertes von main().Ruft die Funktion printf() auf, die
Hallo Welt! auf der Standardausgabe ausgibtTabellenIm Gegensatz zu HTML ist es nicht notwendig, Tabellen zu
Layoutzwecken einzusetzen, da die Layoutaufgabe von den
Stylesheets übernommen wird. Stattdessen sollten Tabellen
nur für die Auszeichnung von Daten in Tabellenform genutzt
werden.Vereinfacht betrachtet (für Details sollte die
DocBook-Dokumentation zu Rate gezogen werden) besteht eine
Tabelle, die entweder als formelle oder als informelle
Tabelle angelegt werden kann, aus einem
table-Element. Dieses Element selbst
beinhaltet mindestens ein Element tgroup,
das über ein Attribut die Spaltenanzahl der Tabelle
bestimmt. Innerhalb des Elementes tgroup
kann sich ein Element thead mit den
Spaltenüberschriften und ein Element
tbody mit dem eigentlichen Tabelleninhalt
befinden. Beide Elemente beinhalten
row-Elemente, die wiederum
entry-Elemente beinhalten. Jedes
entry-Element stellt eine einzelne
Tabellenzelle dar.Tabellen mittels informaltable
auszeichnen
-
+ Spaltenüberschrift 1Spaltenüberschrift 2Zeile 1, Spalte 1Zeile 1, Spalte 2Zeile 2, Spalte 1Zeile 2, Spalte 2
]]>Darstellung:
-
+ Spaltenüberschrift 1Spaltenüberschrift 2Zeile 1, Spalte 1Zeile 1, Spalte 2Zeile 2, Spalte 1Zeile 2, Spalte 2Verwenden Sie stets das Attribut pgwide
mit dem Wert 1, wenn Sie das Element
informaltable benutzen. Ein Bug des
Internet Explorers verhindert ansonsten die korrekte
Darstellung dieser Tabellen.Soll die Tabelle keinen Rand haben, kann das Attribut
frame mit dem Wert
none dem Element
informaltable hinzugefügt werden
(<informaltable frame="none">)).Tabelle mit Attribut
frame="none"Darstellung:Spaltenüberschrift 1Spaltenüberschrift 2Zeile 1, Spalte 1Zeile 1, Spalte 2Zeile 2, Spalte 1Zeile 2, Spalte 2Beispiele für den LeserOft gilt es, für dem Benutzer Beispiele
zu geben, die er dann selber nachvollziehen soll. Meist
handelt es sich dabei um interaktive Dialoge zwischen Mensch
und Maschine: Der Benutzer gibt einen Befehl ein und
erhält eine Antwort vom System. Ein Satz
von speziellen Elementen und Entitäten unterstützt
den Autor bei der Auszeichnung solcher Textstellen:screenGedacht zur Auszeichnung von Bildschirminhalten.
Im Unterschied zu anderen Elementen werden Leerzeichen
innerhalb des Elementes screen
unverändert übernommen.prompt,
&prompt.root; und
&prompt.user;Eingabeaufforderungen des Rechners
(Betriebssysten, Shell oder Anwendung) sind ein häufig
auftretender Teil dessen, was der Benutzer auf dem
Bildschirm zu sehen bekommt. Sie sollten mit
prompt ausgezeichnet werden.Ein Spezialfall sind die beiden
Eingabeaufforderungen der Shell für normale
Benutzer und den Superuser root.
Jedesmal wenn auf eine von diesen beiden Nutzerrollen
hingewiesen werden soll, sollte entweder
&prompt.root; oder
&prompt.user; eingesetzt
werden. Beide Entitäten können auch
außerhalb von screen
verwendet werden.&prompt.root; und
&prompt.user; sind
FreeBSD-spezifische Erweiterungen der DocBook DTD
und nicht in der originalen DocBook DTD
enthalten.userinputDas Element userinput ist
für die Auszeichnung von Benutzereingaben
gedacht.screen, prompt
und userinput&prompt.user; ls -1
foo1
foo2
foo3
&prompt.user; ls -1 | grep foo2
foo2
&prompt.user; suPassword:
&prompt.root; cat foo2
This is the file called 'foo2']]>Darstellung:&prompt.user; ls -1
foo1
foo2
foo3
&prompt.user; ls -1 | grep foo2
foo2
&prompt.user; suPassword:
&prompt.root; cat foo2
This is the file called 'foo2'Obgleich der Inhalt der Datei
foo2 in dem obigen Beispiel angezeigt
wird, sollte dieser nicht mit
programlisting ausgezeichnet werden.
Vielmehr sollte programlisting einzig
und allein für die Darstellung von Dateifragmenten
außerhalb von Benutzeraktionen gewählt
werden.FlußelementeHervorhebungenWenn es darum geht bestimmte Wörter oder Textstellen
hervorzuheben, sollte dafür das Element
emphasis verwendet werden. Das so
ausgezeichnete Text wird dann kursiv oder fett dargestellt;
im Falle einer Sprachausgabe würde es anders betont
werden.Im Gegensatz zu den HTML mit seinen Elementen
b und i, kennt DocBook
keinen Weg, um diese Darstellung zu
ändernAnmerkung des
Übersetzers: Hier sollte man sich noch einmal ins
Gedächtnis rufen, dass mittels der DocBook DTD nur
Inhalte ausgezeichnet werden und nicht das Layout
bestimmt wird.. Handelt es sich bei
dem darzustellenden um eine wichtige Information, kann
alternativ important verwendet
werden.Das Element emphasisFreeBSD ist zweifelslos das führende
Unix-artige Bestriebssystem für die Intel-Plattform.]]>Darstellung:FreeBSD ist zweifelslos das führende
Unix-artige Bestriebssystem für die Intel-Plattform.ZitateUm einen Auszug aus einer anderen Quelle zu zitieren
oder kenntlich zu machen, dass eine bestimmte Wendung
im übertragenen Sinne zu verstehen ist, kann der
betreffende Text mit Hilfe des Elementes
quote ausgezeichnet werden. Innerhalb von
quote können die meisten der
normalerweise zur Verfügung stehenden Elemente genutzt
werden.Richtig zitierenEs sollte immer sichergestellt werden, dass die Suche die Grenzen
zwischen lokaler und öffentlicher Administration
(RFC 1535) einhält.]]>Darstellung:Es sollte immer sichergestellt werden, das die Suche
die Grenzen zwischen lokaler und öffentlicher
Administration (RFC 1535) einhält.Tasten, Maustasten und TastenkombinationenDas Element keycap beschreibt
eine bestimmte Taste der Tastatur.
Für die Auszeichnung von Maustasten
steht analog das Element mousebutton zur
Verfügung. Mit Hilfe von keycombo
können beliebige Tasten- und Maustastenkombinationen
beschrieben werden.Das Element keycombo besitzt ein
Attribut action, dem einer der Werte
click, double-click,
other, press,
seq oder simul
zugewiesen werden kann. Die letzten beiden Werte deuten an,
dass die genannte Kombination nacheinander oder
gleichzeitig gedrückt werden soll. Die Stylesheets
fügen zwischen die einzelnen Unterelemente von
keycombo+-Zeichen
ein.Tasten, Maustasten und TastenkombinationenDiese Eingaben zeichnen Sie wie folgt aus:Mit der Tastenkombination AltF1 kann auf die zweite virtuelle Konsole
umgeschaltet werden.
Um vi zu beenden, ohne die Änderungen zu
speichern, muss Esc:q! eingegeben werden.Der Fenstermanager ist so konfiguriert, dass mittels
Altrechter Maustaste
Fenster verschoben werden können.]]>Darstellung:Mit der Tastenkombination AltF1 kann auf die zweite
virtuelle Konsole umgeschaltet werden.Um vi zu beenden, ohne die
Änderungen zu speichern, muss Esc:q! eingegeben werden.Der Fenstermanager ist so konfiguriert, dass mittels
Altrechter Maustaste
Fenster verschoben werden können.Anwendungen, Befehle, Optionen und HilfeseitenOft besteht die Notwendigkeit auf bestimmte Anwendungen
und Befehle zu verweisen. Der Unterschied zwischen einer
Anwendung und einem Befehl liegt darin, dass eine
Anwendung ein einzelnes oder eine Gruppe von Programmen ist,
mit denen eine bestimmte Aufgabe erledigt werden kann. Ein
Befehl hingegen ist der Name eines Programmes, dass der
Benutzer aufrufen kannDer Befehl
mozilla startet das Programm
mozilla..Desweiteren kann es auch vorkommen, dass die
von einem Programm (in einem bestimmten Fall)
akzeptierten Optionen genannt werden müssen.Schlußendlich ist es oft gewünscht, zu einem
Befehl dessen Abschnitt der Manualseiten im
Unix-üblichen Stil Befehl(Zahl)
anzugeben.Anwendungsnamen können mit application
ausgezeichnet werden.Befehle können zusammen mit der betreffenden
Hilfeseite über das DocBook-Element
citerefentry ausgezeichnet werden.
citerefentry muss zwei weitere
Elemente enthalten: refentrytitle,
für den Befehlsnamen, und manvolnum,
für die Kategorie der Hilfeseite.Diese Art auf Befehle zu verweisen kann sehr
ermüdent sein. Daher gibt es einen Satz von
Allgemeinen
Entitäten, der diese Arbeit erleichtert. Er
ist in der Datei
doc/share/sgml/man-refs.ent enhalten
und kann über den folgenden Bezeichner eingebunden
werden:PUBLIC "-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN"Jede Entität in dieser Datei ist wie folgt aufgebaut:
&man.Hilfeseite.Kategorie;.Der Anfang eines Dokumentes, das diese Entitäten
einbindet, könnte so aussehen:<!DOCTYPE book PUBLIC "-//FreeBSD//DTD DocBook V4.1-Based Extension//EN" [
<!ENTITY % man PUBLIC "-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN">
%man; … ]>Um Befehle innerhalb des Fließtextes auszuzeichen,
kann das Element command genutzt werden.
Die Optionen eines Befehles können mit Hilfe von
option ausgezeichnet werden.Wenn man sich mehrmals hintereinander auf den gleichen
Befehl bezieht, sollte man beim ersten Auftreten die Notation
&man.command.section;
verwenden. Für alle folgenden Referenzen sollte hingegen
command verwendet werden. Dadurch
verbessert sich das Erscheinungsbild, insbesondere von HTML,
deutlich.Die Unterscheidung zwischen command
und application kann schwer sein, und
manchmal ist die Entscheidung, welches Element das richtige
ist, nicht leicht. Das folgende Beispiel soll diese
Unterscheidung erleichtern.Anwendungen, Befehle und OptionenSendmail ist der verbreitetste
UNIX-Mailserver.
Sendmail besteht aus den Programmen
sendmail8
- , &man.mailq.8;, und &man.newaliases.8;.
+ , &man.mailq.1;, und &man.newaliases.1;.
Mittels der Option kann
sendmail8 den Status der Mailwarteschlange ausgeben.
Der Status der Mailwarteschlange kann durch den Befehl
sendmail -bp überprüft werden.]]>Darstellung:Sendmail ist der
verbreitetste UNIX-Mailserver.Sendmail besteht aus den
Programmen
sendmail8,
-
- mailq
- 8
- und
-
- newaliases
- 8
- .
+ &man.mailq.1; sowie &man.newaliases.1;.
Mittels der Option kann
sendmail8 den Status der Mailwarteschlange ausgeben.
Der Status der Mailwarteschlange kann durch den Befehl
sendmail -bp überprüft
werden.Die Schreibweise
&man.Hilfeseite.Kategorie;
ist leichter lesbar.Dateien, Verzeichnisse und ErweiterungenImmer wenn in einem Text der Name einer Datei, eines
Verzeichnisses oder eine Dateierweiterung vorkommt, sollte
die betreffende Stelle mit dem Element
filename ausgezeichnet werden.Das Element filenameDie SGML-Quellen des
englischen Handbuches befinden sich im Verzeichnis
/usr/doc/en/handbook/. In
diesem Verzeichnis befindet sich eine Datei
handbook.sgml. Desweiteren sollte
sich eine Datei mit dem Namen
Makefile zusammen mit mehreren
Dateien mit der Endung .ent in diesem
Verzeichnis befinden.]]>Darstellung:Die SGML-Quellen des englischen Handbuches befinden
sich im Verzeichnis
/usr/doc/en/handbook/. In diesem
Verzeichnis befindet sich eine Datei
handbook.sgml. Desweiteren sollte
sich eine Datei mit dem Namen
Makefile zusammen mit mehreren
Dateien mit der Endung .ent in diesem
Verzeichnis befinden.PortnamenFreeBSD-ErweiterungDie hier genannten Elemente sind Bestandteil der
FreeBSD-Erweiterung für DocBook und sind nicht in der
originalen DocBook DTD enthalten.An einigen Stellen ist es notwendig, den Namen eines
- Ports aus FreeBSDs Portssammlung in Dokumenten zu verwenden.
+ Ports aus FreeBSDs Ports-Sammlung in Dokumenten zu verwenden.
In diesem Fall sollte ebenfalls das Element
filename eingesetzt werden, dabei aber
dem Element das Attribut role mit dem
Wert package zugewiesen werden. Da die
- Portssammlung an jeder beliebigen Stelle im Dateisystem
+ Ports-Sammlung an jeder beliebigen Stelle im Dateisystem
installiert werden kann, sollte filename
nur die Kategorie und den Namen des Ports enthalten, aber
nicht das Verzeichnis
/usr/ports.Portsnamen und das Element filenameWenn Sie Ihr Netz und dessen Datenverkehr analysieren
möchten, dann installieren Sie bitte den Port net/ethereal.]]>Darstellung:Wenn Sie Ihr Netz und dessen Datenverkehr analysieren
möchten, dann installieren Sie bitte den Port net/ethereal.Gerätedateien unterhalb von
/devFreeBSD-ErweiterungDie hier genannten Elemente sind Bestandteil der
FreeBSD-Erweiterung für DocBook und sind nicht in der
originalen DocBook DTD enthalten.Wird in einem Dokument Bezug auf Gerätedateien
unterhalb von dev
genommen, dann gibt es zwei Möglichkeiten diese
auszuzeichnen. Zum einen kann man sich auf das Gerät
beziehen, so wie es unter /dev zu
finden ist, und zum anderen kann man sich auf den
Gerätenamen beziehen, wie es innerhalb des Kerns
verwendet wird. Für letztere Möglichkeit sollte
das Element devicename genutzt
werden.Allerdings besteht nicht immer diese
Wahlmöglichkeit. Einige Geräte, wie zum Beispiel
Netzwerkkartenm haben keinen Eintrag unter
/dev oder werden anders
dargestellt.Gerätenamen per devicename
auszeichnenUnter FreeBSD wird die serielle Datenübertragung über
sio abgewickelt, das unterhalb von
/dev eine Reihe von Einträgen anlegt.
Zu diesen Einträgen behören beispielsweise
/dev/ttyd0 und
/dev/cuaa0.
Andererseits erscheinen Geräte wie beispielsweise
ed0 nicht unterhalb von
/dev.Unter MS-DOS wird das erste Diskettelaufwerk als
a: bezeichnet. FreeBSD
bezeichnet es als /dev/fd0.]]>Darstellung:Unter FreeBSD wird die serielle Datenübertragung
über sio abgewickelt, das
unterhalb von /dev eine Reihe von
Einträgen anlegt. Zu diesen Einträgen
behören beispielsweise
/dev/ttyd0 und
/dev/cuaa0.Andererseits erscheinen Geräte wie beispielsweise
ed0 nicht unterhalb von
/dev.
Unter MS-DOS wird das erste Diskettelaufwerk als
a: bezeichnet. FreeBSD bezeichnet
es als /dev/fd0.Rechner, Domains, IP-Adressen und mehrFreeBSD-ErweiterungDie hier genannten Elemente sind Bestandteil der
FreeBSD-Erweiterung für DocBook und sind nicht in der
originalen DocBook DTD enthalten.Bezeichner für Rechner können in Abhängigkeit
der Bezeichnungsweise auf verschiedene Art und Weise
ausgezeichnet werden. Gemeinsam ist allen, dass sie
das Element hostid benutzen. Über das
Attribut role wird die Art des Bezeichners
genauer bestimmt.Kein Rollenattribut oder
role="hostname"Ohne Rollenattribut stellt der umschlossene Text
einen normlen Rechnernamen wie
freefall oder
wcarchive dar. Wenn es
gewünscht ist, kann mittels
role="hostname" explizit angegeben
werden, dass es sich um einen Rechnernamen
handelt.role="domainname"Ein Domainname wie FreeBSD.org
oder ngo.org.uk. Er enthält keinen
Rechnernamen.role="fqdn"Vollqualifizierter Domainname wie
www.FreeBSD.org. Enthält sowohl
einen Domainnamen als auch einen Rechnernamen.role="ipaddr"Eine IP-Adresse, meistens als durch Doppelpunkte
getrenntes Tupel von vier Zahlen dargestellt.role="ip6addr"Eine IPv6-Adresse.role="netmask"Eine Netzwerkmaske, dargestellt als ein durch
Doppelpunkte getrenntes Vierzahlentupel, einer Hexzahl
oder als ein /, dem eine Zahl
folgt.role="mac"Eine MAC-Adresse, dargestellt durch zweistellige
Hexzahlen, die durch Doppelpunkte getrennt
sind.role und
hostidDer lokale Rechner kann immer über den Namen
localhost angesprochen werden, dem immer
die IP-Adresse
127.0.0.1 zugeordnet ist.
Zur Domain FreeBSD.org
gehören verschiedene Rechner, inklusive freefall.FreeBSD.org und bento.FreeBSD.org.
+ role="fqdn">pointyhat.FreeBSD.org.
Wenn eine IP-Adresse einer Netzwerkkarte zugeordnet wird,
was mit der Hilfe von ifconfig geschieht,
sollte immer die Netzmaske
255.255.255.255, die auch
hexadezimal als 0xffffffff
abgegeben werden kann, benutzt werden.Die MAC-Adresse ist für jede existierende Netzwerkkarte
auf der Welt eindeutig. Eine typische MAC-Adresse ist
beispielsweise 08:00:20:87:ef:d0.]]>Darstellung:Der lokale Rechner kann immer über den Namen
localhost angesprochen werden, dem immer
die IP-Adresse 127.0.0.1
zugeordnet ist.Zur Domain FreeBSD.org gehören
verschieden Rechner, inklusive freefall.FreeBSD.org und bento.FreeBSD.org.Wenn eine IP-Adresse einer Netzwerkkarte zugeordnet
wird, was mit der Hilfe von ifconfig
geschieht, sollte immer die Netzmaske
255.255.255.255, die auch
hexadezimal als 0xffffffff
abgegeben werden kann, benutzt werden.Die MAC-Adresse ist für jede existierende
Netzwerkkarte auf der Welt eindeutig. Eine typische
MAC-Adresse ist beispielsweise 08:00:20:87:ef:d0.BenutzernamenFreeBSD-ErweiterungDie hier genannten Elemente sind Bestandteil der
FreeBSD-Erweiterung für DocBook und sind nicht in der
originalen DocBook DTD enthalten.Namen von Benutzern, wie
root oder bib,
können mit dem Element username
ausgezeichnet werden.Das Element usernameFür die meisten Administrationsaufgaben müssen
Sie als root angemeldet sein.]]>Darstellung:Für die meisten Administrationsaufgaben müssen Sie als
root angemeldet sein.Beschreibung von MakefilesFreeBSD-ErweiterungDie hier genannten Elemente sind Bestandteil der
FreeBSD-Erweiterung für DocBook und sind nicht in der
originalen DocBook DTD enthalten.Zur Beschreibung von Teilen einer Makedatei stehen die
beiden Elemente marketarget und
makevar zur Verfügung.
maketarget bezeichnet ein Ziel eines
Makefiles, das als Parameter beim
Aufruf von make angegeben werden kann.
makevar hingegen bezeichnet eine
Variable, die entweder in einem
Makefile definiert oder
make auf der Befehlszeile übergeben
werden kann, um so den Bauprozess zu beeinflussen.maketarget und
makevarZwei übliche Ziele in einem Makefile
sind all und
clean.
Üblicherweise wird, wenn das Ziel all
aufgerufen wird, die gesamte Anwendung neu erstellt. Der Aufruf
des Zieles clean veranlaßt das
Löschen aller temporären Dateien (zum Beispiel
.o), die während der Übersetzung erzeugt
wurden.Das genaue Verhalten von clean
kann von einer Reihe von Variablen beeinflußt werden.
Stellvertretend seien hier CLOBBER und
RECURSE genannt.]]>Darstellung:Zwei übliche Ziele in einem
Makefile sind
all und
clean.Üblicherweise wird, wenn das Ziel
all aufgerufen wird, die gesamte
Anwendung neu erstellt. Der Aufruf des Zieles
clean veranlaßt das
Löschen aller temporären Dateien (zum Beispiel
.o), die während der
Übersetzung erzeugt wurden.Das genaue Verhalten von
clean kann von einer Reihe von
Variablen beeinflußt werden. Stellvertretend seien
hier CLOBBER und
RECURSE genannt.Text buchstabengetreu übernehmenFür das Handbuch ist es oft notwendig, Textausschnitte
buchstabengetreu darzustellen. Hierbei kann es sich um Texte
handeln, die aus einer anderen Datei stammen oder die der
Leser eins-zu-eins aus dem Handbuch kopieren können
soll.In einigen Fällen ist zu diesem Zwecke
programlisting ausreichend, jedoch nicht
immer. So ist programlisting zum Beispiel
- nicht einsetzbar, wenn es darum geht einen Auszug aus einer
+ nicht einsetzbar, wenn es darum geht, einen Auszug aus einer
Datei innerhalb eines Absatzes einzufügen. In solchen Fällen
sollte das Element literal zum Einsatz
kommen.literalDie Zeile maxusers 10 in der
Kernelkonfigurationsdatei beeinflußt die Größe vieler
Systemtabellen und kann als ungefähr als Richtwert dafür
gelten, wie viele paralle Anmeldungen das System handhaben
kann.]]>Darstellung:Die Zeile maxusers 10 in der
Kernelkonfigurationsdatei beeinflußt die Größe vieler
Systemtabellen und kann als ungefähr als Richtwert dafür
gelten, wie viele paralle Anmeldungen das System handhaben
kann.Benutzerspezifische Eingaben darstellenEs kommt oft vor, dass der Leser Beispiele,
Dateinamen oder Kommandozeilen verändern muss.
Für einen solchen Anwendungsfall
ist das Element replaceable gedacht. Es
kann innerhalb von anderen Elementen
genutzt werden, um die Teile auszuzeichnen, die es zu
ersetzen gilt.Das Element replaceable
-
- &prompt.user; man command
-]]>
+ &prompt.user; man command]]>Darstellung:&prompt.user; man commandDieses Beispiel zeigt, dass nur der Text mit
replaceable umschlossen werden soll,
den der Benutzer einzusetzen hat. Sämtlicher anderer
Text sollte wie üblich ausgezeichnet werden.Die Zeile
maxusers n
in der Kernelkonfigurationsdatei bestimmt die Größe vieler Systemtabellen
und stellt einen groben Richtwert dafür dar, wie viele gleichzeitige Anmeldungen
das System unterstützt.
Für einen Arbeitsplatzrechner stellt 32 einen guten
Wert für n dar.]]>Darstellung:Die Zeile maxusers
n in der
Kernelkonfigurationsdatei bestimmt die Größe
vieler Systemtabellen und stellt einen groben Richtwert
dafür dar, wie viele gleichzeitige Anmeldungen das
System unterstützt.Für einen Arbeitsplatzrechner stellt
32 einen guten Wert für
n dar.Fehlermeldungen des Systems darstellenIn manchen Fällen kann es nötig sein,
Fehlermeldungen darzustellen, die von FreeBSD erzeugt werden
können. Für solche Fälle ist das Element
errorname vorgesehen.Das Element errornamePanic: cannot mount root ]]>Darstellung:Panic: cannot mount rootBilder und GrafikenDie Verwendung von Grafiken innerhalb der Dokumentation
ist momentan noch in einem experimentellen Stadium. Es ist
daher wahrscheinlich, dass sich die hier beschriebenen
Mechanismen noch ändern werden.Für die Verwendung von Grafiken ist es notwendig,
den Port graphics/ImageMagick
zusätzlich zu installieren, da er
nicht vom Port textproc/docproj mitinstalliert
wird.Das beste Beispiel für den Einsatz von Grafiken ist
der unter
doc/en_US.ISO8859-1/articles/vm-design/
zu findene Artikel Design elements of the FreeBSD VM
system. Falls beim Lesen der folgenden Kapitel
Fragen unbeantwortet oder unklar bleiben, empfiehlt es sich,
die unter dem genannten Verzeichnis befindlichen Dateien zu
studieren und anhand ihrer zu verstehen, wie alles
zusammenhängt. Es empfiehlt sich, den Artikel in
verschiedenen Ausgabeformaten zu erzeugen, da man so sehen
kann, wie die Grafiken in Abhängigkeit vom
Ausgabemedium angeordnet werden.Unterstütze GrafikformateZur Zeit werden nur zwei Grafikformate unterstützt.
Welches von beiden Formaten zum Einsatz kommen sollte,
hängt von der Art der Grafik ab.Für Bilder, die vorrangig Vektorelemente wie
Netzwerkdiagramme, Zeitlinien und ähnliches beinhalten,
sollte Encapsulated Postscript als Format gewählt
werden. Wichtig ist es in diesem Fall, dass die
Grafikdatei die Endung .eps hat.
Für Bitmapgrafiken, wie zum Beispiel Bildschirmfotos,
steht das Portable Network Grafic Format zur
Verfügung. In diesem Fall, sollte die Grafikdatei immer
die Endung .png haben.In das CVS-Archiv sollten nur
Grafiken in diesen beiden Formaten übernommen
werden.Es sollte darauf sehr darauf geachtet werden, das
richtige Format für das richtige Bild zu wählen.
Erwartungsgemäß wird es Dokumente geben, die eine
Mischung aus PNG- und EPS-Grafiken enthalten. In solchen
Fällen, stellen die Makedateien die Verwendung des
richtigen Formats in Abhängigkeit vom Ausgabeformat
sicher. Deshalb sollte die gleiche Grafik niemals
in zwei unterschiedlichen Formaten in das CVS-Archiv
übernommen werden.Es ist absehbar, dass das Dokumentationsprojekt
in Zukunft das Scalable Vector Graphic-Format (SVG) als
Standardformat für Vektorgrafiken übernehmen
wird. Zum jetzigen Zeitpunkt ist dieser Wechsel noch nicht
möglich, da der Stand der jetzigen SVG-Anwendungen
noch nicht den dafür notwendigen Erfordernissen
entspricht.DocBook-Elemente für den GrafikeinsatzDas Auszeichnen von Bildern mittels DocBook ist relativ
einfach. Zuerst wird ein
mediaobject-Element eingefügt, das
als Container für medienspezifische Elemente fungieren
kann. Für die Zwecke des FDPs sind das die Elemente
imageobject und
textobject.In das mediaobject-Element sollten
ein Element vom Typ imageobject und zwei
textobject-Elemente eingefügt
werden. Das imageobject-Element verweist
auf die eigentliche Grafikdatei. Dabei ist allerdings nur
der Dateipfad ohne Erweiterung anzugegeben. Die
textobject-Elemente werden dafür
genutzt, Texte aufzunehmen, die dem Leser anstelle des
Bildes oder zusammen mit dem Bild angezeigt werden.Dies kann unter zwei Umständen geschehen:Wenn ein Dokument als HTML-Datei durch einem Browser
angezeigt wird. In diesem Falle muss jeder Grafik
ein Alternativtext zugeordnet werden, der dem Leser
angezeigt werden kann. Meist ist das notwendig, wenn der
Browser die Grafik noch nicht geladen hat oder wenn der
Benutzer den Mauszeiger über die Grafik
führt.Wenn das Dokument als Textdatei gelesen wird. Da in
einer Textdatei keine Grafiken angezeigt werden können,
sollte es für die Grafik eine Textentsprechung geben,
die alternativ angezeigt werden kann.Das folgende Beispiel soll das bisher geschriebene
illustrieren. Angenommen es liegt eine einzubindene Grafik
in der Datei bild1 vor, die die
Darstellung eines As in einem Rechteck enthält. Die
ASCII-Alternative könnte so ausgezeichnet werden:<mediaobject>
<imageobject>
<imagedata fileref="bild1">
</imageobject>
<textobject>
<literallayout class="monospaced">+ - - - - - - - - - - - - - - -+
| A |
+- - - - - - - - - - - - - - -+</literallayout>
</textobject>
<textobject>
<phrase>Ein Bild</phrase>
</textobject>
</mediaobject>Innerhalb vom Element imageobject
befindet sich ein Element imagedata,
welches mit Hilfe des Attributes
fileref den Namen der Grafikdatei
(ohne Erweiterung) angibt. Die Bestimmung der
Dateierweiterung wird von den Stylesheets
übernommen.Das erste textobject-Element
enthält ein literallayout-Element,
dessen Attribut class den Wert
monospaced zugewiesen bekommt. Der
Inhalt dieses Elements wird genutzt, wenn das Dokument
in Textform ausgegeben wird. An dieser Stelle hat der
Autor die Möglichkeit seine
Textzeichenkünste unter Beweis zu
stellen.Wichtig ist, dass die erste und die letzte
Zeile sich gleichauf mit dem öffenden und dem
schließenden Tag befindet. Dadurch wird
sichergestellt, dass keine unnötigen
Leerzeichen in die Ausgabe aufgenommen werden.Das zweite textobject-Element
sollte lediglich ein phrase-Element
enthalten. Wird das Dokument nach HTML konvertiert, wird
dessen Inhalt für das Attribut
alt des img-Tags
verwendet.Die Makefile-EinträgeAlle in einem Dokument verwendeten Grafiken müssen in
dem zugehörigen Makefile in der Variable
IMAGES enthalten sein.
IMAGES sollte immer die Namen der
Quellgrafiken enthalten. Werden in
einem Dokument beispielsweise die drei Grafiken
bild1.eps,
bild2.png und
bild3.png referenziert, sollte das
Makefile die folgende Zeile
enthalten:…
IMAGES= bild1.eps bild2.png bild3.png
…Eine andere Möglichkeit wäre:…
IMAGES= bild1.eps
IMAGES+= bild2.png
IMAGES+= bild3.png
…Es kann nicht oft genug betont werden: Welche
Grafikdateien für das zu erzeugende Dokument benötigt
werden, wird von dem Makefiles bestimmt.
IMAGES darf nur die Originaldateien
enthalten.Grafiken und Kapitel in UnterverzeichnissenWenn Sie Ihre Dokumentation in mehrere kleine
Dateien aufspalten (siehe
),
müssen Sie sorgfältig vorgehen.Angenommen es handelt sich um ein Buch, dessen drei
Kapitel in separaten Verzeichnissen angelegt wurden
(kapitel1/kapitel.sgml,
kapitel2/kapitel.sgml und
kapitel3/kapitel.sgml). Enthalten die
Kapitel Grafiken, empfiehlt es sich, diese in den gleichen
Verzeichnisses abzulegen, wie die Kapitel selbst. In diesem
Falle gilt es jedoch zu beachten, dass die Pfade der
Grafikdateien in der Variable IMAGES und
in den imagedata-Elementen immer auch den
Verzeichnisnamen mitenthalten.Soll beispielsweise die Datei
kapitel1/bild1.png in das in
kapitel1/kapitel.sgml enthaltene
Kapitel eingebunden werden, sollte dies so erfolgen:<mediaobject>
<imageobject>
<imagedata fileref="kapitel1/bild1">
</imageobject>
…
</mediaobject>fileref muss den
Datei- und den Verzeichnisnamen enthalten.Das Makefile muss dementsprechend
die Zeile
…
IMAGES= kapitel1/bild1.png
…
enthalten.Wird dies beachtet, sollte es zu keinen Problemen
kommen.QuerverweiseQuerverweise sind auch Flußelemente.Querverweise innerhalb eines DokumentesUm innerhalb eines Dokumentes Verweise anzulegen, muss
angegeben werden, von welcher Textstelle aus wohin verwiesen
werden soll.Jedes DocBook-Element besitzt ein Attribut
id, über das seinem Element ein
eindeutiger Bezeichner zugewiesen werden kann.In den meisten Fällen werden Querverweise nur zu
Kapiteln gesetzt. Die chaper- und
sect*-Elemente sollten aus diesem Grunde
ein gesetztes id-Attribut
besitzen.chapter und section
mit dem Attribut idEinführungDas ist eine Einführung. Sie enthält ein Unterkapitel, das
ebenfalls einen eigenen Bezeichner hat.Unterkapitel 1Das ist ein Unterkapitel.
]]>Als Wert für das Attribut id
sollte immer ein selbsterklärender Bezeichner gewählt
werden. Zudem ist es notwendig, dass dieser Bezeichner
innerhalb des Dokumentes eindeutig ist. Im obigen Beispiel
wurde der Bezeichner für das Unterkapitel gebildet,
indem der Bezeichner des übergeordneten Kapitels um den
Titel des Unterkapitels erweitert wurde. Diese
Vorgehensweise hilft sicherzustellen, dass Bezeichner
eindeutig sind und bleiben.Manchmal soll jedoch nicht auf den Anfang eines Kapitels
verwiesen werden, sondern zum Beispiel auf eine Stelle in
einem Absatz oder auf ein bestimmtes Beispiel. In solchen
Fällen kann an der Stelle, auf die verwiesen werden
soll, das Element anchor mit gesetztem
Attribut id eingefügt werden.
anchor kann selber keinen weiteren Inhalt
aufnehmen.Querverweise und das Element
anchorDieser Absatz enthält ein
Ziel für Querverweise, was jedoch keine
Auswirkung auf dessen Darstellung hat.]]>Zum Anlegen des eigentlichen Querverweises selbst kann
eines der beiden Elemente xref oder
link genutzt werden. Beide besitzen das
Attribut linkend, dem der
id-Wert des Verweiszieles zugewiesen
wird. Ob sich das Ziel vor oder nach dem Verweis befindet,
spielt keine Rolle.xref und link
unterscheiden sich jedoch hinsichtlich der Art und Weise,
auf die der Text erzeugt wird, auf dem der Querverweis
liegt. Kommt xref zum Einsatz, hat der
Autor keine Kontrolle darüber – der Text wird
automatisch für ihn erzeugt.Einsatz von xrefFür dieses Beispiel wird davon ausgegangen, dass sich
folgendes Textfragment irgendwo innerhalb eines Dokumentes
auftaucht, dass das vorherige
id-Beispiel enthält.Weitere Informationen gibt
es im .
Genauere Informationen können im
gefunden werden.]]>Der Verweistext wird automatisch von den Stylesheets
erzeugt und so hervorgehoben, dass ersichtlich ist,
dass es sich bei dem Text um einen Verweis
handelt.
Weitere Informationen können in der
Einführung gefunden
werden.Genauere Informationen können im
Unterkapitel 1 gefunden
werden.
Der Text, auf dem der HTML-Link für den Querverweis
liegt, wurde von den Kapitelüberschriften
übernommen.Das bedeutet, dass es nicht
möglich ist, mit der Hilfe von
xref einen Querverweis zu einer mit
anchor gekennzeichneten Stelle
anzulegen. Da anchor keinen Inhalt
aufnehmen kann, können die Stylesheets nicht
automatisch einen Text für den Verweis
erzeugen.Möchte man selber den für den Verweis
benutzten Text bestimmen können, sollte das Element
link verwendet werden. Im Gegensatz zu
xref kann link Inhalt
aufnehmen, der dann für den Verweis verwendet
wird.link beutzenFür dieses Beispiel wird davon ausgegangen, dass
es sich in dem Dokument befindet, das auch
das id-Beispiel enthält.Weitere Informationen können
im ersten Kapitel gefunden
werden.
Genauere Informationen können in
diesem Kapitel
gefunden werden.]]>Aus diesem SGML-Fragment würden die Stylesheets
folgendes generieren (der hervorgehobene Text deutet den
erzeugten Verweis an):
Weitere Informationen können im ersten
Kapitel gefunden werden.Genauere Informationen können in
diesem Kapitel gefunden
werden.
Das letzte Beispiel ist schlecht. Es sollten niemals
Wörter wie dieses oder
hier als Linktext benutzt werden. Solche
Wörter zwingen den Leser dazu, den Kontext des
Verweises zu lesen, um zu verstehen, wohin der Verweis
führt.Mit dem Element linkkann auf mit
anchor gekennzeichnete Stellen im
Dokument verwiesen werden, da der Inhalt von
link als Text für den Querverweise
genutzt wird.Verweise auf Dokumente im WWWDas Anlegen von Verweisen auf externe Dokumente ist
wesentlich einfacher – solange die URL des zu
referenzierenden Dokumentes bekannt ist. Um von einem
bestimmten Textabschnitt auf das gewünschte externe
Dokument zu verweisen, muss die jeweilige Stelle mit
dem Element ulink ausgezeichnet werden.
Mittels des Attributes url kann die
Adresse des Zieldokumentes angegeben werden. Bei der
Umformung des Quelldokumentes in die verschiedenen
Ausgabeformate wird der sich zwischen Start- und Endtag
befindliche Text für den Verweis übernommen, den
der Leser aufrufen kann.Verweise mit ulinkNatürlich ist es möglich, anstatt diesen Text
weiterzulesen, sofort die
FreeBSD-Homepage
aufzurufen.]]>Darstellung:Natürlich ist es möglich, anstatt diesen Text
weiterzulesen, sofort die FreeBSD-Homepage
aufzurufen.
diff --git a/de_DE.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml b/de_DE.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml
index 13047befac..2ab00ca754 100644
--- a/de_DE.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml
+++ b/de_DE.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml
@@ -1,1970 +1,1970 @@
Die SGML-FibelDie Mehrzahl der Dokumente des FDPs sind in SGML geschrieben.
Ziel dieses Kapitels ist es, genau zu erklären, was
das bedeutet und wie man die SGML-Quellen liest und versteht.
Ebenso werden die in den Quellen genutzten Kniffe erklärt,
auf die man beim Lesen der Dokumente stoßen wird.Teile dieses Kapitels basieren auf Mark Galassis Get
Going With DocBook.ÜberblickIn den guten alten Zeiten war der Umgang mit
elektronischem Text einfach. Man musste
lediglich wissen, welcher Zeichensatz (ASCII, EBCDIC oder ein
anderer) vorlag. Text war einfach Text und sah so aus, wie man
ihn sah. Keine Extras, keine Formatierungen und kein sonstiger
Schnickschnack.Für viele Zwecke war dies allerdings nicht ausreichend.
Von einem machinenlesbaren Text wird erwartet, dass er auch von
Maschinen gelesen und intelligent weiterverarbeitet werden kann.
Einzelne Stellen sollen hervorgehoben werden, andere sollen in ein
Glossar aufgenommen werden oder auf andere Textstellen
verweisen. Dateinamen wiederum sollen in einer
schreibmaschinenähnlichen Schrift auf dem
Bildschirm dargestellt werden, der Ausdruck soll jedoch in
Schrägschrift oder in einer beliebigen anderen
Darstellungsform erfolgen.Anfänglich gab es die Hoffnung, dass die
Künstliche Intelligenz (KI) helfen würde, dieses Ziel
zu erreichen. Computer sollte den Text lesen und dazu in der Lage
sein, selbstständig wichtige Formulierungen, Dateinamen,
Benutzereingaben oder Beispiele zu erkennen. Leider verlief die
Entwicklung in diesem Bereich nicht wie gewünscht und Computer
benötigen nach wie vor etwas Unterstützung, bevor sie
Texte vernünftig verarbeiten können.Genauer gesagt, man muss ihnen sagen, was was ist. Sehen
wir uns folgende Zeilen an:
Löschen Sie /tmp/foo mittels &man.rm.1;.&prompt.user; rm /tmp/foo
Es fällt uns leicht, zu erkennen, was ein Dateiname, ein
einzugebender Befehl oder ein Verweis auf eine Hilfeseite ist. Das
kann ein Computer, der einen Text verarbeitet, nicht. Aus diesem
Grund ist es notwendig, Texte mit weiteren Informationen
auszuzeichnen.Der Begriff AuszeichnungIm
angelsächischschen Sprachraum wird von
markup
gesprochen. bedeutet, dass
sich der Wert eines Textes erhöht, aber auch seine Kosten.
Durch Auszeichnungen wird einem Dokument zusätzlicher Text
hinzugefügt, der aber von dem eigentlichen Dokumenteninhalt
auf eine bestimmte Art und Weise unterschieden werden kann, so
dass Programme die Auszeichnung erkennen können und
mittels dieser Informationen während der Verarbeitung in
der Lage sind, Entscheidungen zu treffen. Texteditoren
können diese Auszeichnungselemente vor dem Benutzer
verbergen, um zu vermeiden, dass er durch sie abgelenkt
wird.Die durch die Auszeichnungselemente im Textdokument
zusätzlich abgelegten Informationen erhöhen den Wert
des Dokuments. Allerdings muss diese Arbeit in den meisten
Fällen von einem Menschen getan werden – wären
Maschinen dazu fähig, wären zusätzliche
Auszeichnungselemente unnötig. Der damit verbundene Aufwand
erhöht die Kosten, die durch die
Erstellung des Dokuments entstehen.Das etwas weiter oben gegebene Beispiel sieht im Quelltext
so aus:Löschen Sie /tmp/foo mittels &man.rm.1;.
&prompt.user; rm /tmp/foo]]>Die Auszeichnungselemente sind deutlich vom eigentlichen
Inhalt zu unterscheiden.Die Einführung von Auszeichnungselementen setzt voraus,
dass festgelegt wird, welche Bedeutung einzelne Elemente haben
und wie diese interpretiert werden. Sie brauchen daher eine
Auszeichnungssprache, der Sie folgen, wenn Sie eigene
Dokumente verfassen.Natürlich kann es keine universelle
Auszeichnungssprache geben und eine einzige mag nicht
ausreichend für alle möglichen Anwendungsfälle
sein. Eine Sprache für technische Dokumente wird sich
wahrscheinlich stark von einer für Kochrezepte
unterscheiden. Die universelle Lösung ist eine
Basissprache, mit deren Hilfe weitere Sprachen entwickelt werden
können – eine
Meta-Auszeichungssprache also.Genau diese Anforderung wird von der Standard Generalized
Markup Language (SGML) erfüllt. Mit ihrer
Hilfe wurden viele andere Auszeichungssprachen wie
beispielsweise HTML und DocBook, welche beide von FDP genutzt
werden, entwickelt.Die eigentliche Sprachdefinition erfolgt in einer
Dokumenten-Typ-Definition (DTD). Innerhalb dieser DTD werden die
Namen der einzelnen Elemente, deren mögliche Reihenfolge
und Verschachtelung sowie weitere Informationen
festgelegt.Eine DTD ist eine
vollständige Definition aller
möglichen Sprachelemente, ihrer
ReihenfolgeBei natürlichen Sprachen spricht
man vom Satzbau – demjenigen Konstrukt, das unter
anderem die Position des Subjekts, Objekts und
Prädikats in einem Satz festlegt.,
optionaler Elemente und so weiter und so weiter. Dank dieser
recht formalen Festlegung ist es möglich,
SGML-Parser zu entwickeln, die sowohl ein
Dokument als auch seine DTD einlesen und anhand dieser DTD
prüfen können, ob das Dokument allen Anforderungen der
DTD entspricht. Dieser Vorgang wird allgemein als
Validierung des Dokuments
bezeichnet.Das Validieren eines SGML-Dokuments gegen eine DTD
überprüft lediglich die korrekte Syntax des
Dokuments, dass heißt, ob nur gültige
Auszeichnungselemente verwendet wurden und ihre Reihenfolge
stimmt. Dabei wird nicht geprüft, ob
die Elemente der DTD sinngemäß
verwandt wurden. Sollten beispielsweise alle Dateinamen als
Funktionsnamen ausgezeichnet worden sein, so würde der
Parser keinen Fehler signalisieren. Formaler ausgedrückt:
Der Parser prüft die Syntax, aber nicht die
Semantik.Es ist anzunehmen, dass, wenn man selber vor hat
Dokumentation für das FDP zu schreiben, der
größte Teil davon mit Hilfe von HTML oder DocBook
geschrieben werden wird. Aus diesem Grunde wird an dieser Stelle
nicht erklärt, wie eine DTD entwickelt wird.Von Elementen, Tags und AttributenAlle in SGML geschriebenen DTDs haben bestimmte gemeinsame
Eigenschaften. Das ist nicht verwunderlich, da sich die hinter
SGML stehende Idee unweigerlich bemerkbar macht. Zwei der
markantesten Merkmale dieser Idee sind die Begriffe
Inhalt und
Element.Von einem Dokument, unabhängig, ob es sich um eine
einzelne Webseite oder ein langes Buch handelt, wird angenommen,
dass es einen wie auch immer gearteten Inhalt hat. Dieser
lässt sich selbst wiederum in Teilelemente
aufspalten, die ebenso zerlegbar sind. Durch die Aufnahme von
Auszeichnungselementen in einen Text, werden diese einzelnen
Elemente eindeutig benannt und voneinander abgegrenzt.Nimmt man zum Beispiel ein typisches Buch, so kann man es
auf der obersten Ebene als ein Ganzes, als ein Element
betrachten. Dieses Buch-Element enthält nun
Kapitel, die wiederum selbst als Elemente bezeichnet werden
können. Jedes einzelne Kapitel enthält weitere
Elemente. So gibt es beispielsweise Absätze, Zitate und
Fußnoten. Jeder Absatz kann wiederum selbst Elemente
enthalten, die helfen, den Absatzinhalt als direkte Rede oder
als Namen eines der Protagonisten einer Geschichte zu
identifizieren.Wenn man möchte, kann man sich das als
UnterteilungIm
angelsächsichen Sprachraum wird hier von
chunking gesprochen. des
Inhalts vorstellen. Auf der obersten Ebene gibt es ein Element:
das Buch selbst. Schaut man ein wenig tiefer, findet man weitere
Teilelemente: die einzelnen Kapitel. Diese sind wiederum
unterteilt in Absätze, Fußnoten, Namen und so weiter
und so weiter.Anzumerken ist an dieser Stelle, dass das eben gesagte
ohne weiteres auf jeden Inhaltstyp angewandt werden kann, auch
ohne dass von SGML die Rede ist. Man
könnte beispielsweise einfach verschiedene Stifte nehmen
und einen Ausdruck dieser Fibel vor sich hinlegen und dann mit
verschiedenen Farben die einzelnen Abschnitte des Buchinhalts
markieren.Leider gibt es keinen elektronischen Stift, um das zu tun.
Deshalb muss ein anderer Weg gewählt werden, um zu
bestimmen, zu welchem Element die einzelnen Inhalte
gehören. In SGML-basierten Auszeichnungssprachen wie HTML
und DocBook werden dafür so genannte
Tags eingesetzt.Mit einem solchen Tag wird eindeutig festgelegt, wo ein
bestimmtes Element beginnt und wo es endet. Allerdings
gehört der Tag selber nicht zum Element. Er
legt lediglich die Grenzen des Elements fest. Da jede DTD mit dem Ziel
entwickelt wurde, einen speziellen Inhaltstyp auszuzeichnen,
wird jede DTD verschiedene Elemente kennen, die daher
natürlich auch unterschiedlich benannt sein werden.Der Starttag für ein imaginäres Element mit dem
Namen elementname ist
<elementname>.
Sein Gegenstück, der schließende Endtag, ist
</elementname>.Verwendung eines Elements (Start- und Endtag)HTML kennt das Element p, um
festzulegen, dass ein bestimmter abgegrenzter Bereich
einen Absatz darstellt. Dieses Element hat sowohl einen Start-
als auch einen Endtag.Das ist ein Absatz. Er beginnt mit Starttag
für das Element 'p' und endet mit dem Endtag für
das Element 'p'.
Das ist ein etwas kürzerer Absatz.
]]>Elemente müssen nicht notwendigerweise einen Endtag
haben. Ebenso ist es nicht notwendig, dass Elemente einen
Inhalt haben. Beispielsweise kann in HTML-Dokumenten mittels
eines speziellen Elements festgelegt werden, dass eine
horizontale Linie an einer bestimmten Stelle erscheinen soll. Da
dieses Element offensichtlich keinen Inhalt hat, wird auch kein
Endtag benötigt.Verwendung eines Elements (nur Starttag)In HTML kann man mit dem Element hr
festlegen, dass an einer bestimmten Stelle eine
horizontale Linie angezeigt werden soll. Da dieses Element
keinen Inhalt umschließt, hat es nur einen
Starttag.Das ist ein Abschnitt.
Das ist ein weiterer Absatz. Eine horizontale Linie
trennt ihn vom vorherigen Absatz.
]]>Elemente können andere Elemente enthalten. Im
anfangs erwähnten Buch enthielt das Buch-Element
alle Kapitel-Elemente, die wiederum alle Absatz-Elemente
enthielten und so fort.Verschachtelte Elemente: emDas ist ein einfacher Abschnitt, in dem
einige Wortehervorgehoben wurden.]]>Welche Elemente andere Elemente enthalten können und
welche das sind, wird innerhalb der DTD eines Dokuments
festgelegt.Viele Leute sind oft verwirrt, wenn es um die richtige
Benutzung der Begriffe Tag und Element geht. Im Ergebnis werden
sie oft so genutzt, als wären sie austauschbar.
Allerdings sind sie das nicht.Ein Element ist ein konzeptioneller Teil eines Dokuments
und hat einen festgelegten Anfang und ein festgelegtes
Ende. Ein Tag hingegen markiert die Stelle, an der ein Element
beginnt und endet.Wenn in diesem Dokument vom Tag p
gesprochen wird, ist damit der Text
gemeint, der aus den drei Zeichen <,
p und > besteht. Wird
hingegen von dem Element p
gesprochen, ist damit das gesamte Element gemeint.Diese Unterscheidung ist sicherlich subtil. Trotzdem
sollte man sie sich vergegenwärtigen.Elemente können selber Attribute haben, die aus einem
Namen und einem Wert bestehen. Die Attribute haben die Aufgabe,
dem Element zusätzliche Informationen hinzuzufügen.
Denkbar sind hier Festlegungen über die Darstellung,
Bezeichner, über die das Element eindeutig identifiziert
werden kann, oder beliebige andere Informationen.Elementattribute werden in den Starttag
eingefügt und haben die Form
Attributename="Wert".Bei einigen HTML-Versionen kennt das Element
p das Attribut align, mit
dessen Hilfe die Textausrichtung eines Absatzes bestimmt werden
kann.align akzeptiert einen von vier
vorgegebenen Werten: left,
center, right und
justify. Ist align nicht
angegeben, wird vom Standardwert left
ausgegangen.Elemente mit Attributen nutzenDie Verwendung des align-Attributs
für diesen Absatz ist überflüssig, da left
der Standardwert ist.
Dieser Absatz wird hoffentlich mittig dargestellt.
]]>Einige Attribute akzeptieren nur bestimmte Werte, wie
beispielsweise left oder
justify. Andere akzeptieren jeden beliebigen
Wert. Enthält Attributwert doppelte Anführungszeichen
("), wird der Wert in einfachen
Anführungszeichen eingeschlossen.Attribute mit einfachen AnführungszeichenIch stehe rechts!]]>Manchmal können die Anführungszeichen um den
Attributwert weggelassen werden. Allerdings sind die Regeln,
die festlegen wann dies zulässig ist, sehr spitzfindig.
Am besten schließen Sie Attributwerte
immer in Anführungszeichen ein.Die Informationen über Attribute, Elemente und Tags
sind in SGML-Katalogen abgelegt und werden von den verschiedenen
Werkzeugen des Dokumentationsprojektes genutzt, um die
geschriebenen Dokumente zu validieren. Die Programme die durch
textproc/docproj installiert
werden, bringen ihre eigenen Katalogvarianten mit, zudem pflegt
das FDP seine eigenen Kataloge. Beide Katalogarten müssen
von allen Programmen gefunden werden können.Was dafür getan werden muss;…Damit die Beispiele dieser Fibel ausgeführt werden
können, ist es notwendig, dass einige Programme auf
dem Rechner installiert sind und das eine Umgebungsvariable
korrekt gesetzt wird.Der erste Schritt ist die Installation des Ports
textproc/docproj
über das FreeBSD-Portsystem. textproc/docproj ist ein
Metaport, der alle vom FDP
benötigten Programme und Daten aus dem Netz laden und
installieren sollte.Anschließend muss in den Shellkonfigurationsdateien die
Variable SGML_CATALOG_FILESSofern man nicht an der deutschen
Dokumentation arbeitet, müssen die
Verzeichnisangaben entsprechend angepasst
werden. gesetzt werden..profile, für &man.sh.1; und
&man.bash.1; BenutzerSGML_ROOT=/usr/local/share/sgml
SGML_CATALOG_FILES=${SGML_ROOT}/jade/catalog
SGML_CATALOG_FILES=${SGML_ROOT}/docbook/4.1/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=${SGML_ROOT}/html/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=${SGML_ROOT}/iso8879/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=/usr/doc/share/sgml/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=/usr/doc/en_US.ISO8859-1/share/sgml/catalog:$SGML_CATALOG_FILES
SGML_CATALOG_FILES=/usr/doc/de_DE.ISO8859-1/share/sgml/catalog:$SGML_CATALOG_FILES
export SGML_CATALOG_FILES.cshrc, für &man.csh.1;- und
&man.tcsh.1;-Benutzersetenv SGML_ROOT /usr/local/share/sgml
setenv SGML_CATALOG_FILES ${SGML_ROOT}/jade/catalog
setenv SGML_CATALOG_FILES ${SGML_ROOT}/docbook/4.1/catalog:$SGML_CATALOG_FILES
setenv SGML_CATALOG_FILES ${SGML_ROOT}/html/catalog:$SGML_CATALOG_FILES
setenv SGML_CATALOG_FILES ${SGML_ROOT}/iso8879/catalog:$SGML_CATALOG_FILES
setenv SGML_CATALOG_FILES /usr/doc/share/sgml/catalog:$SGML_CATALOG_FILES
setenv SGML_CATALOG_FILES /usr/doc/en_US.ISO8859-1/share/sgml/catalog:$SGML_CATALOG_FILES
setenv SGML_CATALOG_FILES /usr/doc/de_DE.ISO8859-1/share/sgml/catalog:$SGML_CATALOG_FILESDamit die Änderungen wirksam werden, meldet man
sich ab und anschließend wieder an – oder man
führt die obigen Anweisungen direkt in der Shell
aus und setzt so die benötigten Umgebungsvariablen.Nun sollte man eine Datei
beispiel.sgml anlegen, die den
folgenden Text enthält:Eine Beispieldatei in HTML
Das ist ein Absatz mit etwas Text.
Das ist ein Absatz mit anderem Text.
Dieser Absatz wird rechtsbündig
ausgerichtet.
]]>Nachdem die Datei abgespeichert wurde, kann sie
mit Hilfe eines SGML-Parsers validiert werden.Bestandteil von textproc/docproj
ist nsgmls - ein validierender Parser.
nsgmls liest ein Dokument entsprechend einer SGML-DTD
ein und gibt anschließend ein Element-Structure-Information-Set
(ESIS) aus. Allerdings ist das an dieser Stelle nicht weiter
wichtig.Wird nsgmls mit der Option
aufgerufen, werden nur Fehlermeldungen ausgegeben. Dadurch
kann leicht geprüft werden, ob ein Dokument gültig
ist oder nicht.So prüft man mit nsgmls, ob die neuangelegte
Beispieldatei gültig ist:&prompt.user; nsgmls -s beispiel.sgmlSofern das Beispiel korrekt abgetippt wurde, wird sich
nsgmls ohne jegliche Ausgabe beenden. Das bedeutet,
dass das Dokument erfolgreich validiert werden konnte
und somit gültig ist.Jetzt sollten die Tags title und
/title aus dem Dokument gelöscht
und das Dokument erneut validiert werden:&prompt.user; nsgmls -s beispiel.sgml
nsgmls:beispiel.sgml:5:4:E: character data is not allowed here
nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finishedDie Fehlermeldungen, die von nsgmls
ausgegeben werden, sind in durch Doppelpunkte getrennte
Spalten unterteilt.SpalteBedeutung1Der Name des Programms, das den Fehler
meldet. Hier wird immer nsgmls
stehen.2Der Name der fehlerhaften Datei.3Die Zeilennummer des Fehlers.4Die Spaltenummer des Fehlers.5Ein einbuchstabiger Code, der über die
Art des Fehlers informiert. I
steht für eine informelle Meldung,
W für eine Warnung und
E für FehlerNicht immer besteht eine Meldung aus
fünf Spalten. Die Ausgabe von
nsgmls -sv ist
beispielsweise nsgmls:I: SP version
"1.3" (natürlich
abhängig von der Version). Wie man sehen
kann, handelt es sich hier um eine informelle
Meldung. und X für
einen Querverweis. Bei den oben stehenden Ausgaben
handelt es sich also um Fehlermeldungen.6Die Meldung.Durch das Weglassen des Tags title
sind zwei unterschiedliche Fehler entstanden.Der erste Fehler besagt, dass Inhalt (in diesem
Falle Zeichen anstatt eines Starttags) an einer Stelle
gefunden wurde, an der der Parser etwas anderes erwartet
hat. Genauer gesagt wurde der Starttag eines Elements
erwartet, das innerhalb von head
auftreten kann.Der zweite Fehler wurde dadurch verursacht, dass
das Element head ein
Element title enthalten
muss und nsgmls
nicht berücksichtigt, dass dieser Fehler auf dem
vorhergehenden beruht. Es wird lediglich festgestellt,
dass der Endtag von head auftritt,
obwohl nicht alle notwendigen Elemente vorhanden sind.Zum Schluß sollte der Tag
title wieder in die Beispieldatei
eingefügt werden.Die DOCTYPE-DeklarationAm Anfang jedes Dokuments muss der Name der dem
Dokument zugrundeliegenden DTD angegeben werden. Mit Hilfe
dieser Information können SGML-Parser die verwendete DTD
feststellen und prüfen, ob das Dokument zu ihr konform ist.Üblicherweise steht diese Information in einer Zeile,
die als DOCTYPE-Deklaration bezeichnet wird.Eine Deklaration für ein HTML-Dokument, das nach den
Vorgaben der DTD für HTML 4.0 geschrieben wurde, sieht so
aus:]]>und besteht aus verschiedenen Teilen.<!Die Zeichenkette <! dient hier
als Indikator, dass es sich bei
diesem Ausdruck um eine SGML-Deklaration handelt und diese
Zeile den Dokumententyp festlegt.DOCTYPEZeigt an, dass dies die SGML-Deklaration für
den Dokumententyp ist.htmlNennt das erste Element, das im
Dokument auftaucht.PUBLIC "-//W3C//DTD HTML 4.0//EN"Nennt den Formalen Öffentlichen Bezeichner
auf Englisch Formal Public
Identifier (FPI) der DTD des Dokuments. Diese Information wird
von SGML-Parsern ausgewertet, um die von dem Dokument
referenzierte DTD zu bestimmen.Das Schlüsselwort PUBLIC
gehört nicht zum öffentlichen Bezeichner,
sondern legt fest, wie ein SGML-Parser die DTD finden
kann. Alternative Wege eine DTD zu referenzieren werden
später
gezeigt.>Schließt den mit <! begonnenen
Ausdruck ab.Formale Öffentliche BezeichnerDieser Abschnitt braucht nicht unbedingt zu gelesen zu
werden. Dennoch ist es empfehlenswert, da er nützliche
Hintergrundinformationen enthält, die hilfreich sein
können, falls der SGML-Prozessor die genutzte DTD nicht
finden kann.Jeder öffentliche Bezeichner muss eine bestimmte Syntax
haben, die wie folgt lautet:"Besitzer//SchlüsselwortBeschreibung//Sprache"BesitzerNennt den Besitzer des öffentlichen Bezeichners.Falls diese Zeichenkette mit ISO
beginnt, gehört der Bezeichner dem ISO-Kommitee.
Der Bezeichner "ISO 8879:1986//ENTITIES Greek
Symbols//EN" nennt ISO
8879:1986 als den Besitzer des Satzes von
Entitäten für griechische Zeichen. ISO
8879:1986 ist die ISO-Bezeichnung für den
SGML-Standard.Beginnt die Zeichenkette nicht mit
ISO, sieht sie entweder so
-//Besitzer
oder so
+//Besitzer
aus. Beide Varianten unterscheiden sich also nur durch
das anfängliche + bzw.
-.Sofern am Anfang ein - steht, ist
der Bezeichner nicht öffentlich registriert, steht
hingegen ein + am Anfang, ist er
registriert.Im ISO-Standard ISO 9070:1991 wurde festgelegt, wie
registrierte Namen erzeugt werden können. Unter
anderem können sie von den Bezeichnungen von
ISO-Publikationen, von ISBN-Nummern oder einer
Organisationsbezeichnungen entsprechend ISO 6523
abgeleitet werden. Anträge für neue offiziell
registrierte Bezeichner werden vom ISO-Kommitee an das
American National Standards Institute (ANSI)
weitergeleitet.Da das FreeBSD-Projekt seine Bezeichner nicht hat
registrieren lassen, ist der Besitzer
-//FreeBSD. Unter anderem kann man
daran auch sehen, dass das W3C sich nicht hat
registrieren lassen.SchlüsselwortEs gibt verschiedene Schlüsselwörter mit
denen man die Art der gegebenen Informationen beschreiben
kann. Einige der üblichsten sind
DTD, ELEMENT,
ENTITIES und TEXT.
DTD wird nur für Dateien mit
DTDs verwandt, ELEMENT findet
für Dateien mit Fragmenten von DTDs Verwendung, die
nur Deklarationen für Entitäten und Elemente
enthalten. TEXT wird für
SGML-Inhalte (Texte und Tags) verwendet.BeschreibungEine frei wählbare Beschreibung des Inhalts der
referenzierten Datei. Möglich sind hier
Versionsnummern oder ein kurzer und sinnvoller Text, der
innerhalb der SGML-Welt eindeutig ist.SpracheEin ISO-Code aus zwei Buchstaben, der die für
die Datei verwendete Sprache nennt.
EN steht hier für Englisch,
DE für Deutsch.Die catalog-DateienWenn man die oben beschriebene Syntax für
Bezeichner verwendet und ein Dokument durch einen
SGML-Prozessor schickt, muss dieser die
Möglichkeit haben, den Bezeichner auf eine real
existierende Datei abzubilden, die die benötigte DTD
enthält.Einer der möglichen Wege hierfür sind
Katalogdateien. Eine solche Datei, die üblicherweise
catalog heißt, besteht aus
einzelnen Zeilen, die Bezeichner auf Dateinamen abbilden.
Enthält ein Katalog beispielsweise die ZeilePUBLIC "-//W3C//DTD HTML 4.0//EN" "4.0/strict.dtd"kann ein SGML-Prozessor darüber feststellen, dass die
benötigte DTD in der Datei strict.dtd
im Unterverzeichnis 4.0
des Verzeichnisses des Katalogs zu finden ist.Ein gutes Beispiel für einen Katalog ist
/usr/local/share/sgml/html/catalog.
Diese Datei enthält den Katalog für alle HTML
DTDs, die im Zuge der Installation von textproc/docproj installiert
wurden.Die Variable SGML_CATALOG_FILESNatürlich muss einem SGML-Prozessor noch
mitgeteilt werden können, wo er seine Kataloge finden
kann. Viele Programme bieten hierfür
Kommandozeilenoptionen an, über die man einen oder
mehrere Kataloge angeben kann.Zusätzlich besteht noch die Möglichkeit mit
der Umgebungsvariablen SGML_CATALOG_FILES auf
SGML-Kataloge zu verweisen. Die Einträge von
SGML_CATALOG_FILES müssen aus den
vollständigen Pfadnamen der Kataloge, jeweils durch
Komma getrennt, bestehen.Üblicherweise werden die folgenden Kataloge über
SGML_CATALOG_FILES für
die Arbeit an den Dokumenten des FDPs eingebunden:/usr/local/share/sgml/docbook/4.1/catalog/usr/local/share/sgml/html/catalog/usr/local/share/sgml/iso8879/catalog/usr/local/share/sgml/jade/catalogAllerdings sollte das
schon geschehen
sein.Alternativen zu Formalen Öffentlichen BezeichnernAnstatt mit einem Bezeichner die zum Dokument
gehörende DTD zu referenzieren, kann auch explizit auf
die Datei der DTD verwiesen werden.Die Syntax des DOCTYPE-Deklaration ist in diesem Falle
anders:]]>Das Schlüsselwort SYSTEM legt
fest, dass ein SGML-Prozessor die DTD auf
systemspezifische Art und Weise bestimmen soll.
Meistens, aber nicht immer, wird so auf eine Datei im
Dateisystem verwiesen.Allerdings sollte man öffentliche Bezeichner aus
Gründen der Portabilität bevorzugen, da man so
nicht eine Kopie der DTD mit dem Dokument selber verteilen
muss, beziehungsweise da man, wenn man mit
SYSTEM arbeitet, nicht davon ausgehen kann,
dass die benötigte DTD auf anderen Systemen genau
unter dem gleichen Pfad verfügbar ist.Die Rückkehr zu SGMLAn einer früheren Stelle wurde erwähnt, dass
man SGML nur benötigt, falls man selbst eine DTD entwickeln
möchte. Genaugenommen ist das nicht 100%ig richtig. Einige
Teile der SGML-Syntax können auch in normalen Dokumenten
verwendet werden, falls dies gewünscht oder notwendig
ist.In diesem Falle muss dafür Sorge getragen werden,
dass ein SGML-Prozessor feststellen kann, dass ein
bestimmter Abschnitt des Inhalts SGML ist, das er verarbeiteten
muss.Solche SGML-Abschnitte werden mittels
<! ... > in Dokumenten
besonders gekennzeichnet. Alles, was sich zwischen diesen
Begrenzungen befindet, ist SGML, wie es auch in DTDs gefunden
werden kann.Demnach ist die DOCTYPE-Deklaration
ein gutes Beispiel für SGML, das in Dokumenten verwendet
werden muss…KommentareKommentare sind SGML-Konstrukte, die normalerweise nur
in DTDs gültig sind. Dennoch ist es, wie in
gezeigt,
möglich Fragmente mit SGML-Syntax in Dokumenten zu
verwenden.Zum Abgrenzen von SGML-Kommentaren wird ein doppelter
Bindestrich -- verwendet. Mit
seinem ersten Auftreten öffnet er einen Kommentar, mit
seinem zweiten schließt er ihn wieder.Beispiele für Kommentare in SGML<!-- Testkommentar -->
]]>Es sind zwei BindestricheEs gibt ein Problem mit den PostScript- oder
PDF-Versionen dieses Dokuments. Das obige Beispiel
zeigt vielleicht nur einen Bindestrich (-)
hinter <! und vor
>.Es müssen zwei Bindestriche
und nicht nur einer benutzt werden.
Die PostScript- und PDF-Versionen haben vielleicht
beide Bindestriche zu einem längeren Strich, dem
em-dash, zusammengefasst.Die HTML-, nur-Text und RTF-Versionen dieses Dokuments
sind nicht von diesem Problem betroffen.
]]>
Hat man früher schon Erfahrungen mit HTML gesammelt,
wird man vielleicht andere Regeln für den Gebrauch von
Kommentaren kennengelernt haben. Beispielsweise wird oft
angenommen, dass Kommentare mit <!--
begonnen und nur mit --> beendet
werden.Dies ist nicht der Fall. Viele
Webbrowser haben fehlerhafte HTML-Parser, die dies akzeptieren.
Die SGML-Parser, die vom FDP verwendet werden, halten sich
strenger an die SGML-Spezifikation und verwerfen Dokumente mit
solchen Fehlern.Fehlerhafte SGML-Kommentare]]>SGML-Parser würden die mittlere Zeile wie folgt
interpretieren:<!DIES IST NICHT TEIL EINES KOMMENTARS>Da es sich hierbei nicht um gültiges SGML handelt, kann
diese Zeile zur verwirrenden Fehlermeldungen führen.]]>Wie das Beispiel zeigt, sollten solche Kommentare
tunlichst vermieden werden.]]>Ein solcher Kommentar ist (ein wenig) besser, kann aber
jemanden, der mit SGML noch nicht so vertraut ist,
verwirren.Fingerübungen…Zur Übung können Sie einige Kommentare in
die Datei beispiel.sgml einfügen
und überprüfen, ob die Datei nun noch erfolgreich
von nsgmls validiert werden kann.Zu Testzwecken sollten Sie
auch noch ein paar fehlerhafte Kommentare hinzufügen
und sich die resultierenden Fehlermeldungen von
nsgmls ansehen.EntitätenEntitäten stellen einen Mechanismus dar, mit dem
einzelnen Dokumententeilen ein Name zugewiesen werden kann.
Findet ein SGML-Parser während des Parsens eine
Entität, ersetzt er diese durch den ihr zugewiesenen
Inhalt.Dadurch steht eine einfache Möglichkeit zur
Verfügung, mit der variabler Inhalt in SGML-Dokumenten
eingebunden werden kann. Zusätzlich sind Entitäten der
einzige Weg, über den eine Datei in eine andere Datei mit
SGML-Mitteln eingebunden werden kann.Es werden zwei Arten von Entitäten unterschieden:
Allgemeine Entitäten und
Parameterentitäten.Allgemeine EntitätenAllgemeine Entitäten können nur in
Dokumenten benutzt werden. Sie können zwar im
SGML-Kontext definiert aber dort nicht benutzt
werden. Vergleichen Sie dies mit
Im Parameterentitäten.Jede allgemeine Entität hat einen Namen, über
den sie angesprochen werden kann, um den von ihr
referenzierten Inhalt in ein Dokument einzubinden. Dafür
muss an der betreffenden Stelle der Namen der
Entität per
&entitaetenname;
einfügt werden. Eine Entität
current.version könnte beispielsweise
durch die aktuelle Versionsnummer eines Programms ersetzt
werden. Man könnte also schreiben:Die aktuelle Version des
Programms ist ¤t.version;.]]>Wenn sich die Versionsnummer ändert, muss
nur die Entität angepasst und anschließend
das Dokument neu erzeugt werden.Eine weitere Einsatzmöglichkeit für Allgemeine
Entitäten ist das Einbinden von Zeichen, die auf andere
Weise nicht in ein SGML-Dokument eingefügt werden
könnten. Ein Beispiel für solche Zeichen sind
< und &, die
normalerweise nicht direkt in
SGML-Dokumenten erlaubt sind. Stößt ein SGML-Parser
bei seiner Arbeit auf das Symbol <,
nimmt er an, dass der Anfang eines Start- oder Endtags
gefunden wurde. Bei einem & wird er
annehmen, den Anfang einer Entität gefunden zu haben.Wenn eines der beiden Zeichen benötigt wird, werden
daher die allgemeinen Entitäten <
und & verwendet.Allgemeine Entitäten können nur in einem
SGML-Kontext definiert werden. Üblich ist es, dies direkt
nach der DOCTYPE-Deklaration zu tun:Allgemeine Entitäten festlegen
]>]]>Wichtig ist an dieser Stelle, dass die
DOCTYPE-Deklaration durch eine eckige Klammer am Ende der
ersten Zeile erweitert wurde. Die beiden Entitäten
selber werden in den folgenden zwei Zeilen definiert, bevor
in der letzten Zeile die eckige Klammer und die
DOCTYPE-Deklaration wieder geschlossen werden.Die eckigen Klammern sind notwendig um festzulegen, dass
man die über DOCTYPE genannte DTD erweitern möchte.ParameterentitätenGenau wie Allgemeine
Entitäten werden Parameterentitäten
eingesetzt um wiederverwendbare Inhaltsteile mit Namen zu
versehen. Im Gegensatz zu Allgemeinen Entitäten
können sie aber nur innerhalb eines SGML-Kontextes
genutzt werden.Die Definition von Parameterentitäten erfolgt
ähnlich zu der Allgemeiner Entitäten. Sie werden
lediglich mit
%entitaetenname;
anstelle von
&entitaetenname;
referenziertEs wird das Prozentzeichen anstelle des
kaufmännischen Unds verwendet.. Wichtig ist, dass das
%-Zeichen zwischen
ENTITY und dem Entitätennamen ein Teil
der Definition ist.Parameterentitäten festlegen
]>]]>Fingerübungen…Fügen Sie in beispiel.sgml
eine Allgemeine Entität ein.
]>
Eine HTML-Beispieldatei
Das ist ein Absatz mit etwas Text.
Das ist ein Absatz mit anderem Text.
Dieser Absatz wird rechtsbündig
ausgerichtet.
Die aktuelle Version ist: &version;
]]>Validieren Sie diese Datei mit
nsgmlsÖffnen Sie nun beispiel.sgml
mit Ihrem Webbrowser. Es kann notwendig sein, dass
Sie die Datei vorher in beispiel.html
umbenennen müssen, damit die Datei auch als
HTML-Dokument erkannt wird.Nur wenn Sie einen sehr modernen Browser haben, werden
Sie sehen können, dass
&version; durch die Versionsnummer
ersetzt wurde. Leider haben die meisten Webbrowser
sehr einfache SGML-Parser, die nicht richtig mit SGML
umgehen könnenEigentlich ist das eine Schande. Man stelle sich
vor, welche Probleme und Hacks, wie beispielsweise
Server Side Includes, man an dieser Stelle hätte
vermeiden können..Die Lösung hierfür ist, das Dokument zu
normalisieren. Zu diesem Zweck liest
ein Normer
das Dokument ein und gibt anschließend semantisch
gleichwertiges SGML wieder aus, dass auf verschiedene
Arten transformiert worden sein kann. Eine dieser
möglichen Transformationen ist das Ersetzen der
Referenzen auf Entitäten mit dem von ihnen
präsentierten Inhalt.Versuchen Sie, die Beispieldatei mittels
sgmlnorm zu normalisieren:&prompt.user; sgmlnorm beispiel.sgml > beispiel.htmlAnschließend sollten Sie eine normalisierte
Version, dass heißt eine, bei der die
Entitäten gegen ihren Inhalt ersetzt wurden, in der
Datei beispiel.html finden. Diese
Datei können Sie sich nun mit Ihrem Browser
ansehen.Wenn Sie sich die Ausgaben von sgmlnorm
ansehen, werden Sie feststellen, dass
die DOCTYPE-Deklaration am Anfang der Datei nicht mehr
enthalten ist. Möchten Sie die Deklaration behalten,
muss sgmlnorm mit der Option
aufrufen werden:&prompt.user; sgmlnorm -d beispiel.sgml > beispiel.htmlDateien mit Entitäten einbindenSowohl Allgemeine als
auch Parameterentitäten
sind nützliche Helfer, wenn es darum geht, eine Datei in
eine andere einzubinden.Dateien mit Allgemeinen Entitäten einbindenAngenommen man hat ein Buch geschrieben, dessen Inhalt
auf mehrere Dateien aufgeteilt und mittels SGML
ausgezeichnet. Jedes Kapitel wurde dazu in einer eigenen Datei
(kapitel1.sgml,
kapitel2.sgml usw.) abgelegt und
über eine Datei buch.sgml sollen
alle physischen Dateien wieder mit der Hilfe von
Entitäten zu einem logischen Dokument
zusammengeführt werden.Damit der Inhalt der Dateien mit Entitäten
eingebunden werden kann, muss die Deklaration der
Entitäten das Schlüsselwort
SYSTEM enthalten. SGML-Parser werden so
angewiesen, den Inhalt der referenzierten Datei als Wert
für die jeweilige Entität zu nehmen.Dateien mit Allgemeinen Entitäten einbinden
]>
&kapitel.1;
&kapitel.2;
&kapitel.3;
]]>Wenn man Allgemeine Entitäten benutzt, um andere
Dateien einzubinden, dürfen diese Dateien
(kapitel1.sgml,
kapitel2.sgml, ...)
keine eigene DOCTYPE-Deklaration
haben.Dateien mit Parameterentitäten einbindenWie bereits festgestellt, können
Parameterentitäten nur innerhalb eines SGML-Kontexts
genutzt werden. Warum möchte man aber Dateien innerhalb
eines SGML-Kontexts einbinden? Der Vorteil liegt in der
Möglichkeit, die Deklaration von Entitäten in eine
andere Datei auslagern zu können, wodurch diese leichter
wiederverwendbar sind.Angenommen das Buch aus dem vorherigen Kapitel besteht aus
sehr vielen Kapiteln und diese sollen auch in einem anderen
Buch, aber in einer anderen Reihenfolge, verwendet werden.
Eine Möglichkeit wäre es, die dafür notwendigen
Entitäten am Anfang jedes Buches einzeln festzulegen
– was allerdings mit der Zeit unhandlich und
fehlerträchtig wird.Alternativ bietet sich dazu an, die Deklarationen in eine
separate Datei auszulagern und deren Inhalt anschließend
in beide Bücher über Parameterentitäten
einzubinden.Dateien mit Parameterentitäten einbindenZuerst werden die Entitäten in einer separaten
Datei namens kapitel.ent deklariert.
kapitel.ent enthält für
dieses Beispiel die folgenden Zeilen:
]]>Im zweiten Schritt fügt man in beide Bücher
eine Parameterentität ein, die den Inhalt von
kapitel.ent referenziert, und lädt
über diese dann die Deklarationen. Anschließend
können die so geladenen Entitäten wie gewohnt
genutzt werden.
%kapitel;
]>
&kapitel.1;
&kapitel.2;
&kapitel.3;
]]>Fingerübungen…Binden Sie Dateien über Allgemeine Entitäten einLegen Sie drei Dateien (absatz1.sgml,
absatz2.sgml und absatz3.sgml)
mit jeweils einer Zeile wie
Erster Absatz.]]>
an.Ändern Sie beispiel.sgml so
ab, dass sie wie folgt aussieht:
]>
Eine HTML-Beispieldatei
Die aktuelle Version dieses Dokuments ist &version;
&absatz1;
&absatz2;
&absatz3;
]]>Erzeugen Sie nun die Datei
beispiel.html, indem Sie
beispiel.sgml normalisieren:&prompt.user; sgmlnorm -d beispiel.sgml > beispiel.htmlÖffnen Sie beispiel.html
nun mit einem Webbrowser und vergewissern Sie sich,
dass der Inhalt der Dateien
absatzN.sgml
in beispiel.html übernommen
wurde.Binden Sie Dateien mit Parameterentitäten einHierfür müssen Sie die vorherige Fingerübung gemacht haben.Ändern Sie beispiel.sgml so
ab, dass es wie folgt aussieht: %entitaeten;
]>
Eine HTML-Beispieldatei
Die aktuelle Version dieses Dokuments ist &version;
&absatz1;
&absatz2;
&absatz3;
]]>Legen Sie eine weitere Datei entitaeten.sgml an,
die folgenden Inhalt hat:
]]>Erzeugen Sie die Datei
beispiel.html, indem Sie
beispiel.sgml normalisieren:&prompt.user; sgmlnorm -d beispiel.sgml > beispiel.htmlÖffnen Sie beispiel.html
nun mit einem Webbrowser und vergewissern Sie sich,
dass der Inhalt der Dateien
absatzN.sgml
in beispiel.html übernommen
wurde.Markierte BereicheSGML erlaubt es, dass bestimmte Dokumentabschnitte
während der Verarbeitung besonders behandelt werden sollen.
Diese Abschnitte werden als markierte Bereicheauf Englisch marked
sections
bezeichnet.Aufbau eines markierten Bereiches<![ SCHLÜSSELWORT [
Inhalt des markierten Bereiches
]]>Da es sich bei markierten Bereichen um SGML-Konstrukte
handelt, werden sie mit <! eingeleitet.
Der eigentliche Anfang des markierten Bereiches wird von der
folgenden eckigen Klammer bestimmt. Das darauf folgende
SCHLÜSSELWORT legt fest, wie der
markierte Inhalt durch einen SGML-Prozessor
während der Verarbeitung behandelt werden soll. Der
markierte Inhalt selbst beginnt erst nach der
zweiten eckigen Klammer und erstreckt sich bis zu den zwei
schließenden eckigen Klammern am Ende des Bereiches. Mit
Hilfe des > Zeichens wird der mit
<! begonnene SGML-Kontext wieder
verlassen.Schlüsselworte für markierte BereicheCDATA und RCDATADie Schlüsselworte CDATA und
RCDATA bestimmen das
Inhaltsmodell für markierte
Bereiche. Dadurch ist es möglich, vom Standardmodell
abzuweichen.Ein SGML-Prozessor muss während der
Verarbeitung eines Dokuments zu jedem Zeitpunkt wissen,
welches Inhaltsmodell gerade anzuwenden
ist.Was ist ein Inhaltsmodell? Kurz gesagt beschreibt das
Inhaltsmodell, welche Art von Inhalt der Parser zu erwarten
und wie er damit umzugehen hat.Bei CDATA und
RCDATA handelt es sich wahrscheinlich um
die nützlichsten Inhaltsmodelle.
CDATA steht für
Zeichendatenauf Englisch character
data. Trifft ein
Parser auf dieses Inhaltsmodell, wird er annehmen, dass
sich im zugehörigen Dokumentenbereich nur
gewöhnliche Zeichen befinden. Das
bedeutet, dass < und
& ihre besondere Bedeutung
verlieren und als einfache Zeichen behandelt werden.RCDATA steht für
Entitätenreferenzen und Zeichendatenauf
Englisch
Entity references and character
data. Für einen
Bereich mit diesem Inhaltsmodell, wird ein Parser davon
ausgehen, dass er sowohl Zeichen als auch
Enitätenreferenzen finden kann. <
verliert hier zwar auch seine besondere Bedeutung, doch
& wird weiterhin als Anfang einer
Entität interpretiert.Nützlich ist das CDATA-Modell
vor allem dann, wenn es darum geht Texte eins-zu-eins zu
übernehmen, in denen < und
& gehäuft
auftreten. Zwar kann man solche Texte überarbeiten und
jedes < durch ein
< und jedes
& durch ein &
ersetzen, doch es wird in den meisten Fällen
einfacher sein, für den betreffenden Text
CDATA als Inhaltsmodell festzulegen. Ein
SGML-Parser wird dann, sobald er auf
< oder & trifft,
diese als Zeichen in einem Text betrachten.Bei der Verwendung von CDATA und
RCDATA als Inhaltsmodell für
SGML-Beispiele, wie sie in diesem Dokument enthalten sind,
muss bedacht werden, dass der Inhalt eines
CDATA-Bereiches nicht validiert wird.
dass das SGML in diesen Bereichen gültig ist,
muss auf andere Weise sichergestellt werden. Denkbar ist
beispielsweise, es in einem separaten Dokument zu
erstellen, dort zu prüfen und erst dann in das
eigentliche Dokument einzufügen.CDATA als Inhaltsmodell für markierte Bereiche<para>Das ist ein Beispiel, wie man einen Text,
der viele <- und &-
Entitäten enthält, in ein Dokument einbinden kann.
Das Beispiel selbst, das sich innerhalb des markierten Bereiches befindet,
ist ein HTML-Fragment. Der diesen Text umschließende Tag, beginnend mit
mit para und endend mit /para, stammt aus der DocBook DTD.</para>
<programlisting>
<![ RCDATA [ Dieses Beispiel demonstriert die Verwendung von HTML-Elementen.
Da spitze Klammern so oft vorkommen, ist es einfacher, das
gesamte Beispiel als CDATA Abschnitt auszuweisen, als die
entsprechenden Entitäten zu nutzen.
Das ist ein Listenelement.
Das ist ein zweites Listenelement.
Das ist ein drittes Listenelement.
Und das hier, das ist das Ende des Beispiels.
]]>
]]>
</programlisting>Liest man die Quellen dieser Fibel, wird man
feststellen, dass diese Technik durchgängig
angewandt wurde.INCLUDE und
IGNOREDas Schlüsselwort INCLUDE legt
fest, dass der Inhalt des betreffenden Abschnittes
mitverarbeitet wird. Demgegenüber bestimmt
IGNORE, dass er ignoriert wird,
dass heißt, dass er bei der Verarbeitung
übergangen wird und in der Ausgabe nicht enthalten
ist.Anwendung von INCLUDE und
IGNORE in markierten
Abschnitten<![ INCLUDE [
Dieser Text wird verarbeitet und eingebunden.
]]>
<![ IGNORE [
Dieser Text wird weder verarbeitet noch eingebunden.
]]>Für sich alleine ist IGNORE als
Anweisung nicht besonders nützlich, da ein Bereich, der
von der Verarbeitung ausgenommen sein soll, auch
auskommentiert werden kann.Kombiniert man IGNORE hingegen mit
Parameterentitäten,
steht so ein Weg zur Verfügung, um dessen Anwendung
besser steuern zu können. Zwar können
Parameterentitäten nur in einem SGML-Kontext einsetzt
werden, da aber markierte Bereiche ebenfalls SGML-Konstrukte
sind, ist diese Einschränkung irrelevant.Soll beispielsweise ein und dasselbe Dokument in zwei
unterschiedlichen Varianten produziert werden, einer
gedruckten und einer digitalen, und soll nur die digitale
zusätzliche Informationen enthalten, kann dies mit
einem Trick erreicht werden.Man definiert eine Parameterentität, der man als
Wert die Zeichenkette INCLUDE zuweist und
deklariert den betreffenden Bereich, der nur in der
digitalen Variante erscheinen soll, als markierten Abschnitt
und setzt als Schlüsselwort die zuvor definierte
Parameterentität ein.Soll anstelle der digitalen die gedruckte Variante
produziert werden, muss lediglich der Entität
IGNORE als Wert zugewiesen und das
Ursprungsdokument erneut durch den SGML-Prozessor geschickt
werden.Kontrolle von markierten Bereichen über
Parameterentitäten<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!ENTITY % digitale.kopie "INCLUDE">
]]>
...
<![ %digitale.kopie [
Dieser Satz sollte nur in der digitalen Version enthalten sein.
]]>Bei der Produktion der gedruckten Variante muss
der Wert der Entität geändert werden.<!ENTITY % digitale.kopie "IGNORE">Bei der Verarbeitung wird als Schlüsselwort in
beiden Fällen der von
%digitale.kopie repräsentierte
Wert verwendet. Im ersten Fall wird der Inhalt des
markierten Bereichs mitverarbeitet, im zweiten Fall
nicht.Fingerübung…Legen Sie eine neue Datei
abschnitt.sgml an, die folgenden
Inhalt hat:<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [
<!ENTITY % text.ausgabe "INCLUDE">
]>
<html>
<head>
<title>Ein Beispiel mit markierten Abschnitten</title>
</head>
<body>
<p>Dieser Absatz <![ CDATA [beinhaltet viele <
Zeichen (< < < < <). Weshalb es einfacher ist,
ihn als CDATA Bereich auszuweisen. ]]></p>
<![ IGNORE [
<p>Dieser Absatz wird NICHT in der Ausgabe enthalten sein.</p>
]]>
<![ [
<p>Dieser Absatz wird in Abhängigkeit von %text.ausgabe
mitausgegeben.</p>
]]>
</body>
</html>Normalisieren Sie den Inhalt dieser Datei mit Hilfe
von sgmlnorm und sehen Sie sich das
Ergebnis an. Achten Sie dabei darauf, welche Absätze
enthalten beziehungsweise nicht enthalten sind und was aus
den CDATA-Bereichen geworden ist.Ändern Sie die Definition von
text.ausgabe so, dass es den
Wert IGNORE zugewiesen bekommt.
Verarbeiten Sie dann die Datei erneut mit
sgmlnorm und vergleichen die Ausgabe mit
der vom ersten sgmlnorm Lauf.SchlußbemerkungAus Platzgründen, und um der Verständlichkeit
Willen, wurden viele Gesichtspunkte nicht in aller Tiefe
beziehungsweise gar nicht besprochen. Trotzdem sollte in den
bisherigen Kapiteln genügend Wissen über SGML
vermittelt worden sein, um den Aufbau der Dokumentation des FDPs
zu verstehen.
diff --git a/de_DE.ISO8859-1/books/fdp-primer/stylesheets/chapter.sgml b/de_DE.ISO8859-1/books/fdp-primer/stylesheets/chapter.sgml
index 6b33b11db9..7ddf6a0b01 100644
--- a/de_DE.ISO8859-1/books/fdp-primer/stylesheets/chapter.sgml
+++ b/de_DE.ISO8859-1/books/fdp-primer/stylesheets/chapter.sgml
@@ -1,109 +1,109 @@
JohannKoisÜbersetzt von StylesheetsSGML legt nicht fest, wie ein Dokument am Monitor oder auf einem
Ausdruck dargestellt werden soll. Für diese Aufgabe wurden
spezielle Sprachen entwickelt, die Formatvorlagen (die sogenannten
Stylesheets) für die Darstellung
der Inhalte definieren. Zu diesen Sprachen gehören
beispielsweise DynaText, Panorama, SPICE, JSSS, FOSI, CSS, DSSSL
und andere mehr.DocBook verwendet in DSSSL geschriebene Stylesheets. HTML
verwendet hingegen in CSS geschriebene Stylesheets.DSSSLDas Documentation Project verwendet eine anpasste Version der
von Norm Walsh entwickelten modularen DocBook-Stylesheets, die
über den Port textproc/dsssl-docbook-modular
installiert werden können.Die FreeBSD-Modifikationen sind hingegen nicht in der
Ports-Sammlung enthalten, sondern befinden sich im
Quellcode-Repository des Documentation Projects in der Datei
doc/share/sgml/freebsd.dsl. Diese Datei
ist umfassend kommentiert und mit Beispielen versehen.
Dadurch können Sie einfach nachvollziehen, wie die
ursprünglichen Stylesheets vom FreeBSD Documentation
Project angepasst wurden.CSSCascading Stylesheets (CSS) erlauben es, Elementen eines
HTML-Dokuments Formatangaben (wie Schriftart, Größe,
Schriftfarbe und andere mehr) zuzuweisen, ohne das HTML-Dokument
mit diesen Informationen zu überfrachten.Die DocBook-DokumenteThe FreeBSD DSSSL-Stylesheets enthalten eine Referenz auf
ein Stylesheet namens docbook.css, das sich
im gleichen Verzeichnis wie die HTML-Dateien befindet. Diese
projektweite CSS-Datei wird automatisch von
doc/share/misc/docbook.css kopiert und
installiert, wenn DocBook-Dokumente nach HTML konvertiert
werden.
diff --git a/de_DE.ISO8859-1/books/fdp-primer/tools/chapter.sgml b/de_DE.ISO8859-1/books/fdp-primer/tools/chapter.sgml
index 5a2473acbd..6eea5f11f3 100644
--- a/de_DE.ISO8859-1/books/fdp-primer/tools/chapter.sgml
+++ b/de_DE.ISO8859-1/books/fdp-primer/tools/chapter.sgml
@@ -1,332 +1,332 @@
Die WerkzeugeInnerhalb des FDPs werden verschiedene Programme für die
Verwaltung der FreeBSD-Dokumentation, ihrer Transformation in
verschiede Formate und weitere Aufgaben eingesetzt. Wer an der
FreeBSD-Dokumentation mitarbeiten möchte, wird diese
Programme benötigen.Doch dies ist kein Grund zur Angst, da alle notwendigen
Programme als FreeBSD-Ports und fertige Pakete vorhanden sind,
wodurch sich die Installation drastisch vereinfacht.Allerdings müssen diese Programme installiert werden,
bevor alle Beispiele der folgenden Kapitel ausprobiert werden
können.
Wenn es möglich ist, sollte der Port
textproc/docproj
verwendet werdenDurch die Installation des Ports textproc/docproj kann die
Installation vereinfacht und eine Menge Zeit gespart werden. Bei
diesem Port handelt es sich um einen
Metaport, der selbst keine Programme oder
ähnliches installiert. Stattdessen enthält er eine
Vielzahl von Abhängigkeiten zu anderen Ports und setzt
deren korrekte Installation voraus. Durch seine Installation
sollten automatisch alle Pakete, die in
diesem Kapitel genannt werden, auf den Rechner geladen und dort
installiert werden.Ein nur unter bestimmten Umständen benötigter Port
ist das JadeTeX-Makro-Paket,
das seinerseits eine
&tex;-Installation voraussetzt. &tex; ist ein ziemlich großes
Programmpaket und sollte nur installiert werden, sofern
Zieldokumente im PostScript- oder PDF-Format generiert werden
sollen.Um den Platz und die Zeit für die Installation von
JadeTeX und &tex; zu sparen,
muß bei der Installation
angeben werden, ob JadeTeX (und damit auch &tex;) installiert
werden soll oder nicht.Daher sollte der docproj-Port entweder mit&prompt.root; make JADETEX=yes installoder mit&prompt.root; make JADETEX=no installinstalliert werden, je nachdem was gewünscht wird.
Alternativ können Sie auch direkt die Ports
textproc/docproj-jadetex oder
textproc/docproj-nojadetex
installieren. Die Variable JADETEX wird
von diesen Ports automatisch entsprechend gesetzt. Ohne
JadeTeX können Sie nur die Formate
HTML und ASCII erzeugen. Die Formate PostScript und PDF
erfordern &tex;.Notwendige WerkzeugeSoftwareDie folgenden Programme sind notwendig, um sinnvoll
an der FreeBSD-Dokumentation arbeiten und diese in andere
Formate wie HTML, reinen Text und RTF umwandeln zu
können. Sie müssen diese aber nicht seperat
installieren, da alle Programme automatisch durch den
Metaport textproc/docproj installiert
werden.Jade (textproc/jade)Eine DSSSL-Implementierung. Sie wird gebraucht, um
Dokumente in andere Formate wie HTML und &tex; zu
übersetzen.Tidy
(www/tidy)Ein Formatierer, mit dem man Teile der automatisch
generierten HTML-Dateien neuformatieren kann, um ihre
Lesbarkeit zu erhöhen.Links (www/links)Ein Textbrowser, der HTML-Dateien in einfache Textdateien
umwandeln kann.peps
(graphics/peps)Einige der Dokumente enthalten Grafiken, die nur im
EPS-Format vorliegen. Damit diese von dem meisten
Webbrowsern angezeigt werden können, müssen
sie nach PNG konvertiert werden.Die DTDs und die EntitätenDas FDP benutzt verschiedene DTDs und
Entitätensätze, die installiert sein müssen,
bevor mit der Arbeit an einem beliebigen Dokument begonnen
werden kann.HTML DTD (textproc/html)HTML ist die bevorzugte
Auszeichnungssprache des World Wide Web und wird
durchgängig für die FreeBSD-Webseite
genutzt.DocBook DTD (textproc/docbook)DocBook ist als Auszeichnungssprache für
technische Dokumentationen entwickelt worden. Die
gesamte FreeBSD-Dokumentation wird mittels DocBook
erstellt.ISO 8879-Entitäten
(textproc/iso8879)19 der ISO 8879:1986-Zeichensätze, die von
vielen DTDs benötigt werden. Darin enthalten sind
mathematische Symbole, zusätzliche Zeichen, die
für auf dem lateinischen beruhende Alphabete
benötigt werden sowie griechische Zeichen.Die StilvorlagenDie Stilvorlagen werden während der Transformation und
der Formatierung von Dokumenten, beispielsweise für die
Bildschirmdarstellung oder den Druck, benutzt.Modular DocBook Stylesheets (textproc/dsssl-docbook-modular)Die Modular DocBook Stylesheets werden
benötigt, wenn mittels DocBook erstellte Dokumente
in Formate wie HTML oder RTF konvertiert werden
sollen.Optionale WerkzeugeDie in diesem Kapitel genannten Programme müssen nicht
unbedingt installiert werden. Allerdings können sie die
Arbeit an der Dokumentation erleichtern und die Anzahl an
möglichen Ausgabeformaten erhöhen.SoftwareJadeTeX und
teTeX (print/jadetex und print/teTeX)Jade und
teTeX werden eingesetzt, um
DocBook-Dokumente nach DVI, Postscript und PDF zu
konvertieren. Hierfür müssen die
JadeTeX Makros installiert
sein.Ist es nicht geplant, die Dokumente in einem dieser
Formate zu erzeugen, wenn also HTML, Text und RTF
ausreichend sind, brauchen
JadeTeX und
teTeX nicht installiert zu
werden. Da die Installation von
teTeX insgesamt 30 MB
benötigt, kann so Zeit und Plattenplatz gespart
werden.Wird sich für die Installation von
JadeTeX und
teTeX entschieden,
muß teTeX
anschließend noch eingerichtet werden. Die Datei
print/jadetex/pkg-message
enthält detailierte Angaben zu den dafür
notwendigen Schritten.Emacs oder
XEmacs (editors/emacs oder editors/xemacs)Beide Texteditoren haben einen speziellen Modus zur
Bearbeitung von SGML-Dokumenten entsprechend den
Vorgaben einer SGML-DTD. Zusätzlich bieten sie
Funktionen an, mit denen sich der Tippaufwand reduzieren
und Fehlerwahrscheinlichkeit senken
läßt.Natürlich muß nicht mit einem dieser
Texteditoren gearbeitet werden; jeder andere Editor kann
dafür genausogut genutzt werden, doch vielleicht
wird die Arbeit durch sie als effektiver empfunden
werden.Sofern Sie Vorschläge haben, welche andere
Software für die Verarbeitung oder Bearbeitung von
SGML-Dokumenten in diese Liste mitaufgenommen werden sollte,
senden Sie diese bitte an &a.doceng;.