Die Fibel für neue Mitarbeiter des FreeBSD-Dokumentationsprojekts
		Weiter

Die Fibel für neue Mitarbeiter des FreeBSD-Dokumentationsprojekts

Version: 43126

2013-11-07 von gabor.

Zusammenfassung

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.

[ Split HTML / Single HTML ]

Inhaltsverzeichnis

Benutzungshinweise

1. Die Eingabeaufforderungen
2. Typographische Festlegungen
3. Anmerkungen, Tipps, wichtige Hinweise, Warnungen und Beispiel
4. 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.2. Optionale Werkzeuge

3. Die XML-Fibel

3.1. Überblick
3.2. Von Elementen, Tags und Attributen
3.3. Die DOCTYPE-Deklaration
3.4. Die Rückkehr zu SGML
3.5. Kommentare
3.6. Entitäten
3.7. Dateien mit Entitäten einbinden
3.8. Markierte Bereiche
3.9. Schlussbemerkung

4. XML-Dokumente erstellen

4.1. XHTML
4.2. Die DocBook DTD

5. Stylesheets

5.1. DSSSL
5.2. CSS

6. Verzeichnisstruktur unter doc/

6.1. doc/ als höchste Ebene
6.2. Die Verzeichnisse Sprache.Kodierung/
6.3. Dokumentenspezifische Informationen

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.3. Make-Includes des FreeBSD Documentation Projects

8. Die Webseite

8.1. Vorbereitung
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.2. Häufig verwendete Wörter

11. sgml-mode und Emacs

12. Weiterführende Quellen

12.1. Das FreeBSD-Dokumentationsprojekt
12.2. XML
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

Stichwortverzeichnis

Liste der 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 XHTML-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. Nicht-proportionale Schrift mit tt
4.15. <a href="..."> benutzen
4.16. Anwendung von <a id="...">
4.17. Auf einen Abschnitt eines anderen Dokumentes verweisen
4.18. Buchvorlage book mit bookinfo
4.19. Artikelvorlage article mit articleinfo
4.20. Ein einfaches Kapitel
4.21. Ein leeres Kapitel
4.22. Unterkapitel
4.23. Absatz mit para
4.24. blockquote
4.25. warning
4.26. itemizedlist, orderedlist und procedure
4.27. programlisting
4.28. Das co- und das calloutlist-Element
4.29. Tabellen mittels informaltable auszeichnen
4.30. Tabelle mit Attribut frame="none"
4.31. screen, prompt und userinput
4.32. Das Element emphasis
4.33. Richtig zitieren
4.34. Tasten, Maustasten und Tastenkombinationen
4.35. Anwendungen, Befehle und Optionen
4.36. Das Element filename
4.37. Portsnamen und das Element filename
4.38. Gerätenamen per devicename auszeichnen
4.39. role und hostid
4.40. Das Element username
4.41. maketarget und makevar
4.42. literal
4.43. Das Element replaceable
4.44. Das Element errorname
4.45. chapter und section mit dem Attribut id
4.46. Querverweise und das Element anchor
4.47. Einsatz von xref
4.48. link beutzen
4.49. 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