diff options
author | Sergio Carlavilla Delgado <carlavilla@FreeBSD.org> | 2021-01-25 23:31:29 +0000 |
---|---|---|
committer | Sergio Carlavilla Delgado <carlavilla@FreeBSD.org> | 2021-01-25 23:31:29 +0000 |
commit | 989d921f5d4ac8d8b7c831c13b8954ad1901be24 (patch) | |
tree | a5d768f9af4b55422fdf5b17064879ae1c7ce032 /website/content/de/docproj | |
parent | 0cff342f42461c5081b98bce7581f43df319e4f4 (diff) | |
download | doc-989d921f5d4ac8d8b7c831c13b8954ad1901be24.tar.gz doc-989d921f5d4ac8d8b7c831c13b8954ad1901be24.zip |
Diffstat (limited to 'website/content/de/docproj')
-rw-r--r-- | website/content/de/docproj/_index.adoc | 49 | ||||
-rw-r--r-- | website/content/de/docproj/doc-set.adoc | 22 | ||||
-rw-r--r-- | website/content/de/docproj/sgml.adoc | 80 | ||||
-rw-r--r-- | website/content/de/docproj/submitting.adoc | 83 | ||||
-rw-r--r-- | website/content/de/docproj/who.adoc | 18 |
5 files changed, 252 insertions, 0 deletions
diff --git a/website/content/de/docproj/_index.adoc b/website/content/de/docproj/_index.adoc new file mode 100644 index 0000000000..9689ee2b19 --- /dev/null +++ b/website/content/de/docproj/_index.adoc @@ -0,0 +1,49 @@ +--- +title: FreeBSD Documentation Project +sidenav: docs +--- + += FreeBSD Documentation Project + +== Überblick + +Sich mit einem neuen und komplexen Betriebssystem vertraut zu machen, ist immer eine schwierige Aufgabe, egal wie bunt die grafische Oberfläche auch sein mag. Dies gilt auch für FreeBSD. + +Zwar gibt es viele Bücher zu BSD Unix (und UNIX(R) im Allgemeinen), die aber in der Regel nicht die einzigartigen Fähigkeiten, Prozeduren oder Besonderheiten von FreeBSD abdecken. + +Für viele Benutzer ist FreeBSD der erste Kontakt mit einem Unix-artigem Betriebssystem, daher ist eine hochwertige, ausführliche Dokumentation von elementarer Bedeutung. + +Das FreeBSD Documentation Project wurde gegründet, um diese Lücke zu schließen. Dabei konzentriert es sich auf folgende Bereiche: + +. Mitglieder des Documentation Projects schreiben und verbessern Teile der Dokumentation, die danach in die offizielle _FreeBSD Dokumentation_ aufgenommen wird. +. Mitglieder des Documentation Projects diskutieren und implementieren die Formatierung und Organisation der offiziellen _FreeBSD Documentation_. + +[width="100%",cols="100%",] +|=== +a| +[.center] +=== https://www.FreeBSD.org/docproj/current/[Aktuelle Projekte] + +Im Rahmen des Documentation Projects wird _ständig_ an verschiedenen Projekten gearbeitet. Lesen Sie sich bitte diese Liste durch und überlegen Sie sich, ob *Sie* eines dieser Projekte unterstützen könnten. + +|=== + +== link:who/[Wer wir sind und wie Sie uns helfen können] + +Diese Seite beschreibt die Organisation des Documentation Projects und erklärt auch, wie Sie dieses Projekt unterstützen können. + +== link:doc-set/[Die FreeBSD-Dokumentation] + +Auf dieser Seite wird der Aufbau der FreeBSD-Dokumentation beschrieben. Außerdem wird näher auf die Arbeit des Documentation Projects eingegangen. + +== link:sgml/[SGML und das Documentation Project] + +Die FreeBSD-Dokumentation wird in SGML geschrieben. Diese Seite erklärt, wie SGML bei der Arbeit an der Dokumentation eingesetzt wird und liefert Ihnen auch einige Links zu weiteren SGML-Ressourcen. + +== link:submitting/[Beiträge einreichen] + +Das Schreiben und Einreichen von Dokumentationen ist der beste Weg, um Teil des Documentation Projects zu werden und die Benutzung von FreeBSD zu vereinfachen. Diese Seite erklärt Ihnen, wie Sie Ihre Beiträge am besten einreichen, damit diese möglichst rasch geprüft werden können. + +== https://www.FreeBSD.org/docproj/translations/[Übersetzungen] + +Übersetzungen der FreeBSD-Dokumentation, der Internetseiten, des Handbuchs, der FAQ, der Manualpages und anderer Dokumente. diff --git a/website/content/de/docproj/doc-set.adoc b/website/content/de/docproj/doc-set.adoc new file mode 100644 index 0000000000..cd6b7fadad --- /dev/null +++ b/website/content/de/docproj/doc-set.adoc @@ -0,0 +1,22 @@ +--- +title: "FreeBSD Documentation Project: Die FreeBSD-Dokumentation" +sidenav: docs +--- + += FreeBSD Documentation Project: Die FreeBSD-Dokumentation + +Die FreeBSD-Dokumentation wird in die folgenden drei Kategorien eingeteilt: + +. http://www.FreeBSD.org/cgi/man.cgi[*Die Manualpages*] ++ +Mit Ausnahme des japanischen Teams (die die Manualpages in Ihre Sprache übersetzen) beschäftigt sich das Documentation Project kaum mit den Manualpages, da diese Teil des Basissystems sind. Es spricht allerdings nichts dagegen, die Manualpages auch in andere Sprachen zu übersetzen. ++ +Die Manualpages sind zwar ein elementarer Bestandteil der Dokumentation, da sie aber in der Regel eng mit einem bestimmten Bereich von FreeBSD verbunden sind, ist in der Regel die Person, die an diesem Bereich arbeitet, am besten geeignet, die entsprechende Manualpage zu erstellen. +. link:../../docs/books/[*Die Bücher*] ++ +Ein großer Teil der Dokumentation hat "Buchlänge" oder ist auf dem Weg dahin. Die bekanntesten Beispiele dazu sind die FreeBSD FAQ sowie das FreeBSD Handbuch. +. link:../../docs/books/#ARTICLES[*Die Artikel*] ++ +Weiters verfügt FreeBSD über zahlreiche kürzere Dokumentationen (die als Artikel bezeichnet werden) - ähnlich den Tutorien oder HOWTOs anderer Projekte. + +link:..[Startseite des FreeBSD Documentation Projects] diff --git a/website/content/de/docproj/sgml.adoc b/website/content/de/docproj/sgml.adoc new file mode 100644 index 0000000000..0560fd44ad --- /dev/null +++ b/website/content/de/docproj/sgml.adoc @@ -0,0 +1,80 @@ +--- +title: "FreeBSD Documentation Project: SGML" +sidenav: docs +--- + +include::shared/de/urls.adoc[] + += FreeBSD Documentation Project: SGML + +Das Documentation Project verwendet SGML zur Erstellung der Dokumentation. + +SGML steht für **S**tandard **G**eneralized **M**arkup **L**anguage. + +Kurz gesagt (SGML-Puristen mögen dies verzeihen) handelt es sich bei SGML um eine Sprache zum Schreiben anderer Sprachen. + +Wahrscheinlich haben Sie SGML bereits verwendet, ohne dass Sie sich dessen bewusst sind. So verfügt beispielsweise HTML (die Sprache, in der zahlreiche Internetseiten geschrieben sind) über eine formale Beschreibung, die in SGML verfasst wurde. Wenn Sie HTML verwenden, verwenden Sie aber trotzdem *kein* SGML, sondern eine Sprache, die in SGML definiert wurde. + +Es gibt zahlreiche, in SGML definierte Sprachen. HTML ist dabei lediglich eine unter vielen Sprachen. Eine weitere bekannte Sprache ist "DocBook". Diese Sprache wurde speziell dafür entwickelt, technische Dokumentationen zu schreiben. Dazu verfügt sie über zahlreiche Tags (also Markierungen der Form `<Tag Inhalt>`), um diese Dokumentationen für deren anschließende Formatierung zu beschreiben. Das FreeBSD Documentation Project hat DocBook an seine Bedürfnisse angepasst und unter anderem einige neue Elemente definiert, um die Sprache präziser zu machen. + +Sehen Sie sich dazu den folgenden (in HTML geschriebenen) Absatz an. Der Inhalt ist Nebensache, konzentrieren Sie sich auf die verwendeten Tags: + +.... + <p>The system's passwords are stored in <tt>/etc/passwd</tt>. To edit + this file you should use <b><tt>vipw</tt></b>. However, if you just + want to add a new user you can use <b><tt>adduser</tt></b>.</p> +.... + +Der gleiche (diesmal in DocBook geschriebene) Absatz sieht folgendermaßen aus: + +.... + <para>The system's passwords are stored in + <filename>/etc/passwd</filename>. To edit this file you should use + <command>vipw</command>. However, if you just want to add a new user + you can use <command>adduser</command>.</para> +.... + +Wie Sie sehen, ist DocBook "ausdrucksstärker" als HTML. In HTML wird der Dateiname als "in Schreibenmaschinenschrift darzustellen" markiert. In DocBook wird der Dateiname hingegen als "filename" markiert. Es wird allerdings nicht angegeben, wie "filename" dargestellt werden soll. + +Diese Vorgehensweise hat mehrere Vorteile: + +* Sie ist eindeutig und konsistent. ++ +Sie verlieren keine Zeit mit Überlegungen wie "Hm, ich muss einen Dateinamen darstellen, nehme ich dafür 'tt', 'b', oder besser doch 'em'?" ++ +Stattdessen verwenden Sie einfach das der jeweiligen Situation angepasste Tag. ++ +Die Konvertierung von DocBook in andere Formate wie HTML oder PostScript(R) stellt sicher, dass alle Dateinamen innerhalb des Dokuments gleich dargestellt werden. +* Sie müssen sich keine Gedanken mehr über die Darstellung Ihres Dokuments machen, sondern können sich auf den Inhalt konzentrieren. +* Da die Dokumentation nicht an ein bestimmtes Format gebunden ist, kann die gleiche Dokumentation in viele verschiedene Formate (wie normalen Text, HTML, PostScript, RTF, PDF und andere mehr) konvertiert werden. +* Die Dokumentation ist 'intelligenter' und erlaubt dadurch auch anspruchsvollere Dinge, wie die automatische Erstellung eines Index mit allen innerhalb des Dokuments verwendeten Befehlen. + +Mit DocBook erstellte Dokumente haben eine gewisse Ähnlichkeit mit den von Microsoft(R) Word bekannten Dokumentvorlagen, sind aber sehr viel mächtiger. + +Diese besonderen Fähigkeiten haben aber ihren Preis: + +* Da es sehr viele Tags gibt, dauert es länger, bis Sie alle kennen werden und optimal einsetzen können. ++ +Um die Lernkurve zu verflachen, ist es sehr hilfreich, sich Dokumentationen anderer Autoren anzusehen, um zu sehen, wie diese ähnliche Informationen beschreiben. +* Der Konvertierungsprozess ist relativ komplex. + +== Sie können kein DocBook. Können Sie das Documentation Project trotzdem unterstützen? + +Natürlich. Jede Dokumentation ist besser als keine Dokumentation. Es ist kein großes Problem, wenn Ihr Beitrag nicht als DocBook formatiert ist. + +link:../submitting/[Reichen] Sie Ihren Beitrag einfach ein. Jemand aus dem Documentation Project wird Ihren Beitrag übernehmen, ihn in DocBook formatieren und committen. Vielleicht erhalten Sie den formatierten Text sogar zurück. Dann können Sie einen "Vorher-/Nachher-Vergleich" durchführen und so etwas mehr über DocBook lernen. + +Da Ihr Beitrag in diesem Fall aber zuerst in DocBook formatiert werden muss, verlangsamt sich der Konvertierungsprozess etwas, es kann daher bis zu einigen Tagen dauern, bis Ihr Beitrag committet wird. + +== Gibt es weitere Informationen zu SGML und DocBook? + +Lesen Sie zuerst den link:{fdp-primer}[*Documentation Project Primer*]. Dieser enthält eine ausführliche Beschreibung aller Dinge, die Sie zur Arbeit an der FreeBSD Dokumentation benötigen. Er ist in mehrere Abschnitte unterteilt, kann aber auch als link:{fdp-primer}[*eine einzelne große Seite*] aufgerufen werden. + +http://www.oasis-open.org/cover/sgml-xml.html[*http://www.oasis-open.org/cover/sgml-xml.html*]:: +Die offiziellen SGML/XML-Internetseiten mit zahlreichen Links zu SGML-Ressourcen. +http://www-sul.stanford.edu/tools/tutorials/html2.0/gentle.html[*http://www-sul.stanford.edu/tools/tutorials/html2.0/gentle.html*]:: +"The Gentle Introduction to SGML" ist für alle empfehlenswert, die mehr über SGML (insbesondere aus der Sicht eines Einsteigers) wissen wollen. +http://www.oasis-open.org/docbook/[*http://www.oasis-open.org/docbook/*]:: +Die offizielle DocBook DTD wird von OASIS gewartet. Diese Seiten richten sich besonders an Personen, die mit SGML bereits vertraut sind und nun DocBook lernen wollen. + +link:..[Startseite des FreeBSD Documentation Projects] diff --git a/website/content/de/docproj/submitting.adoc b/website/content/de/docproj/submitting.adoc new file mode 100644 index 0000000000..161d23305e --- /dev/null +++ b/website/content/de/docproj/submitting.adoc @@ -0,0 +1,83 @@ +--- +title: "FreeBSD Documentation Project: Beiträge einreichen" +sidenav: docs +--- + +include::shared/de/urls.adoc[] + +== Ich habe eine neue Anleitung geschrieben. Wie kann ich diese einreichen? + +Danke, dass Sie unsere Dokumentation erweitern wollen. + +Sie müssen Ihre Dokumentation dem Documentation Project zur Verfügung stellen, damit Ihr Beitrag geprüft werden kann. Dazu hinterlegen Sie das Dokument beispielsweise auf einem FTP- oder Webserver. + +Danach schicken Sie eine E-Mail an die Mailingliste `FreeBSD-doc`, in der Sie Ihren Beitrag kurz beschreiben und vor allem mitteilen, wo Sie ihn hinterlegt habt. Außerdem sollten Sie die Mitglieder des FreeBSD Documentation Projects um die Prüfung Ihres Beitrags bitten. + +Ist es Ihnen nicht möglich, Ihren Beitrag auf einem Server zu hinterlegen, können Sie ihn auch direkt an die Mailingliste `FreeBSD-doc` schicken. Denken Sie aber daran, dass Ihre E-Mail in diesem Fall nur "normalen" Text enthalten darf. + +Falls Ihr Beitrag auch für andere Mailinglisten interessant ist, sollte Sie Ihre E-Mail als Kopie auch an andere Mailinglisten schicken und um Kommentare bitten. Handelt es sich bei Ihrem Beitrag etwa um eine Anleitung zur Aktualisierung des Quellcodes mit CVSup, so ist dies auch für die Leser der Mailinglisten `FreeBSD-current` und `FreeBSD-stable` interessant. + +Nachdem Ihr Beitrag geprüft wurde und Sie eventuelle Verbesserungsvorschläge in Ihr Dokument aufgenommen haben, können Sie Ihren Beitrag einreichen. + +Dazu verpacken Sie Ihr Dokument in ein tar-Archiv. Besteht Ihr Dokument beispielsweise aus den drei Dateien `eins`, `zwei`, und `drei`, die alle in das gemeinsame tar-Archiv `doc.tar` aufgenommen werden sollen, verwenden Sie folgenden Befehl: + +.... + % tar cf doc.tar eins zwei drei +.... + +Danach komprimieren Sie das tar-Archiv: + +.... + % gzip -9 doc.tar +.... + +Als Ergebnis erhalten Sie die komprimierte Datei `doc.tar.gz`. + +Als letzten Schritt der Vorbereitung kodieren Sie diese Datei noch, damit sie von allen E-Mail-Programmen korrekt erkannt und verarbeitet wird: + +.... + % uuencode doc.tar.gz doc.tar.gz > doc.uue +.... + +Nun können Sie das FreeBSD Documentation Project über Ihren Beitrag informieren. Der korrekte Weg dafür ist der Einsatz von *send-pr*, das auf Ihrem System bereits installiert sein sollte. Alternativ können Sie auch das https://bugs.freebsd.org/bugzilla/enter_bug.cgi[Internetformular zum Einreichen von Problemberichten] verwenden. + +Nur so kann sichergestellt werden, dass Ihr Beitrag auch korrekt erfasst wird. Wenn Sie einen Problembericht (PR) einreichen, erhält dieser eine eindeutige Nummer. Ein Committer wird diesen PR übernehmen und Ihrem Beitrag weiterbearbeiten. Weitere Informationen zu diesem Thema finden Sie im Artikel link:{problem-reports}[Writing FreeBSD Problem Reports]. + +Die Bedienung von *send-pr* ist relativ einfach. Die Aufgabe des Programms ist es, eine speziell formatierte E-Mail an eine bestimmte E-Mail-Adresse zu schicken. Wenn Sie *send-pr* aufrufen, wird automatisch Ihr Standardeditor (beispielsweise *vi* oder *emacs*) mit einer von Ihnen auszufüllenden Vorlage geladen, die auch einige zusätzliche Anweisungen enthält. + +Achten Sie beim Ausfüllen des Formulars darauf, dass Sie im Feld "Category" den Wert "docs" eintragen und dass im Feld Class" der Eintrag "change-request" steht. Im "Body"-Bereich fügen Sie die vorhin erstellte `.uue`-Datei ein. + +Wenn Sie den Editor beenden, wird der PR als E-Mail an die korrekte Adresse geschickt. Kurz darauf erhalten Sie (wiederum als E-Mail) eine Bestätigung, die insbesondere die Ihrem PR zugewiesene eindeutige Nummer enthält. Diese PR-Nummer können Sie dazu verwenden, den aktuellen Status Ihres Beitrags zu prüfen. + +== Ich habe ein bereits vorhandenes Dokument verbessert. Wie kann ich meine Korrekturen einreichen? + +Danke, dass Sie unsere Dokumentation verbessern wollen. + +In diesem Fall müssen Sie eine spezielle Datei, eine sogenannte Differenz (_diff_) erstellen. Diese Differenz enthält alle von Ihnen durchgeführten Änderungen. Dadurch wird es den Committern erleichtert, Ihre Änderungen zu finden und zu prüfen. Sie haben den Vorteil, dass Sie nicht umständlich erklären müssen, was Sie geändert haben. Nichtsdestotrotz sollten Sie natürlich begründen können, warum Sie diese Änderung für nötig halten. + +Um eine Differenz (einen "Diff") zu erstellen, gehen Sie wie folgt vor: + +. Erstellen Sie eine Kopie der zu ändernden Datei (in diesem Fall `foo.xml`): do ++ +.... + % cp foo.xml foo.xml.old +.... +. Nun führen Sie Ihre Änderungen in foo.xml durch. ++ +.... + % vi foo.xml + ... tipp tipp tipp ... + + ... Änderungen testen, Tippfehler suchen und korrigieren ... +.... +. Danach erzeugen Sie die Differenz: ++ +.... + % diff -u foo.xml.old foo.xml > foo.diff +.... ++ +Mit diesem Befehl werden die beiden Dateien verglichen und die Unterschiede in die Datei `foo.diff` geschrieben. + +Als letzten Schritt senden Sie die erstellte Differenz `foo.diff` an das Documentation Project. Dazu erstellen Sie wiederum einen PR. Im Unterschied zur Erstellung einer neuen Anleitung, enthält der "Body"-Bereich nun aber die von Ihnen erstellte Differenz `foo.diff`. + +link:..[Startseite des FreeBSD Documentation Projects] diff --git a/website/content/de/docproj/who.adoc b/website/content/de/docproj/who.adoc new file mode 100644 index 0000000000..4dceaa694d --- /dev/null +++ b/website/content/de/docproj/who.adoc @@ -0,0 +1,18 @@ +--- +title: "FreeBSD Documentation Project: Wer sind wir?" +sidenav: docs +--- + +include::shared/de/urls.adoc[] + += FreeBSD Documentation Project: Wer sind wir? + +Das Documentation Project besteht aus einem losen Zusammenschluss verschiedener Personen, die alle die Mailingliste FreeBSD-doc@FreeBSD.org abbonniert haben. + +Einige von uns dürfen Änderungen direkt in den FreeBSD Dokumentationsbaum einbringen (_committen_). Eine vollständige Liste aller link:{contributors}#staff-committers[FreeBSD-Entwickler mit Commit-Privilegien] sowie eine Liste mit den link:../administration/#t-doceng[leitenden Committern des FreeBSD Documentation Projects] sind auf den Internetseiten des FreeBSD Projects verfügbar. + +Mitarbeiter ohne Commit-Privilegien können natürlich trotzdem an der Dokumentation arbeiten und ihre Beiträge einreichen. Wenn deren Beiträge gemäß den Anleitungen auf der Seite link:../submitting[Beiträge einreichen] eingereicht wurden, werden diese von einem oder mehreren Committern geprüft und danach in die FreeBSD-Dokumentation aufgenommen. + +Wenn Sie das FreeBSD Documentation Project unterstützen wollen (worüber wir uns sehr freuen würden), müssen Sie lediglich die Mailingliste abbonnieren und Ihre Beiträge einreichen. Schon sind Sie ein Mitglied des Documentation Projects. + +link:..[Startseite des FreeBSD Documentation Projects] |