From owner-svn-doc-head@FreeBSD.ORG Fri Jun 5 16:21:16 2015 Return-Path: Delivered-To: svn-doc-head@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTPS id 6A832C73; Fri, 5 Jun 2015 16:21:16 +0000 (UTC) (envelope-from jkois@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id 55345199F; Fri, 5 Jun 2015 16:21:16 +0000 (UTC) (envelope-from jkois@FreeBSD.org) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.9/8.14.9) with ESMTP id t55GLG57094390; Fri, 5 Jun 2015 16:21:16 GMT (envelope-from jkois@FreeBSD.org) Received: (from jkois@localhost) by svn.freebsd.org (8.14.9/8.14.9/Submit) id t55GLEB8094381; Fri, 5 Jun 2015 16:21:14 GMT (envelope-from jkois@FreeBSD.org) Message-Id: <201506051621.t55GLEB8094381@svn.freebsd.org> X-Authentication-Warning: svn.freebsd.org: jkois set sender to jkois@FreeBSD.org using -f From: Johann Kois Date: Fri, 5 Jun 2015 16:21:14 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r46773 - in head/de_DE.ISO8859-1/books/fdp-primer: . doc-build docbook-markup editor-config overview sgml-primer working-copy xhtml-markup xml-primer X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.20 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 05 Jun 2015 16:21:16 -0000 Author: jkois Date: Fri Jun 5 16:21:14 2015 New Revision: 46773 URL: https://svnweb.freebsd.org/changeset/doc/46773 Log: MFde: Start to bring the German version of the dfp-primer to 2015: - add new chapters/remove 1 unused chapter/rename 1 chapter - fix Makefile - link to english versions if a german version does not exist yet. - Update multiple chapters so that the fdp-primer can be built. More updates will follow. de_DE.ISO8859-1/books/fdp-primer/Makefile r38826 -> r42410 de_DE.ISO8859-1/books/fdp-primer/book.sgml r38826 -> r42410 de_DE.ISO8859-1/books/fdp-primer/chapters.ent r38826 -> r42410 de_DE.ISO8859-1/books/fdp-primer/doc-build/chapter.xml r39631 -> r44068 de_DE.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml new file de_DE.ISO8859-1/books/fdp-primer/editor-config/chapter.xml new file de_DE.ISO8859-1/books/fdp-primer/overview/chapter.xml r41125 -> r46642 de_DE.ISO8859-1/books/fdp-primer/sgml-primer/chapter.xml moved to xml-primer/chapter.xml de_DE.ISO8859-1/books/fdp-primer/working-copy/chapter.xml new file de_DE.ISO8859-1/books/fdp-primer/xhtml-markup/chapter.xml new file Obtained from: The FreeBSD German Documentation Project Added: head/de_DE.ISO8859-1/books/fdp-primer/docbook-markup/ head/de_DE.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml (contents, props changed) head/de_DE.ISO8859-1/books/fdp-primer/editor-config/ head/de_DE.ISO8859-1/books/fdp-primer/editor-config/chapter.xml (contents, props changed) head/de_DE.ISO8859-1/books/fdp-primer/working-copy/ head/de_DE.ISO8859-1/books/fdp-primer/working-copy/chapter.xml (contents, props changed) head/de_DE.ISO8859-1/books/fdp-primer/xhtml-markup/ head/de_DE.ISO8859-1/books/fdp-primer/xhtml-markup/chapter.xml (contents, props changed) head/de_DE.ISO8859-1/books/fdp-primer/xml-primer/ head/de_DE.ISO8859-1/books/fdp-primer/xml-primer/chapter.xml - copied unchanged from r46759, head/de_DE.ISO8859-1/books/fdp-primer/sgml-primer/chapter.xml Deleted: head/de_DE.ISO8859-1/books/fdp-primer/sgml-primer/chapter.xml Modified: head/de_DE.ISO8859-1/books/fdp-primer/Makefile head/de_DE.ISO8859-1/books/fdp-primer/book.xml head/de_DE.ISO8859-1/books/fdp-primer/chapters.ent head/de_DE.ISO8859-1/books/fdp-primer/doc-build/chapter.xml head/de_DE.ISO8859-1/books/fdp-primer/overview/chapter.xml Modified: head/de_DE.ISO8859-1/books/fdp-primer/Makefile ============================================================================== --- head/de_DE.ISO8859-1/books/fdp-primer/Makefile Fri Jun 5 12:31:34 2015 (r46772) +++ head/de_DE.ISO8859-1/books/fdp-primer/Makefile Fri Jun 5 16:21:14 2015 (r46773) @@ -1,7 +1,7 @@ # # $FreeBSD$ # $FreeBSDde$ -# basiert auf: r38826 +# basiert auf: r42410 # # Build the FreeBSD Documentation Project Primer. # @@ -22,17 +22,19 @@ INSTALL_ONLY_COMPRESSED?= # XML content SRCS= book.xml SRCS+= overview/chapter.xml -SRCS+= psgml-mode/chapter.xml -SRCS+= see-also/chapter.xml -SRCS+= sgml-markup/chapter.xml -SRCS+= sgml-primer/chapter.xml -SRCS+= stylesheets/chapter.xml +SRCS+= tools/chapter.xml +SRCS+= working-copy/chapter.xml SRCS+= structure/chapter.xml SRCS+= doc-build/chapter.xml SRCS+= the-website/chapter.xml -SRCS+= tools/chapter.xml +SRCS+= xml-primer/chapter.xml +SRCS+= xhtml-markup/chapter.xml +SRCS+= docbook-markup/chapter.xml +SRCS+= stylesheets/chapter.xml SRCS+= translations/chapter.xml SRCS+= writing-style/chapter.xml +SRCS+= editor-config/chapter.xml +SRCS+= see-also/chapter.xml SRCS+= examples/appendix.xml Modified: head/de_DE.ISO8859-1/books/fdp-primer/book.xml ============================================================================== --- head/de_DE.ISO8859-1/books/fdp-primer/book.xml Fri Jun 5 12:31:34 2015 (r46772) +++ head/de_DE.ISO8859-1/books/fdp-primer/book.xml Fri Jun 5 16:21:14 2015 (r46773) @@ -34,21 +34,22 @@ POSSIBILITY OF SUCH DAMAGE. $FreeBSD$ - $FreeBSDde: de-docproj/books/fdp-primer/book.xml,v 1.24 2012/03/25 14:39:26 bcr Exp $ - basiert auf: r40986 + $FreeBSDde$ + basiert auf: r44895 --> Die Fibel für neue Mitarbeiter des FreeBSD-Dokumentationsprojekts - + + The FreeBSD Documentation Project - 1998-2012 + 1998-2014 The FreeBSD Documentation Project - 1998-2012 + 1998-2015 The FreeBSD German Documentation Project @@ -60,17 +61,18 @@ Vielen Dank für Ihr Interesse und Ihre Mitarbeit an - der FreeBSD-Dokumentation. Jeder Beitrag ist für uns sehr - wichtig. + der FreeBSD-Dokumentation. Wir freuen uns über jeden Beitrag. - 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. + Diese Fibel enthält die Informationen, die Sie für die + Mitarbeit am FreeBSD-Dokumentationsprojekt (auch als + FDP bekannt) benötigen. Diese reichen von + verpflichtender und optionaler Software bis hin zur Philosophie + des FreeBSD-Dokumentationsprojekts. Bitte beachten Sie, dass diese Fibel jederzeit unter Bearbeitung und noch - nicht vollständig ist. + nicht vollständig ist. Falls Sie einen Fehler finden, würden + wir uns freuen, wenn Sie uns darüber informieren. @@ -80,11 +82,11 @@ Die Eingabeaufforderungen - Die 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. + Die folgende Tabelle enthält die Eingabeaufforderung eines + normalen Benutzers sowie die des Superusers. Die in + diesem Buch verwendeten Beispiele benutzen die jeweilige + Eingabeaufforderung, um zu zeigen, als welcher Benutzer die + Beispiele ausgeführt werden. @@ -143,12 +145,19 @@ - Bildschirmein- und ausgaben + Bildschirmausgaben You have mail. + Bildschirmein- und ausgaben + + &prompt.user; date +"The time is %H:%M" +The time is 09:18 + + + Referenzen auf Hilfeseiten Mit &man.su.1; können Sie sich als ein anderer @@ -158,8 +167,8 @@ Benutzer- und Gruppennamen - Ich bin root, ich darf - das. + Ich bin root, + ich darf das. @@ -170,14 +179,13 @@ - Argumente auf der Kommandozeile, die durch - existierende Namen, Dateien oder Variablen ersetzt - werden müssen - - Dateien können Sie mit dem Befehl - rm - Dateiname - löschen. + Text, der vom Benutzer durch seine Eingaben ersetzt + werden muss + + Um die Hilfeseiten nach einem bestimmten Begriff zu + durchsuchen, geben Sie + man -k Suchbegriff + ein. @@ -252,15 +260,17 @@ &chap.overview; &chap.tools; - &chap.xml-primer; - &chap.xml-markup; - &chap.stylesheets; + &chap.working-copy; &chap.structure; &chap.doc-build; &chap.the-website; + &chap.xml-primer; + &chap.xhtml-markup; + &chap.docbook-markup; + &chap.stylesheets; &chap.translations; &chap.writing-style; - &chap.psgml-mode; + &chap.editor-config; &chap.see-also; &app.examples; Modified: head/de_DE.ISO8859-1/books/fdp-primer/chapters.ent ============================================================================== --- head/de_DE.ISO8859-1/books/fdp-primer/chapters.ent Fri Jun 5 12:31:34 2015 (r46772) +++ head/de_DE.ISO8859-1/books/fdp-primer/chapters.ent Fri Jun 5 16:21:14 2015 (r46773) @@ -9,20 +9,22 @@ $FreeBSD$ $FreeBSDde$ - basiert auf: r38826 + basiert auf: r42410 --> - - - + + + + + + - + - Modified: head/de_DE.ISO8859-1/books/fdp-primer/doc-build/chapter.xml ============================================================================== --- head/de_DE.ISO8859-1/books/fdp-primer/doc-build/chapter.xml Fri Jun 5 12:31:34 2015 (r46772) +++ head/de_DE.ISO8859-1/books/fdp-primer/doc-build/chapter.xml Fri Jun 5 16:21:14 2015 (r46773) @@ -30,7 +30,7 @@ $FreeBSD$ $FreeBSDde$ - basiert auf: r39631 + basiert auf: r44068 --> Die Erzeugung der Zieldokumente @@ -43,70 +43,37 @@ Dieses Kapitels erklärt detailliert, wie der Bau der Dokumentation organisiert - ist und wie Sie diesen Prozess beeinflussen - können. - - Nachdem Sie dieses Kapitel gelesen haben, werden Sie: - - - - Wissen, wie Sie (unter Verwendung der im Kapitel SGML-Werkzeuge beschriebenen Tools) - die FDP-Dokumentation selbst bauen können. - - - - In der Lage sein, sowohl die - make-Anweisungen der für - jedes Dokument benötigten Makefiles - als auch die Anweisungen der projektweiten Vorgaben der Datei - doc.project.mk zu lesen und zu - verstehen. - - - - Den Bau der Dokumentation über - make-Variablen und - make-Target anpassen - können. - - + ist und wie Sie diesen Prozess mit &man.make.1; + beeinflussen können. - Für den Bau der FreeBSD-Dokumentation benötigte + <title>Für den Bau der &os;-Dokumentation benötigte Werkzeuge - Zusätzlich zu den im Kapitel XML-Werkzeuge beschriebenen - Werkzeugen benötigen Sie noch folgende Programme: + Die folgende Werkzeuge werden benötigt, um die + FDP-Dokumente zu bauen und zu installieren. - Das wichtigste Werkzeug zum Bau der Dokumentation ist - make, genauer + Das wichtigste Werkzeug ist &man.make.1;, genauer Berkeley Make. Der Bau von Paketen erfolgt unter FreeBSD mit - pkg_create. Wenn Sie ein - anderes Betriebssystem als FreeBSD einsetzen, müssen - Sie entweder ohne Pakete auskommen oder den Quellcode - selbst kompilieren. + &man.pkg.create.1;. - gzip dient zur Erstellung - komprimierter Versionen der Dokumentation. Unterstützt - werden sowohl bzip2- als auch - zip-Archive. Wollen Sie Pakete - der Dokumentation erstellen, benötigen Sie auch noch - tar. + &man.gzip.1; dient zur Erstellung + komprimierter Versionen der Dokumentation. &man.bzip2.1; wird + ebenfalls unterstützt. Wollen Sie Pakete der Dokumentation + erstellen, benötigen Sie auch &man.tar.1;. - Mit install installieren - Sie in der Standardeinstellung die Dokumentation auf Ihrem - System. Es gibt aber auch alternative Wege, die Dokumentation - zu installieren. + Mit &man.install.1; installieren Sie die Dokumentation auf + Ihrem System. @@ -115,7 +82,7 @@ Die <filename>Makefile</filename>s des Dokumentationsbaums verstehen - Innerhalb des FreeBSD Documentation Projects gibt es drei + Innerhalb des &os; Documentation Projects gibt es drei verschiedene Arten von Makefiles: @@ -138,7 +105,7 @@ Make-Includes sind der "Klebstoff", der für den Bau der Dokumentation erforderlich ist. In der Regel heissen diese Dokumente - doc.xxx.mk. + doc.xxx.mk. @@ -157,11 +124,11 @@ DOC_PREFIX?= ${.CURDIR}/.. .include "${DOC_PREFIX}/share/mk/doc.project.mk" Die ersten vier nicht-leeren Zeilen definieren die - make-Variablen + &man.make.1;-Variablen SUBDIR, COMPAT_SYMLINK, und DOC_PREFIX. - Die erste SUBDIR-Anweisung weist + Die SUBDIR-Anweisung weist (ebenso wie die COMPAT_SYMLINK-Anweisung) einer Variable einen Wert zu und überschreibt dabei deren ursprünglichen Wert. @@ -196,13 +163,13 @@ DOC_PREFIX?= ${.CURDIR}/.. Wurzelverzeichnis des Quellcode-Baums des FreeBSD Documentation Projects an. Diese Vorgabe kann jederzeit durch einen eigenen Wert ersetzt werden. Bei .CURDIR handelt es - sich um eine in make eingebaute + sich um eine in &man.make.1; eingebaute Variable, die den Pfad des aktuellen Verzeichnisses enthält. Die letzte Zeile bindet doc.project.mk, - die zentrale, projektweite make-Datei - des FreeBSD Documentation Projects, in den Bau ein. Diese Datei + die zentrale, projektweite &man.make.1;-Datei + des &os; Documentation Projects, in den Bau ein. Diese Datei enthält den "Klebstoff", der die diversen Variablen in Anweisungen zum Bau der Dokumentation konvertiert. @@ -255,12 +222,6 @@ DOC_PREFIX?= ${.CURDIR}/../../.. wenn ausschließlich komprimierte Pakete der Dokumentation erstellt werden sollen. - - Die Zuweisung von Werten an verschiedene Variablen wurde - bereits im Abschnitt Unterverzeichnis-Makefiles - behandelt. - - Die Variable DOC_PREFIX und die verschiedenen Include-Anweisungen sollten Ihnen ebenfalls bereits vertraut sein. @@ -268,8 +229,7 @@ DOC_PREFIX?= ${.CURDIR}/../../.. - <application>Make</application>-Includes des FreeBSD - Documentation Projects + &man.make.1;-Includes des &os; Documentation Projects Diese Dateien lassen sich am besten verstehen, indem man sich deren Inhalt näher ansieht. Konkret handelt es sich dabei @@ -341,8 +301,8 @@ PRI_LANG?= en_US.ISO8859-1 Variable hat den Standardwert "US English". - PRI_LANG beeinflusst in keinster - Weise, welche Dokumente gebaut werden können oder + PRI_LANG beeinflusst nicht, + welche Dokumente gebaut werden können oder sollen. Diese Variable wird lediglich dazu verwendet, häufig verwendete Dokumente in das Wurzelverzeichnis der installierten Dokumentation zu verlinken. @@ -353,8 +313,7 @@ PRI_LANG?= en_US.ISO8859-1 Bedingungen Die Zeile .if defined(DOC) ist ein - Beispiel für eine - make-Bedingung, die (analog zum + Beispiel für eine &man.make.1;-Bedingung, die (analog zum Einsatz in anderen Programmen) festlegt, was geschehen soll, wenn eine Bedingung "wahr" oder "falsch" ist. defined ist eine Funktion, die @@ -415,8 +374,8 @@ PRI_LANG?= en_US.ISO8859-1 Abhängigkeiten (Dependencies) werden folgendermaßen definiert: - target - abhaengigkeit1 abhaengigkeit2 .... + target + abhaengigkeit1 abhaengigkeit2 .... Um target zu bauen, müssen Sie zuvor die angegebenen Abhängigkeiten bauen. Added: head/de_DE.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ head/de_DE.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml Fri Jun 5 16:21:14 2015 (r46773) @@ -0,0 +1,46 @@ + + + + + DocBook Markup (noch nicht übersetzt) + + Dieses Kapitel ist noch nicht übersetzt. Lesen Sie daher bitte + das Original in + englischer Sprache. Wenn Sie bei der Übersetzung + mithelfen wollen, schicken Sie bitte eine E-Mail + an &a.de.translators;. + Added: head/de_DE.ISO8859-1/books/fdp-primer/editor-config/chapter.xml ============================================================================== --- /dev/null 00:00:00 1970 (empty, because file is newly added) +++ head/de_DE.ISO8859-1/books/fdp-primer/editor-config/chapter.xml Fri Jun 5 16:21:14 2015 (r46773) @@ -0,0 +1,46 @@ + + + + + Editor Configuration (noch nicht übersetzt) + + Dieses Kapitel ist noch nicht übersetzt. Lesen Sie daher bitte + das Original in + englischer Sprache. Wenn Sie bei der Übersetzung + mithelfen wollen, schicken Sie bitte eine E-Mail + an &a.de.translators;. + Modified: head/de_DE.ISO8859-1/books/fdp-primer/overview/chapter.xml ============================================================================== --- head/de_DE.ISO8859-1/books/fdp-primer/overview/chapter.xml Fri Jun 5 12:31:34 2015 (r46772) +++ head/de_DE.ISO8859-1/books/fdp-primer/overview/chapter.xml Fri Jun 5 16:21:14 2015 (r46773) @@ -30,57 +30,46 @@ $FreeBSD$ $FreeBSDde$ - basiert auf: r41125 + basiert auf: r46642 --> Überblick - Herzlich 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. - - - Mitgliedschaft - - - Wie jedes Open-Source-Projekt, 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. + Herzlich Willkommen beim FreeBSD-Dokumentationsprojekt + (auch nur FDP genannt). Qualitativ hochwertige + Dokumentation ist sehr wichtig für den Erfolg von &os;. Jeder + Beitrag, der zu diesem Projekt geleistet wird, ist ungemein wertvoll. + + Dieses Dokument macht den Leser mit dem + FDP vertraut und erklärt, wie man + selbst Dokumente erstellt und einreicht und wie die verfügbaren + Werkzeuge effektiv beim Schreiben eingesetzt werden + können. - Nach dem Lesen der FDP-Fibel sollte man wissen: + Jeder kann zum FDP beitragen. Die einzige + Voraussetzung ist die Bereitschaft, helfen zu wollen. + + Nach dem Lesen dieses Dokuments werden Sie in der Lage sein, - welche Dokumente durch das FDP betreut werden, + die vom FDP betreuten Dokumente zu + erkennen, - wie man SGML-Dokumente liest und den SGML-Quellcode der - durch das FDP betreuten Dokumente versteht, + die benötigten Dokumentations-Werkzeuge und Dateien + zu installieren, - wie man selbst Änderungen an Dokumenten vornehmen - kann und + Änderungen an der Dokumentation vorzunehmen, - wie man Änderungen zur Begutachtung durch das FDP - einreichen kann. + Änderungen zur Begutachtung durch das FDP + einreichen können. @@ -89,269 +78,195 @@ Das FDP umfasst vier verschiedene Kategorien: - - - Manualpages - + - Die englischen Manualpages wurden nicht vom FDP - geschrieben, da sie ein Teil des Basissystems sind. Jedoch - können bzw. wurden bereits Teile von existierenden - Manualpages umformuliert, um sie verständlicher zu - machen oder um Fehler zu beheben. - - Für die Übersetzung der Manualpages des - Systems in die verschiedenen Sprachen sind die einzelnen - Übersetzergruppen verantwortlich. Alle dabei - entstandenen Übersetzungen gehören zum - FDP. + Handbook: Das Handbuch ist die + umfassende Quelle und Referenz für &os;-Benutzer. - - - - Die FAQ - Das Ziel der FAQ ist es, Fragen, die auf den - verschiedenen Mailinglisten 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. + FAQ: Eine Sammlung von kurzen + Fragen und Antworten zu Themen, die auf den + verschiedenen Mailinglisten und in auf &os; spezialisierten + Foren regelmäßig diskutiert werden. Lange und komplizierte + Antworten werden Sie hier nicht finden. - - - - Das Handbuch - Das Ziel des Handbuches ist es, die - umfassende Quelle und Referenz im Netz für - FreeBSD-Benutzer zu sein. + Manualpages: Die englischen + Manualpages werden normalerweise nicht vom FDP + geschrieben, da sie ein Teil des Basissystems sind. Jedoch + können bzw. wurden bereits Teile von existierenden + Manualpages umformuliert, um sie verständlicher zu + machen oder um Fehler zu beheben. - - - - Die Webseite - Die 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. + Die Webseite: Die Hauptpräsenz + von &os; im Internet, zu erreichen unter http://www.FreeBSD.org + oder einem der zahlreichen Spiegelserver. Für viele Menschen + ist sie der erste Kontakt mit &os;. - - + + + Übersetzer-Teams sind für die Übersetzung des Handbuchs und + der Webseite in verschiedene Sprachen verantwortlich. Manualpages + werden derzeit nicht übersetzt. Die Quellen für die FreeBSD-Website, das &os; Handbuch - sowie die &os; FAQ werden im doc/ - Subversion-Repository von &os; verwaltet, das Sie über + sowie die &os; FAQ werden im + Dokumentations-Repository von &os; verwaltet, das Sie über https://svn.FreeBSD.org/doc/ erreichen können. - Manualpages werden im src/ - Subversion-Repository von &os; verwaltet, das Sie über + Manualpages werden von &os; im einem eigenen + Quellcode-Repository verwaltet, das Sie über https://svn.FreeBSD.org/base/ erreichen können. - Das bedeutet, dass alle Änderungen an den - Dateien für jeden verfügbar sind und sich jeder - mit svn eine lokale Kopie der - Dokumentation anlegen kann. + Committ-Nachrichten des FDP + sind über svn abrufbar und werden + zusätzlich unter + &a.svn-doc-all.url; + archiviert. + + Beide Repositories sind auch über ein Web-Interface erreichbar: + sowie + . - Parallel zum FDP haben viele Menschen Anleitungen + Viele Menschen haben &os;-spezifische Anleitungen geschrieben und Webseiten mit Bezug zu FreeBSD erstellt. Einige davon werden im Subversion-Archiv verwaltet, sofern der Autor dem zugestimmt hat. In anderen Fällen hat sich der Autor entschlossen, seine Dokumentation außerhalb des zentralen - FreeBSD-Archivs zu verwalten. Das FDP bemüht sich, so - viele Verweise wie möglich auf solche Quellen + FreeBSD-Archivs zu verwalten. Das FDP bemüht sich, + so viele Verweise wie möglich auf solche Quellen bereitzustellen. - - Bevor es losgeht - - Zum Verständnis der folgenden Kapitel sollte folgendes - bereits bekannt sein: - - - - Wie eine aktuelle lokale Kopie des FreeBSD - Subversion-Repository mit Hilfe von - svn angelegt und gepflegt - werden kann. - - - - Wie neue Programme mit Hilfe des - FreeBSD-Portsystems oder mittels &man.pkg.add.1; - heruntergeladen und installiert werden. - - - - - Der Schnellstart + Schnellstart - Falls 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: + Dieser Abschnitt beschreibt, was Sie tun müssen, bevor + Sie Änderungen an der &os;-Dokumentation vornehmen können. + Abonnieren Sie die Mailingliste &a.doc;. Einige Mitglieder dieser + Mailingliste sind auch auf dem IRC-Kanal + #bsddocs auf EFnet erreichbar. Nehmen + Sie mit Ihnen Kontakt auf, wenn Sie Fragen oder Probleme bei + der Arbeit an der &os;-Dokumentation haben. - Zuerst muß der Metaport textproc/docproj auf dem - betreffenden Arbeitsrechner installiert werden. + + - &prompt.root; cd /usr/ports/textproc/docproj -&prompt.root; make JADETEX=no install + + Installieren Sie den Metaport + textproc/docproj als Port oder Paket, um + automatisch alle für die Arbeit an der Dokumentation benötigten + Werkzeuge zu installieren. - Laden Sie mit svn eine lokale - Kopie des FreeBSD-doc-Verzeichnisbaumes - herunter. - - Selbst wenn Sie nur über eine geringe Bandbreite - oder wenig freien Plattenplatz verfügen, müssen Sie - mindestens die Verzeichnisse head/share - sowie - head/language/share - auschecken, um an der Dokumentation arbeiten zu können. - Dazu ein Beispiel: - - &prompt.user; mkdir -p head/share -&prompt.user; mkdir -p head/en_US.ISO8859-1/share -&prompt.user; svn checkout https://svn0.us- -east.FreeBSD.org/doc/head/share head/share -&prompt.user; svn checkout https://svn0.us- -east.FreeBSD.org/doc/head/en_US.ISO8859-1/share head/en_US.ISO8859-1/share - - Für den Fall, dass ausreichend Platz auf der - Festplatte vorhanden ist, kann auch eine - vollständige Arbeitskopie des gesamten Subversion-Baumes - anlegt werden. - - &prompt.user; svn checkout https://svn0.us- -east.FreeBSD.org/doc/head head - - - svn0.us-east.FreeBSD.org - ist ein öffentlicher Server. Wählen Sie einen Mirror - in Ihrer Nähe und überprüfen Sie das Serverzertifikat - auf der Seite Subversion - mirror sites. - + Installieren Sie eine lokale Arbeitskopie der Dokumentation + von einem Spiegelserver des &os;-Repository nach + ~/doc (lesen Sie dazu + auch ). + + &prompt.user; svn checkout https://svn0.us-west.FreeBSD.org/doc/head ~/doc - Sollte 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; svn checkout https://svn0.us- -east.FreeBSD.org/doc/head/en_US.ISO8859-1/articles - - - - Anschließ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 head/en_US.ISO8859-1/articles -&prompt.user; svn export committers-guide vpn-w2k - - - - Bereits existierende 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 - head/en_US.ISO8859-1/books/faq: + Ihr Texteditor sollte für die Arbeit an der + &os;-Dokumentation wie folgt konfiguriert sein: + + + + Zeilenumbruch nach 70 Zeichen. + + + Tabstop auf 2 Zeichen. + + + 8 Leerzeichen sollen durch einen Tabstop ersetzt + werden. + + - &prompt.user; svn checkout https://svn0.us- -east.FreeBSD.org/doc/head/en_US.ISO8859-1/books/faq + Konfigurationen für einige häufig verwendete Editoren + finden Sie im . - Jetzt können die .xml Dateien - mit einem beliebigen Texteditor bearbeitet werden. + Aktualisieren Sie Ihre lokale Arbeitskopie: + + &prompt.user; svn up ~/doc - - 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 lint - - - - Soll 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 - head/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=html - - Soll es hingegen in den Formaten html - und txt erzeugt werden, - kann man entweder - &man.make.1; zweimal hintereinander aufrufen: + Bearbeiten Sie die Datei. Bevor Sie umfangreiche Änderungen + an einer Datei vornehmen, kündigen Sie die geplanten Änderungen + bitte auf der Mailingliste an. - &prompt.user; make FORMATS=html -&prompt.user; make FORMATS=txt + Eine Auflistung häufig verwendeter Tags und + Entities finden Sie in und + in . + - oder beide Formate mit einem Aufruf von &man.make.1; - erzeugen: + + Nachdem Sie Ihre Änderungen vorgenommen haben, prüfen + Sie diese auf potentielle Probleme: + + &prompt.user; igor -R filename.xml | less -RS - &prompt.user; make FORMATS="html txt" + Werden Fehler gemeldet, editieren Sie die Datei erneut. + Speichern Sie das Ergebnis und fühen Sie den Test erneut aus. + Wiederholen Sie dies solange, bis keine Fehler mehr gemeldet + werden. - Zum Schluss müssen die Änderungen an das - FDP mittels &man.send-pr.1; eingesandt werden. + Bauen Sie die Dokumentation immer, + bevor Sie Änderungen einreichen. Dazu führen Sie + make im Hauptverzeichnis des + Dokuments aus, dass Sie gerade bearbeiten. Um beispielsweise + die deutsche Version des &os;-Handbuchs als einzelne + HTML-Dateien zu bauen, führen Sie + make im Verzeichnis + de_DE.ISO8859-1/books/handbook/ aus. + Durch diesen Schritt wird sichergestellt, dass Ihre + Änderungen den Bau der Dokumentation nicht wegen eines + Fehlers abbrechen. + + + Wenn Ihre Änderungen abgeschlossen und erfolgreich + getestet wurden, erzeugen Sie eine + Differenzdatei-Datei mit + Ihren Änderungen: + + &prompt.user; cd ~/doc +&prompt.user; svn diff > bsdinstall.diff.txt + + Geben Sie der Differenzdatei einen aussagekräftigen Namen. + Im angegebenen Bespiel wurden Änderungen im Abschnitt + bsdinstall des Handbuchs vorgenommen. + + + + Reichen Sie Ihre Änderungen über das webbasierte Problembericht-Formular + ein. Geben Sie eine kurze Beschreibung in der Form + [patch] kurze Beschreibung des Problems + ein. Als Kategorie wählen Sie docs + und als Klasse doc-bug. Danach geben + Sie eine Beschreibung Ihrer Änderungen ein sowie eventuelle + weitere wichtige Punkte. Verwenden Sie danach den Button + [ Browse... ], um Ihre + Differenzdatei hochzuladen. + *** DIFF OUTPUT TRUNCATED AT 1000 LINES ***