Die Fibel für neue Mitarbeiter des FreeBSD-Dokumentationsprojekts

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.

[ einzelne Abschnitte / komplettes Dokument ]

Inhaltsverzeichnis

Benutzungshinweise

Die Eingabeaufforderungen
Typographische Festlegungen
Anmerkungen, Tips, wichtige Hinweise, Warnungen und Beispiel
Danksagungen

1. Überblick

1.1. Die FreeBSD-Dokumentationsreihe
1.2. Bevor es losgeht
1.3. Der Schnellstart

2. Die Werkzeuge

2.1. Notwendige Werkzeuge

2.1.1. Software
2.1.2. Die DTDs und die Entitäten
2.1.3. Die Stilvorlagen

2.2. Optionale Werkzeuge

2.2.1. Software

3. Die SGML-Fibel

3.1. Überblick

3.2. Von Elementen, Tags und Attributen

3.2.1. Was dafür getan werden muss;…

3.3. Die DOCTYPE-Deklaration

3.3.1. Formale Öffentliche Bezeichner
3.3.2. Alternativen zu Formalen Öffentlichen Bezeichnern

3.4. Die Rückkehr zu SGML

3.5. Kommentare

3.5.1. Fingerübungen…

3.6. Entitäten

3.6.1. Allgemeine Entitäten
3.6.2. Parameterentitäten
3.6.3. Fingerübungen…

3.7. Dateien mit Entitäten einbinden

3.7.1. Dateien mit Allgemeinen Entitäten einbinden
3.7.2. Dateien mit Parameterentitäten einbinden
3.7.3. Fingerübungen…

3.8. Markierte Bereiche

3.8.1. Schlüsselworte für markierte Bereiche
3.8.2. Fingerübung…

3.9. Schlußbemerkung

4. SGML-Dokumente erstellen

4.1. HTML

4.1.1. Formale Öffentliche Bezeichner
4.1.2. Die Elemente <head> und <body>
4.1.3. Blockelemente
4.1.4. Flußelemente
4.1.5. Links

4.2. Die DocBook DTD

4.2.1. Die FreeBSD-Erweiterungen
4.2.2. Formelle Öffentliche Bezeichner
4.2.3. Die Struktur von DocBook-Dokumenten
4.2.4. Blockelemente
4.2.5. Flußelemente
4.2.6. Bilder und Grafiken
4.2.7. Querverweise

5. Stylesheets

5.1. DSSSL

5.2. CSS

5.2.1. Die DocBook-Dokumente

6. Verzeichnisstruktur unter doc/

6.1. doc/ als höchste Ebene

6.2. Die Verzeichnisse Sprache.Kodierung/

6.3. Dokumentenspezifische Informationen

6.3.1. Das Handbuch

7. Die Erzeugung der Zieldokumente

7.1. Für den Bau der FreeBSD-Dokumentation benötigte Werkzeuge

7.2. Die Makefiles des Dokumentationsbaums verstehen

7.2.1. Unterverzeichnis-Makefiles
7.2.2. Dokument-Makefiles

7.3. Make-Includes des FreeBSD Documentation Projects

7.3.1. doc.project.mk
7.3.2. doc.subdir.mk

8. Die Webseite

8.1. Vorbereitung

8.1.1. svn verwenden

8.2. Die Webseiten bauen

8.3. Installieren der Webseiten auf Ihrem Server

8.4. Umgebungsvariablen

9. Übersetzungen

10. Der Schreibstil

10.1. Anleitungen für einen korrekten Schreibstil

10.1.1. Groß- und Kleinschreibung
10.1.2. Abkürzungen (Akronyme)
10.1.3. Einrückung
10.1.4. Die korrekte Schreibweise von Tags
10.1.5. Markup-Änderungen (white space changes)
10.1.6. Vermeiden von fehlerhaften Zeilenumbrüchen (Nutzung von non-breaking space)

10.2. Häufig verwendete Wörter

11. sgml-mode und Emacs

12. Weiterführende Quellen

12.1. Das FreeBSD-Dokumentationsprojekt
12.2. SGML
12.3. HTML
12.4. DocBook
12.5. Das Linux-Dokumentationsprojekt

A. Beispiele

A.1. DocBook-Buch (<book>)

A.2. DocBook-Artikel (<article>)

A.3. Ausgabeformate erzeugen

A.3.1. Benutzung von Jade

Beispiele
1. Ein Beispiel
3-1. Verwendung eines Elements (Start- und Endtag)
3-2. Verwendung eines Elements (nur Starttag)
3-3. Verschachtelte Elemente: <em>
3-4. Elemente mit Attributen nutzen
3-5. Attribute mit einfachen Anführungszeichen
3-6. .profile, für sh(1) und bash(1) Benutzer
3-7. .cshrc, für csh(1)- und tcsh(1)-Benutzer
3-8. Beispiele für Kommentare in SGML
3-9. Fehlerhafte SGML-Kommentare
3-10. Allgemeine Entitäten festlegen
3-11. Parameterentitäten festlegen
3-12. Dateien mit Allgemeinen Entitäten einbinden
3-13. Dateien mit Parameterentitäten einbinden
3-14. Aufbau eines markierten Bereiches
3-15. CDATA als Inhaltsmodell für markierte Bereiche
3-16. Anwendung von INCLUDE und IGNORE in markierten Abschnitten
3-17. Kontrolle von markierten Bereichen über Parameterentitäten
4-1. Die Struktur eines HTML-Dokumentes
4-2. <h1>, <h2>…
4-3. Falsche Verschachtelung von Überschriften
4-4. Absätze mit dem Element <p>
4-5. Blockzitat
4-6. Listen mit <ul> und <ol> erstellen
4-7. Definitionslisten mit <dl> erstellen
4-8. Vorformatierten Text mit <pre> erstellen
4-9. Einfache Tabelle mit <table>
4-10. Anwendung des Attributes rowspan
4-11. Anwendung des Attributes colspan
4-12. Gemeinsame Anwendung der Attrbute rowspan und colspan
4-13. Text mit <em> und <strong> hervorheben
4-14. Text mit <b> und <i> formatieren
4-15. Nicht-proportionale Schrift mit <tt>
4-16. Schriftgröße ändern mit <big>, <small> und <font>
4-17. <a href="..."> benutzen
4-18. Anwendung von <a name="...">
4-19. Auf einen Abschnitt eines anderen Dokumentes verweisen
4-20. Buchvorlage <book> mit <bookinfo>
4-21. Artikelvorlage <article> mit <articleinfo>
4-22. Ein einfaches Kapitel
4-23. Ein leeres Kapitel
4-24. Unterkapitel
4-25. Absatz mit <para>
4-26. <blockquote>
4-27. <warning>
4-28. <itemizedlist>, <orderedlist> und <procedure>
4-29. <programlisting>
4-30. Das <co>- und das <calloutlist>-Element
4-31. Tabellen mittels <informaltable> auszeichnen
4-32. Tabelle mit Attribut frame="none"
4-33. <screen>, <prompt> und <userinput>
4-34. Das Element <emphasis>
4-35. Richtig zitieren
4-36. Tasten, Maustasten und Tastenkombinationen
4-37. Anwendungen, Befehle und Optionen
4-38. Das Element <filename>
4-39. Portsnamen und das Element <filename>
4-40. Gerätenamen per <devicename> auszeichnen
4-41. role und <hostid>
4-42. Das Element <username>
4-43. <maketarget> und <makevar>
4-44. <literal>
4-45. Das Element <replaceable>
4-46. Das Element <errorname>
4-47. <chapter> und <section> mit dem Attribut id
4-48. Querverweise und das Element <anchor>
4-49. Einsatz von <xref>
4-50. <link> beutzen
4-51. Verweise mit <ulink>
A-1. Ein DocBook-Buch (<book>)
A-2. Ein DocBook-Artikel (<article>)
A-3. Ein DocBook-Dokument in eine einzelne HTML-Datei umwandeln
A-4. Ein DocBook-Dokument in mehrere kleine HTML-Dateien umwandeln
A-5. Ein DocBook-Dokument nach Postscript umwandeln
A-6. Eine PDF-Datei aus einem DocBook-Dokument erzeugen

		Weiter
		Benutzungshinweise