diff options
author | Johann Kois <jkois@FreeBSD.org> | 2004-12-18 12:02:47 +0000 |
---|---|---|
committer | Johann Kois <jkois@FreeBSD.org> | 2004-12-18 12:02:47 +0000 |
commit | 5b04ca43572a3f03c11f19e1c26d956f2225ad87 (patch) | |
tree | 31042f4600f0dd1289ae7f380cd66b8b7d6409da /de_DE.ISO8859-1/books | |
parent | ec76c98c51546c6a545f0324fe51d73b085c8113 (diff) |
Notes
Diffstat (limited to 'de_DE.ISO8859-1/books')
7 files changed, 1306 insertions, 242 deletions
diff --git a/de_DE.ISO8859-1/books/fdp-primer/book.sgml b/de_DE.ISO8859-1/books/fdp-primer/book.sgml index 4fecc363e1..722cddb0be 100644 --- a/de_DE.ISO8859-1/books/fdp-primer/book.sgml +++ b/de_DE.ISO8859-1/books/fdp-primer/book.sgml @@ -28,32 +28,16 @@ POSSIBILITY OF SUCH DAMAGE. $FreeBSD$ - $FreeBSDde: de-docproj/books/fdp-primer/book.sgml,v 1.9 2004/06/06 15:06:38 mheinen Exp $ - basiert auf: 1.22 + $FreeBSDde: de-docproj/books/fdp-primer/book.sgml,v 1.12 2004/10/30 15:00:03 jkois Exp $ + basiert auf: 1.25 --> <!DOCTYPE book PUBLIC "-//FreeBSD//DTD DocBook V4.1-Based Extension//EN" [ - -<!ENTITY % authors PUBLIC "-//FreeBSD//ENTITIES DocBook Author Entities//EN"> -%authors; - -<!ENTITY % translators PUBLIC "-//FreeBSD//ENTITIES DocBook Translator Entities//DE"> -%translators; - -<!ENTITY % mailing-lists PUBLIC "-//FreeBSD//ENTITIES DocBook Mailing List Entities//DE"> -%mailing-lists; - -<!ENTITY % man PUBLIC "-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN"> -%man; - -<!ENTITY % urls PUBLIC "-//FreeBSD//ENTITIES DocBook URL Entities//EN"> -%urls; - +<!ENTITY % books.ent PUBLIC "-//FreeBSD//ENTITIES DocBook FreeBSD Books Entity Set//DE"> +%books.ent; <!ENTITY % chapters SYSTEM "chapters.ent"> %chapters; - <!ENTITY % not.published "INCLUDE"> -<!-- ENTITY index SYSTEM "index.sgml" --> ]> <book lang="de"> @@ -61,13 +45,7 @@ <title>Die Fibel für neue Mitarbeiter des FreeBSD-Dokumentationsprojekts</title> - <author> - <firstname>Nik</firstname> - <surname>Clayton</surname> - <affiliation> - <address><email>nik@FreeBSD.org</email></address> - </affiliation> - </author> + <corpauthor>The FreeBSD German Documentation Project</corpauthor> <copyright> <year>1998</year> @@ -77,50 +55,14 @@ <year>2002</year> <year>2003</year> <year>2004</year> - <holder role="mailto:nik@FreeBSD.org">Nik Clayton</holder> + <holder>The FreeBSD German Documentation Project</holder> </copyright> <pubdate role="rcs">$FreeBSD$</pubdate> <releaseinfo>$FreeBSD$</releaseinfo> - <legalnotice> - <para>Redistribution and use in source (SGML DocBook) and 'compiled' - forms (SGML, HTML, PDF, PostScript, RTF and so forth) with or without - modification, are permitted provided that the following conditions are - met:</para> - - <orderedlist> - <listitem> - <para>Redistributions of source code (SGML DocBook) must retain the - above copyright notice, this list of conditions and the following - disclaimer as the first lines of this file unmodified.</para> - </listitem> - - <listitem> - <para>Redistributions in compiled form (transformed to other DTDs, - converted to PDF, PostScript, RTF and other formats) must - reproduce the above copyright notice, this list of conditions and - the following disclaimer in the documentation and/or other - materials provided with the distribution.</para> - </listitem> - </orderedlist> - - <important> - <para>THIS DOCUMENTATION IS PROVIDED BY NIK CLAYTON "AS IS" AND ANY - EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR - PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NIK CLAYTON BE LIABLE FOR - ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF - SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR - BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF - LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING - NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS - DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH - DAMAGE.</para> - </important> - </legalnotice> + &bookinfo.legalnotice; <abstract> <para>Vielen Dank für Ihr Interesse und Ihre Mitarbeit an @@ -132,9 +74,9 @@ behandelt, was Sie wissen müssen, wenn Sie sich am FreeBSD-Dokumentationsprojekt beteiligen wollen.</para> - <para>Bitte beachten Sie, daß diese Fibel - <emphasis>ständig</emphasis> unter Bearbeitung und noch - nicht vollständig ist. Die noch nicht abgeschlossenen + <para>Bitte beachten Sie, dass diese Fibel + <emphasis>jederzeit</emphasis> unter Bearbeitung und noch + nicht vollständig ist. Die noch nicht übersetzten Kapitel sind mit einem <literal>*</literal> vor der Kapitelüberschrift gekennzeichnet.</para> @@ -152,8 +94,8 @@ <para>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 + diesem Buch vorkommenden Beispiele benutzen die jeweilige + Eingabeaufforderung, um zu zeigen, unter welchem Benutzer die Beispiele ausgeführt werden sollten.</para> <informaltable frame="none"> @@ -208,7 +150,7 @@ <row> <entry>Eingaben und die dazugehörige - Computerausgabe.</entry> + Ausgabe auf dem Bildschirm.</entry> <entry><screen>&prompt.user; <userinput>su</userinput> Paßwort:</screen></entry> </row> @@ -219,7 +161,7 @@ Paßwort:</screen></entry> <entry>Mit <citerefentry> <refentrytitle>su</refentrytitle> <manvolnum>1</manvolnum> - </citerefentry> können Sie sich als anderer + </citerefentry> können Sie sich als ein anderer Benutzer anmelden.</entry> </row> @@ -263,7 +205,7 @@ Paßwort:</screen></entry> <title>Anmerkungen, Tips, wichtige Hinweise, Warnungen und Beispiel</title> - <para>An einigen Stellen innerhalb dieses Buchs werden + <para>An einigen Stellen innerhalb dieses Buchs werden wichtige oder nützliche Hinweise gegeben, die besonders hervorgehoben sind. Hier ein kurzer Überblick über die verwendeten Darstellungen.</para> 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 002116a572..e029aeaed5 100644 --- a/de_DE.ISO8859-1/books/fdp-primer/overview/chapter.sgml +++ b/de_DE.ISO8859-1/books/fdp-primer/overview/chapter.sgml @@ -28,7 +28,7 @@ POSSIBILITY OF SUCH DAMAGE. $FreeBSD$ - $FreeBSDde: de-docproj/books/fdp-primer/overview/chapter.sgml,v 1.10 2004/08/30 22:39:59 mheinen Exp $ + $FreeBSDde: de-docproj/books/fdp-primer/overview/chapter.sgml,v 1.11 2004/10/30 15:13:55 jkois Exp $ basiert auf: 1.21 --> @@ -141,7 +141,7 @@ </variablelist> <para>Jede dieser vier Kategorien wird im FreeBSD-CVS-Baum - verwaltet. Das bedeutet, daß alle Änderungen an den + verwaltet. Das bedeutet, dass alle Änderungen an den Dateien für jeden verfügbar sind und jeder sich mittels eines Programms wie <application>CVSup</application> oder <application>CTM</application> eine lokale Kopie der @@ -217,7 +217,7 @@ <screen>&prompt.user; <userinput>cvs checkout doc/share</userinput> &prompt.user; <userinput>cvs checkout doc/de_DE.ISO8859-1/share</userinput></screen> - <para>Für den Fall, daß ausreichend Platz auf der + <para>Für den Fall, dass ausreichend Platz auf der Festplatte vorhanden ist, kann auch eine eine vollständige Arbeitskopie des gesamten CVS-Baumes anlegt werden.</para> @@ -281,7 +281,7 @@ <para>Danach ist <command>make</command> mit dem Ziel <maketarget>lint</maketarget> aufzurufen, um das gesamte Dokument auf Auszeichnungsfehler hin zu untersuchen, ohne - das zeitaufwendige Transformationen vorgenommen + dass zeitaufwändige Transformationen vorgenommen werden.</para> <screen>&prompt.user; <userinput>make lint</userinput></screen> @@ -303,7 +303,7 @@ unterstützten Formate befindet sich am Anfang der Datei <filename>doc/share/mk/doc.docbook.mk</filename>. Bei der Verwendung dieser Variable ist es wichtig, darauf zu achten, - daß die Angabe der gewünschten Formate in + dass die Angabe der gewünschten Formate in Anführungszeichen eingeschlossen wird, sofern mehr als nur ein Format gleichzeitig erstellt werden soll.</para> diff --git a/de_DE.ISO8859-1/books/fdp-primer/psgml-mode/chapter.sgml b/de_DE.ISO8859-1/books/fdp-primer/psgml-mode/chapter.sgml index 42b3e680c1..0941bdeaef 100644 --- a/de_DE.ISO8859-1/books/fdp-primer/psgml-mode/chapter.sgml +++ b/de_DE.ISO8859-1/books/fdp-primer/psgml-mode/chapter.sgml @@ -28,7 +28,7 @@ POSSIBILITY OF SUCH DAMAGE. $FreeBSD$ - $FreeBSDde: de-docproj/books/fdp-primer/psgml-mode/chapter.sgml,v 1.6 2003/12/23 01:41:01 mheinen Exp $ + $FreeBSDde: de-docproj/books/fdp-primer/psgml-mode/chapter.sgml,v 1.7 2004/10/30 15:46:26 jkois Exp $ basiert auf: 1.7 @@ -45,7 +45,7 @@ <para>Neuere <application>Emacs</application>- und <application>XEmacs</application>-Versionen verfügen über ein nützliches Lisp-Paket namens PSGML. PSGML ist - ein sogenannter <foreignphrase>Majormode</foreignphrase>, der + ein so genannter <foreignphrase>Majormode</foreignphrase>, der Funktionen speziell für den Umgang mit SGML-Dateien, -Elementen und deren Attributen bereit stellt. Emacs aktiviert PSGML automatisch, wenn eine Datei mit der Endung @@ -70,7 +70,7 @@ enthalten muß, werden diese ebenfalls miteingefügt.</para> - <!--? "man" muß weg! Oliver Fischer --> + <!--? "man" muss weg! Oliver Fischer --> <para>Falls man unsicher ist, wie der Name des gewünschten Elements lautet oder welche Elemente an der aktuellen Position erlaubt sind, können mittels der @@ -128,7 +128,7 @@ <para>Ruft die Funktion <literal>sgml-fill-element</literal> auf. Diese Funktion formatiert<footnote> <para>Formatieren bedeutet in diesem Zusammenhang, - daß die Funktion versucht, soviel Zeichen wie + dass die Funktion versucht, soviel Zeichen wie möglich in einer Zeile unterzubringen. Die Stelle, bis zu der gefüllt und dann der Zeilemumbruch erfolgt, ist konfigurierbar.</para> 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 89ae2592fd..c2e2979cdf 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 @@ -28,8 +28,8 @@ POSSIBILITY OF SUCH DAMAGE. $FreeBSD$ - $FreeBSDde: de-docproj/books/fdp-primer/sgml-primer/chapter.sgml,v 1.10 2004/04/12 17:51:14 mheinen Exp $ - basiert auf: 1.38 + $FreeBSDde: de-docproj/books/fdp-primer/sgml-primer/chapter.sgml,v 1.13 2004/10/30 17:24:58 jkois Exp $ + basiert auf: 1.41 --> <!--? @@ -56,44 +56,33 @@ Oliver Fischer <title>Überblick</title> <para>In den guten alten Zeiten war der Umgang mit - <quote>elektronischem</quote> Text einfach. Man mußte + <quote>elektronischem</quote> 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.</para> - - <!--? Diesen Satz noch einmal Wort fuer Wort untersuchen!!! Oliver Fischer --> - <para>Unleugbar ist, daß das nicht genug war. Von einem - machinenlesbaren Text wird erwartet, daß er auch von - Maschinen gelesen und vernünftig verarbeitet werden kann. - Einige Stellen sollen hervorgehoben werden, andere sollen in ein + <para>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 <quote>schreibmaschinenähnlichen</quote> Schrift auf dem - Bildschirm dargestellt werden, der Ausdruck jedoch soll in - <quote>Schrägschrift</quote> oder einer von hundert anderen - möglichen Darstellungsformen erfolgen.</para> - - <!--<para>Inevitably, this was not enough. Once you have text in a - machine-usable format, you expect machines to be able to use it and - manipulate it intelligently. You would like to indicate that certain - phrases should be emphasised, or added to a glossary, or be hyperlinks. - You might want filenames to be shown in a <quote>typewriter</quote> style - font for viewing on screen, but as <quote>italics</quote> when printed, - or any of a myriad of other options for presentation.</para>--> - - <para>Anfänglich gab es die Hoffnung, daß die + Bildschirm dargestellt werden, der Ausdruck soll jedoch in + <quote>Schrägschrift</quote> oder in einer beliebigen anderen + Darstellungsform erfolgen.</para> + + <para>Anfänglich gab es die Hoffnung, dass die Künstliche Intelligenz (KI) helfen würde, dieses Ziel - zu erreichen. Der Computer sollte den Text lesen und - selbstständig in der Lage sein können, wichtige - Formulierungen, Dateinamen, Benutzereingaben oder Beispiele zu - erkennen. Unglücklicherweise verlief die Entwicklung in der - Wirklichkeit nicht wie gewünscht und Computer bedürfen - etwas Unterstützung, bevor sie Texte vernünftig - verarbeiten können.</para> - - <para>Genauer gesagt, man muß ihnen sagen, was was ist. Sehen + 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.</para> + + <para>Genauer gesagt, man muss ihnen sagen, was was ist. Sehen wir Menschen uns folgende Zeilen an: <blockquote> @@ -115,16 +104,16 @@ Oliver Fischer <para>Der Begriff <quote>Auszeichnung<footnote> <para>Im angelsächischschen Sprachraum wird von <quote>markup</quote> - gesprochen.</para></footnote></quote> bedeutet, daß + gesprochen.</para></footnote></quote> 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 - daß Programme die Auszeichnung erkennen können und + 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, daß er durch sie abgelenkt + verbergen, um zu vermeiden, dass er durch sie abgelenkt wird.</para> <!--<para><quote>Markup</quote> is commonly used to describe <quote>adding @@ -138,7 +127,7 @@ Oliver Fischer <para>Die durch die Auszeichnungselemente im Textdokument zusätzlich abgelegten Informationen erhöhen den Wert - des Dokuments. Allerdings muß diese Arbeit in den meisten + 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 @@ -156,13 +145,11 @@ Oliver Fischer <para>Die Auszeichnungselemente sind deutlich vom eigentlichen Inhalt zu unterscheiden.</para> - <para>Leicht ist zu erkennen, daß die Einführung von - Auszeichnungselementen es nötig macht, irgendwo festzulegen - was die einzelnen Auszeichungselemente bedeuten und wie sie zu - interpretieren sind. Letztendlich wird ein ganzes Bündel - von Auszeichnungselementen benötigt, die selbst eine eigene - Auszeichnungssprache darstellen, derer man sich bedienen kann, - wenn man seine Dokumente schreibt.</para> + <para>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.</para> <para>Natürlich kann es keine universelle Auszeichnungssprache geben und eine einzige mag nicht @@ -215,7 +202,7 @@ Oliver Fischer <note> <para>Das Validieren eines SGML-Dokuments gegen eine DTD überprüft lediglich die korrekte Syntax des - Dokuments, daß heißt, ob nur gültige + Dokuments, dass heißt, ob nur gültige Auszeichnungselemente verwendet wurden und ihre Reihenfolge stimmt. Dabei wird <emphasis>nicht</emphasis> geprüft, ob die Elemente der DTD <emphasis>sinngemäß</emphasis> @@ -226,7 +213,7 @@ Oliver Fischer Semantik.</para> </note> - <para>Es ist anzunehmen, daß, wenn man selber vor hat + <para>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 @@ -261,7 +248,7 @@ Oliver Fischer --> <para>Von einem Dokument, unabhängig, ob es sich um eine einzelne Webseite oder ein langes Buch handelt, wird angenommen, - daß es einen wie auch immer gearteten Inhalt hat. Dieser + dass es einen wie auch immer gearteten Inhalt hat. Dieser läßt sich selbst wiederum in Teilelemente aufspalten, die ebenso zerlegbar sind. Durch die Aufnahme von Auszeichnungselementen in einen Text, werden diese einzelnen @@ -279,8 +266,8 @@ Oliver Fischer <para>Nimmt man zum Beispiel ein typisches Buch, so kann man es auf der obersten Ebene als ein Ganzes, als ein Element betrachten. Dieses <quote>Buch</quote>-Element enthält nun - sicherlich Kapitel, die selbst zu Recht als Elemente bezeichnet - werden können. Jedes einzelne Kapitel enthält weitere + 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 @@ -297,19 +284,19 @@ Oliver Fischer unterteilt in Absätze, Fußnoten, Namen und so weiter und so weiter.</para> - <para>Anzumerken ist an dieser Stelle, daß das eben gesagte + <para>Anzumerken ist an dieser Stelle, dass das eben gesagte ohne weiteres auf jeden Inhaltstyp angewandt werden kann, auch - ohne daß von <acronym>SGML</acronym> die Rede ist. Man + ohne dass von <acronym>SGML</acronym> 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.</para> <para>Leider gibt es keinen elektronischen Stift, um das zu tun. - Deshalb muß ein anderer Weg gewählt werden, um zu + 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 sogenannte + und DocBook werden dafür so genannte <emphasis>Tags</emphasis> eingesetzt.</para> <para>Mit einem solchen Tag wird eindeutig festgelegt, wo ein @@ -330,7 +317,7 @@ Oliver Fischer <title>Verwendung eines Elements (Start- und Endtag)</title> <para>HTML kennt das Element <literal>p</literal>, um - festzulegen, daß ein bestimmter abgegrenzter Bereich + festzulegen, dass ein bestimmter abgegrenzter Bereich einen Absatz darstellt. Dieses Element hat sowohl einen Start- als auch einen Endtag.</para> @@ -346,9 +333,9 @@ Oliver Fischer Oliver Fischer --> <para>Elemente müssen nicht notwendigerweise einen Endtag - haben. Ebenso ist es nicht notwendig, daß Elemente einen + haben. Ebenso ist es nicht notwendig, dass Elemente einen Inhalt haben. Beispielsweise kann in HTML-Dokumenten mittels - eines speziellen Elements festgelegt werden, daß eine + 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.</para> @@ -357,7 +344,7 @@ Oliver Fischer <title>Verwendung eines Elements (nur Starttag)</title> <para>In HTML kann man mit dem Element <sgmltag>hr</sgmltag> - festlegen, daß an einer bestimmten Stelle eine + festlegen, dass an einer bestimmten Stelle eine horizontale Linie angezeigt werden soll. Da dieses Element keinen Inhalt umschließt, hat es nur einen Starttag.</para> @@ -474,10 +461,10 @@ Oliver Fischer von allen Programmen gefunden werden können.</para> <sect2> - <title>Was dafür getan werden muß…</title> + <title>Was dafür getan werden muss;…</title> <para>Damit die Beispiele dieser Fibel ausgeführt werden - können, ist es notwendig, daß einige Programme auf + können, ist es notwendig, dass einige Programme auf dem Rechner installiert sind und das eine Umgebungsvariable korrekt gesetzt wird.</para> @@ -493,7 +480,7 @@ Oliver Fischer </step> <step> - <para>Anschließend muß in den Shellkonfigurationsdateien die + <para>Anschließend muss in den Shellkonfigurationsdateien die Variable <envar>SGML_CATALOG_FILES</envar> <footnote><simpara>Sofern man nicht an der deutschen Dokumentation arbeitet, müssen die @@ -537,11 +524,10 @@ setenv SGML_CATALOG_FILES /usr/doc/en_US.ISO8859-1/share/sgml/catalog:$SGML_CATA setenv SGML_CATALOG_FILES /usr/doc/de_DE.ISO8859-1/share/sgml/catalog:$SGML_CATALOG_FILES</programlisting> </example> - <para>Damit die Änderungen wirksam werden, muß - man sich abmelden und anschließend wieder anmelden - – oder die obigen Anweisungen direkt in der Shell - ausführen und so die Umgebungsvariable - setzten.</para> + <para>Damit 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.</para> </step> </procedure> @@ -575,26 +561,26 @@ setenv SGML_CATALOG_FILES /usr/doc/de_DE.ISO8859-1/share/sgml/catalog:$SGML_CATA mit Hilfe eines SGML-Parsers validiert werden.</para> <para>Bestandteil von <filename role="package">textproc/docproj</filename> - ist &man.nsgmls.1; - ein <link - linkend="sgml-primer-validating">validierender Parser</link>. - &man.nsgmls.1; liest ein Dokument entsprechend einer SGML-DTD + ist <command>nsgmls</command> - ein <link + linkend="sgml-primer-validating">validierender Parser</link>. + <command>nsgmls</command> 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.</para> - <para>Wird &man.nsgmls.1; mit der Option <option>-s</option> + <para>Wird <command>nsgmls</command> mit der Option <option>-s</option> aufgerufen, werden nur Fehlermeldungen ausgegeben. Dadurch kann leicht geprüft werden, ob ein Dokument gültig ist oder nicht.</para> - <para>So prüft man mit &man.nsgmls.1;, ob die neuangelegte + <para>So prüft man mit <command>nsgmls</command>, ob die neuangelegte Beispieldatei gültig ist:</para> <screen>&prompt.user; <userinput>nsgmls -s beispiel.sgml</userinput></screen> <para>Sofern das Beispiel korrekt abgetippt wurde, wird sich - &man.nsgmls.1; ohne jegliche Ausgabe beenden. Das bedeutet, - daß das Dokument erfolgreich validiert werden konnte + <command>nsgmls</command> ohne jegliche Ausgabe beenden. Das bedeutet, + dass das Dokument erfolgreich validiert werden konnte und somit gültig ist.</para> </step> @@ -607,9 +593,9 @@ setenv SGML_CATALOG_FILES /usr/doc/de_DE.ISO8859-1/share/sgml/catalog:$SGML_CATA 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 finished</screen> - <para>Die Fehlermeldungen die von &man.nsgmls.1; ausgegeben - werden, sind in durch Doppelpunkte getrennte Spalten - unterteilt.</para> + <para>Die Fehlermeldungen, die von <command>nsgmls</command> + ausgegeben werden, sind in durch Doppelpunkte getrennte + Spalten unterteilt.</para> <informaltable frame="none"> <tgroup cols="2"> @@ -674,20 +660,20 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <para>Durch das Weglassen des Tags <sgmltag>title</sgmltag> sind zwei unterschiedliche Fehler entstanden.</para> - <para>Der erste Fehler besagt, daß Inhalt (in diesem + <para>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 <sgmltag>head</sgmltag> auftreten kann.</para> - <para>Der zweite Fehler wurde dadurch verursacht, daß + <para>Der zweite Fehler wurde dadurch verursacht, dass das Element <sgmltag>head</sgmltag> ein Element <sgmltag>title</sgmltag> enthalten - <emphasis>muß</emphasis> und &man.nsgmls.1; nicht - berücksichtigt, daß dieser Fehler auf dem + <emphasis>muss</emphasis> und <command>nsgmls</command> + nicht berücksichtigt, dass dieser Fehler auf dem vorhergehenden beruht. Es wird lediglich festgestellt, - daß der Endtag von <sgmltag>head</sgmltag> auftritt, + dass der Endtag von <sgmltag>head</sgmltag> auftritt, obwohl nicht alle notwendigen Elemente vorhanden sind.</para> </step> @@ -705,7 +691,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> von w3c.de oder so hier verwendet wird.--> <title>Die DOCTYPE-Deklaration</title> - <para>Am Anfang jedes Dokuments muß der Name der dem + <para>Am 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.</para> @@ -738,7 +724,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <listitem> <para>Die Zeichenkette <literal><!</literal> dient hier - als <emphasis>Indikator</emphasis>, daß es sich bei + als <emphasis>Indikator</emphasis>, dass es sich bei diesem Ausdruck um eine SGML-Deklaration handelt und diese Zeile den Dokumententyp festlegt.</para> </listitem> @@ -748,7 +734,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <term><literal>DOCTYPE</literal></term> <listitem> - <para>Zeigt an, daß dies die SGML-Deklaration für + <para>Zeigt an, dass dies die SGML-Deklaration für den Dokumententyp ist.</para> </listitem> </varlistentry> @@ -806,7 +792,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> finden kann.</para> </note> - <para>Jeder öffentliche Bezeichner muß eine bestimmte Syntax + <para>Jeder öffentliche Bezeichner muss eine bestimmte Syntax haben, die wie folgt lautet:</para> <!-- Oliver Fischer: Ich habe hier Owner mit Besitzer uebersetzt. @@ -874,7 +860,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <para>Da das FreeBSD-Projekt seine Bezeichner nicht hat registrieren lassen, ist der Besitzer <literal>-//FreeBSD</literal>. Unter anderem kann man - daran auch sehen, daß das W3C sich nicht hat + daran auch sehen, dass das W3C sich nicht hat registrieren lassen.</para> </listitem> @@ -927,7 +913,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <para>Wenn man die oben beschriebene Syntax für Bezeichner verwendet und ein Dokument durch einen - SGML-Prozessor schickt, muß dieser die + SGML-Prozessor schickt, muss dieser die Möglichkeit haben, den Bezeichner auf eine real existierende Datei abzubilden, die die benötigte DTD enthält.</para> @@ -940,7 +926,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <programlisting>PUBLIC "-//W3C//DTD HTML 4.0//EN" "4.0/strict.dtd"</programlisting> - <para>kann ein SGML-Prozessor darüber feststellen, daß die + <para>kann ein SGML-Prozessor darüber feststellen, dass die benötigte DTD in der Datei <filename>strict.dtd</filename> im Unterverzeichnis <filename role="directory">4.0</filename> des Verzeichnisses des Katalogs zu finden ist.</para> @@ -957,7 +943,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <sect3> <title>Die Variable <envar>SGML_CATALOG_FILES</envar></title> - <para>Natürlich muß einem SGML-Prozessor noch + <para>Natü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 @@ -1015,7 +1001,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <programlisting><![ RCDATA [<!DOCTYPE html SYSTEM "/pfad/zur/dokumenten.dtd">]]></programlisting> <para>Das Schlüsselwort <literal>SYSTEM</literal> legt - fest, daß ein SGML-Prozessor die DTD auf + fest, dass ein SGML-Prozessor die DTD auf <quote>systemspezifische</quote> Art und Weise bestimmen soll. Meistens, aber nicht immer, wird so auf eine Datei im Dateisystem verwiesen.</para> @@ -1023,9 +1009,9 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <para>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 - muß, beziehungsweise da man, wenn man mit + muss, beziehungsweise da man, wenn man mit <literal>SYSTEM</literal> arbeitet, nicht davon ausgehen kann, - daß die benötigte DTD auf anderen Systemen genau + dass die benötigte DTD auf anderen Systemen genau unter dem gleichen Pfad verfügbar ist.</para> </sect2> @@ -1034,17 +1020,17 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <sect1 id="sgml-primer-sgml-escape"> <title>Die Rückkehr zu SGML</title> - <para>An einer früheren Stelle wurde erwähnt, daß + <para>An 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.</para> - <para>In diesem Falle muß dafür Sorge getragen werden, - daß ein SGML-Prozessor feststellen kann, daß ein + <para>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 - muß.</para> + muss.</para> <para>Solche SGML-Abschnitte werden mittels <literal><! ... ></literal> in Dokumenten @@ -1055,7 +1041,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <para>Demnach ist die <link linkend="sgml-primer-doctype-declaration">DOCTYPE-Deklaration</link> ein gutes Beispiel für SGML, das in Dokumenten verwendet - werden muß…</para> + werden muss…</para> </sect1> @@ -1115,7 +1101,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <para>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, daß Kommentare mit <literal><!--</literal> + angenommen, dass Kommentare mit <literal><!--</literal> begonnen und nur mit <literal>--></literal> beendet werden.</para> @@ -1168,14 +1154,14 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <para>Zur Übung können Sie einige Kommentare in die Datei <filename>beispiel.sgml</filename> einfügen und überprüfen, ob die Datei nun noch erfolgreich - von &man.nsgmls.1; validiert werden kann.</para> + von <command>nsgmls</command> validiert werden kann.</para> </step> <step> <para>Zu Testzwecken sollten Sie auch noch ein paar fehlerhafte Kommentare hinzufügen und sich die resultierenden Fehlermeldungen von - &man.nsgmls.1; ansehen.</para> + <command>nsgmls</command> ansehen.</para> </step> </procedure> </sect2> @@ -1212,7 +1198,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <para>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 - muß an der betreffenden Stelle der Namen der + muss an der betreffenden Stelle der Namen der Entität per <literal>&<replaceable>entitaetenname</replaceable>;</literal> einfügt werden. Eine Entität @@ -1237,7 +1223,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <programlisting><![ CDATA [<para>Die aktuelle Version des Programms ist ¤t.version;.</para>]]></programlisting> - <para>Wenn sich die Versionsnummer ändert, muß + <para>Wenn sich die Versionsnummer ändert, muss nur die Entität angepaßt und anschließend das Dokument neu erzeugt werden.</para> @@ -1247,7 +1233,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> 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, daß + 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.</para> @@ -1268,7 +1254,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <!ENTITY last.version "2.2.7-RELEASE"> ]>]]></programlisting> - <para>Wichtig ist an dieser Stelle, daß die + <para>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 @@ -1280,7 +1266,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> besseren UEbersetzung suchen. --> - <para>Die eckigen Klammern sind notwendig um festzulegen, daß + <para>Die eckigen Klammern sind notwendig um festzulegen, dass man die über DOCTYPE genannte DTD erweitern möchte.</para> </example> @@ -1307,7 +1293,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> referenziert<footnote> <para>Es wird das Prozentzeichen anstelle des kaufmännischen Unds verwendet.</para> - </footnote>. Wichtig ist, daß das + </footnote>. Wichtig ist, dass das <literal>%</literal>-Zeichen zwischen <literal>ENTITY</literal> und dem Entitätennamen ein Teil der Definition ist.</para> @@ -1359,18 +1345,19 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> </step> <step> - <para>Validieren Sie diese Datei mit &man.nsgmls.1;</para> + <para>Validieren Sie diese Datei mit + <command>nsgmls</command></para> </step> <step> <para>Öffnen Sie nun <filename>beispiel.sgml</filename> - mit Ihrem Webbrowser. Es kann notwendig sein, daß + mit Ihrem Webbrowser. Es kann notwendig sein, dass Sie die Datei vorher in <filename>beispiel.html</filename> umbenennen müssen, damit die Datei auch als HTML-Dokument erkannt wird.</para> <para>Nur wenn Sie einen sehr modernen Browser haben, werden - Sie sehen können, daß + Sie sehen können, dass <literal>&version;</literal> durch die Versionsnummer ersetzt wurde. Leider haben die meisten Webbrowser sehr einfache SGML-Parser, die nicht richtig mit SGML @@ -1387,21 +1374,19 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <emphasis>normalisieren</emphasis>. Zu diesem Zweck liest ein Normer <!--? Sehr freie Übersetzung. Oliver --> das Dokument ein und gibt anschließend semantisch - gleichwertiges SGML wieder aus, daß auf verschiedene + 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.</para> - <para>Versuchen Sie die Beispieldatei mittels &man.sgmlnorm.1; - zu normalisieren:</para> - - <!--<para>You can use &man.sgmlnorm.1; to do this.</para>--> + <para>Versuchen Sie, die Beispieldatei mittels + <command>sgmlnorm</command> zu normalisieren:</para> <screen>&prompt.user; <userinput>sgmlnorm beispiel.sgml > beispiel.html</userinput></screen> <para>Anschließend sollten Sie eine normalisierte - Version, daß heißt eine, bei der die + Version, dass heißt eine, bei der die Entitäten gegen ihren Inhalt ersetzt wurden, in der Datei <filename>beispiel.html</filename> finden. Diese Datei können Sie sich nun mit Ihrem Browser @@ -1410,10 +1395,11 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> </step> <step> - <para>Wenn Sie sich die Ausgaben von &man.sgmlnorm.1; ansehen, - werden Sie feststellen, daß die DOCTYPE-Deklaration am - Anfang der Datei nicht mehr enthalten ist. Möchten Sie - die Deklaration behalten, muß &man.sgmlnorm.1; mit der Option + <para>Wenn Sie sich die Ausgaben von <command>sgmlnorm</command> + ansehen, werden Sie feststellen, dass + die DOCTYPE-Deklaration am Anfang der Datei nicht mehr + enthalten ist. Möchten Sie die Deklaration behalten, + muss <command>sgmlnorm</command> mit der Option <option>-d</option> aufrufen werden:</para> <screen>&prompt.user; <userinput>sgmlnorm -d beispiel.sgml > beispiel.html</userinput></screen> @@ -1451,7 +1437,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> zusammengeführt werden.</para> <para>Damit der Inhalt der Dateien mit Entitäten - eingebunden werden kann, muß die Deklaration der + eingebunden werden kann, muss die Deklaration der Entitäten das Schlüsselwort <literal>SYSTEM</literal> enthalten. SGML-Parser werden so angewiesen, den Inhalt der referenzierten Datei als Wert @@ -1569,8 +1555,8 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> </step> <step> - <para>Ändern Sie <filename>beispiel.sgml</filename> so ab, daß sie wie folgt - aussieht:</para> + <para>Ändern Sie <filename>beispiel.sgml</filename> so + ab, dass sie wie folgt aussieht:</para> <programlisting><![ CDATA [<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [ <!ENTITY version "1.1"> @@ -1605,7 +1591,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <step> <para>Öffnen Sie <filename>beispiel.html</filename> nun mit einem Webbrowser und vergewissern Sie sich, - daß der Inhalt der Dateien + dass der Inhalt der Dateien <filename>absatz<replaceable>N</replaceable>.sgml</filename> in <filename>beispiel.html</filename> übernommen wurde.</para> @@ -1622,8 +1608,8 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <procedure> <step> - <para>Ändern Sie <filename>beispiel.sgml</filename> so ab, daß es wie - folgt aussieht:</para> + <para>Ändern Sie <filename>beispiel.sgml</filename> so + ab, dass es wie folgt aussieht:</para> <programlisting><![ CDATA [<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [ <!ENTITY % entitaeten SYSTEM "entitaeten.sgml"> %entitaeten; @@ -1665,7 +1651,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <step> <para>Öffnen Sie <filename>beispiel.html</filename> nun mit einem Webbrowser und vergewissern Sie sich, - daß der Inhalt der Dateien + dass der Inhalt der Dateien <filename>absatz<replaceable>N</replaceable>.sgml</filename> in <filename>beispiel.html</filename> übernommen wurde.</para> @@ -1678,7 +1664,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <sect1 id="sgml-primer-marked-sections"> <title>Markierte Bereiche</title> - <para>SGML erlaubt es, daß bestimmte Dokumentabschnitte + <para>SGML erlaubt es, dass bestimmte Dokumentabschnitte während der Verarbeitung besonders behandelt werden sollen. Diese Abschnitte werden als <quote>markierte Bereiche</quote> <footnote><para>auf Englisch <foreignphrase>marked @@ -1720,7 +1706,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> Bereiche. Dadurch ist es möglich, vom Standardmodell abzuweichen.</para> - <para>Ein SGML-Prozessor muß während der + <para>Ein SGML-Prozessor muss während der Verarbeitung eines Dokuments zu jedem Zeitpunkt wissen, welches <emphasis>Inhaltsmodell</emphasis> gerade anzuwenden ist.</para> @@ -1737,10 +1723,10 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> Zeichendaten<footnote> <para>auf Englisch <foreignphrase>character data</foreignphrase></para></footnote>. Trifft ein - Parser auf dieses Inhaltsmodell, wird er annehmen, daß + Parser auf dieses Inhaltsmodell, wird er annehmen, dass sich im zugehörigen Dokumentenbereich nur <quote>gewöhnliche</quote> Zeichen befinden. Das - bedeutet, daß < und & ihre besondere Bedeutung + bedeutet, dass < und & ihre besondere Bedeutung verlieren und als einfache Zeichen behandelt werden.</para> <para><literal>RCDATA</literal> steht für @@ -1749,7 +1735,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <foreignphrase>Entity references and character data</foreignphrase></para></footnote>. Für einen Bereich mit diesem Inhaltsmodell, wird ein Parser davon - ausgehen, daß er sowohl Zeichen als auch + 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.</para> @@ -1769,10 +1755,10 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <para>Bei der Verwendung von <literal>CDATA</literal> und <literal>RCDATA</literal> als Inhaltsmodell für SGML-Beispiele, wie sie in diesem Dokument enthalten sind, - muß bedacht werden, daß der Inhalt eines + muss bedacht werden, dass der Inhalt eines <literal>CDATA</literal>-Bereiches nicht validiert wird. - Daß das SGML in diesen Bereichen gültig ist, - muß auf andere Weise sichergestellt werden. Denkbar ist + 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.</para> @@ -1807,7 +1793,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> </programlisting></programlisting> <para>Liest man die Quellen dieser Fibel, wird man - feststellen, daß diese Technik durchgängig + feststellen, dass diese Technik durchgängig angewandt wurde.</para> </example> @@ -1818,10 +1804,10 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <literal>IGNORE</literal></title> <para>Das Schlüsselwort <literal>INCLUDE</literal> legt - fest, daß der Inhalt des betreffenden Abschnittes + fest, dass der Inhalt des betreffenden Abschnittes mitverarbeitet wird. Demgegenüber bestimmt - <literal>IGNORE</literal>, daß er ignoriert wird, - daß heißt, daß er bei der Verarbeitung + <literal>IGNORE</literal>, dass er ignoriert wird, + dass heißt, dass er bei der Verarbeitung übergangen wird und in der Ausgabe nicht enthalten ist.</para> @@ -1867,7 +1853,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> Parameterentität ein.</para> <para>Soll anstelle der digitalen die gedruckte Variante - produziert werden, muß lediglich der Entität + produziert werden, muss lediglich der Entität <literal>IGNORE</literal> als Wert zugewiesen und das Ursprungsdokument erneut durch den SGML-Prozessor geschickt werden.</para> @@ -1886,7 +1872,7 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> Dieser Satz sollte nur in der digitalen Version enthalten sein. ]]></programlisting> - <para>Bei der Produktion der gedruckten Variante muß + <para>Bei der Produktion der gedruckten Variante muss der Wert der Entität geändert werden.</para> <programlisting><!ENTITY % digitale.kopie "IGNORE"></programlisting> @@ -1939,19 +1925,19 @@ nsgmls:beispiel.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> <step> <para>Normalisieren Sie den Inhalt dieser Datei mit Hilfe - von &man.sgmlnorm.1; und sehen Sie sich das Ergebnis an. - Achten Sie dabei darauf, welche Absätze enthalten beziehungsweise - nicht enthalten sind und was aus den - <literal>CDATA</literal>-Bereichen geworden ist.</para> + von <command>sgmlnorm</command> und sehen Sie sich das + Ergebnis an. Achten Sie dabei darauf, welche Absätze + enthalten beziehungsweise nicht enthalten sind und was aus + den <literal>CDATA</literal>-Bereichen geworden ist.</para> </step> <step> <para>Ändern Sie die Definition von - <literal>text.ausgabe</literal> so, daß es den + <literal>text.ausgabe</literal> so, dass es den Wert <literal>IGNORE</literal> zugewiesen bekommt. - Verarbeiten Sie dann die Datei erneut mit &man.sgmlnorm.1; - und vergleichen die Ausgabe mit der vom ersten - &man.sgmlnorm.1; Lauf.</para> + Verarbeiten Sie dann die Datei erneut mit + <command>sgmlnorm</command> und vergleichen die Ausgabe mit + der vom ersten <command>sgmlnorm</command> Lauf.</para> </step> </procedure> diff --git a/de_DE.ISO8859-1/books/fdp-primer/the-website/chapter.sgml b/de_DE.ISO8859-1/books/fdp-primer/the-website/chapter.sgml index de432c41b3..e4617ed726 100644 --- a/de_DE.ISO8859-1/books/fdp-primer/the-website/chapter.sgml +++ b/de_DE.ISO8859-1/books/fdp-primer/the-website/chapter.sgml @@ -28,15 +28,211 @@ POSSIBILITY OF SUCH DAMAGE. $FreeBSD$ - $FreeBSDde: de-docproj/books/fdp-primer/the-website/chapter.sgml,v 1.3 2004/08/30 22:39:59 mheinen Exp $ + $FreeBSDde: de-docproj/books/fdp-primer/the-website/chapter.sgml,v 1.4 2004/10/31 13:24:10 jkois Exp $ + basiert auf: 1.17 --> <chapter id="the-website"> - <title># Die Webseite</title> + <chapterinfo> + <authorgroup> + <author> + <firstname>Johann</firstname> + <surname>Kois</surname> + <contrib>Übersetzt von </contrib> + </author> + </authorgroup> + </chapterinfo> - <para>Dieser Abschnitt ist noch nicht übersetzt. Lesen Sie - bitte <ulink url="&url.books.fdp-primer.en;/the-website.html">das - Original in englischer Sprache</ulink>.</para> + <title>Die Webseite</title> + + <sect1 id="the-website-prep"> + <title>Vorbereitung</title> + + <para>Sie benötigen mindestens 200 MB freien Speicherplatz. + Dieser Platz wird von den SGML-Werkzeugen, den nötigen Teilen + des CVS-Baums, für temporären Speicher zum Bau der Seiten + sowie für die Installation der Webseiten benötigt. Sind + die SGML-Werkzeuge und der CVS-Baum bereits installiert, reichen + etwa 100 MB an freiem Speicherplatz aus.</para> + + <note> + <para>Stellen Sie sicher, dass Ihre Dokumentationsports aktuell + sind. Wenn Sie sich nicht sicher sind, entfernen Sie die alten + Ports mit &man.pkg.delete.1;, bevor Sie die neue Version + installieren. Derzeit wird unter anderem jade-1.2 vorausgesetzt. + Haben Sie beispielsweise jade-1.1 installiert, deinstallieren Sie + es mit:</para> + + <screen>&prompt.root; <userinput>pkg_delete jade-1.1</userinput></screen> + </note> + + <para>Legen Sie ein CVS-Repository an. Sie benötigen die + Verzeichnisse www, doc sowie ports des CVS-Baums (und + natürlich CVSROOT). Lesen Sie bitte den Abschnitt + <ulink url="&url.books.handbook;/synching.html#CVSUP"> + Synchronisation der Quellen</ulink> des Handbuchs, der die + Spiegelung eines CVS-Baumes oder eines Teilbaumes + beschreibt.</para> + + <para>Die unbedingt nötigen cvsup-Sammlungen sind + <literal>www</literal>, <literal>doc-all</literal>, + <literal>cvs-base</literal>, sowie + <literal>ports-base</literal>.</para> + + <para>Diese Sammlungen benötigen etwa 105 MB an freiem + Speicherplatz.</para> + + <para>Der komplette CVS-Baum - inklusive <literal>src</literal>, + <literal>doc</literal>, <literal>www</literal>, und + <literal>ports</literal> - umfasst derzeit etwa 940 MB.</para> + </sect1> + + <sect1 id="the-website-build"> + <title>Die Internetseiten neu bauen</title> + + <procedure> + <step> + <para>Wechseln Sie in das Verzeichnis, in dem Sie die Webseiten + bauen wollen. Sie benötigen dazu mindestens 60 MB + freien Speicherplatz.</para> + + <screen>&prompt.root; <userinput>mkdir /var/tmp/webbuild</userinput> +&prompt.root; <userinput>cd /var/tmp/webbuild</userinput></screen> + </step> + + <step> + <para>Checken Sie die SGML-Dateien aus dem CVS-Baum aus.</para> + + <screen>&prompt.root; <userinput>cvs -R co www doc</userinput></screen> + </step> + + <step> + <para>Wechseln Sie ins Verzeichnis <filename>www</filename> und + führen Sie &man.make.1; <maketarget>links</maketarget> + aus, um die nötigen symbolischen Links zu erzeugen.</para> + + <screen>&prompt.root; <userinput>cd www</userinput> +&prompt.root; <userinput>make links</userinput></screen> + </step> + + <step> + <para>Wechseln Sie ins Verzeichnis <filename>en</filename> und + führen Sie &man.make.1; <maketarget>all</maketarget> aus, + um die Webseiten zu erzeugen.</para> + + <screen>&prompt.root; <userinput>cd en</userinput> +&prompt.root; <userinput>make all</userinput></screen> + </step> + </procedure> + </sect1> + + <sect1 id="the-website-install"> + <title>Installieren der Webseiten auf Ihrem Server</title> + + <procedure> + <step> + <para>Wechseln Sie wieder in das Verzeichnis + <filename>en</filename>, falls Sie dieses inzwischen + verlassen haben.</para> + + <screen>&prompt.root; <userinput>cd <replaceable>path</replaceable>/www/en</userinput></screen> + </step> + + <step> + <para>Führen Sie &man.make.1; <maketarget>install</maketarget> + aus, und setzen Sie die Variable <makevar>DESTDIR</makevar> auf + das Verzeichnis, in das Sie die Webseiten installieren + wollen.</para> + + <screen>&prompt.root; <userinput>make DESTDIR=<replaceable>/usr/local/www</replaceable> install</userinput></screen> + </step> + + <step> + <para>Wenn Sie die Webseiten bereits früher in dieses + Verzeichnis installiert haben, wurden während der + Installation keine veralteten Seiten entfernt. Wenn + Sie die Webseiten beispielsweise täglich neu bauen + und installieren, findet und entfernt der folgende Befehl + alle Dateien, die in den letzten drei Tagen nicht aktualisiert + wurden:</para> + + <screen>&prompt.root; <userinput>find <replaceable>/usr/local/www</replaceable> -ctime 3 -print0 | xargs -0 rm</userinput></screen> + </step> + </procedure> + </sect1> + + <sect1 id="the-website-env"> + <title>Umgebungsvariablen</title> + + <variablelist> + <varlistentry> + <term><envar>CVSROOT</envar></term> + + <listitem> + <para>Der Ort des CVS-Baums. Unbedingt notwendig.</para> + + <screen><userinput>&prompt.root; CVSROOT=/home/ncvs; export CVSROOT</userinput></screen> + </listitem> + </varlistentry> + + <varlistentry> + <term><makevar>ENGLISH_ONLY</makevar></term> + + <listitem> + <para>Ist diese Variable gesetzt und nicht leer, bauen und + installieren die Makefiles ausschließlich die + englischen Dokumente. Sämtliche Übersetzungen + werden dabei ignoriert. Dazu ein Beispiel:</para> + + <screen>&prompt.root; <userinput>make ENGLISH_ONLY=YES all install</userinput></screen> + + <para>Wenn Sie die Variable <makevar>ENGLISH_ONLY</makevar> + deaktivieren und alle Webseiten inklusive aller + Übersetzungen bauen wollen, setzen Sie die Variable + <makevar>ENGLISH_ONLY</makevar> auf einen leeren Wert:</para> + + <screen>&prompt.root; <userinput>make ENGLISH_ONLY="" all install clean</userinput></screen> + </listitem> + </varlistentry> + + <varlistentry> + <term><makevar>WEB_ONLY</makevar></term> + + <listitem> + <para>Ist diese Variable gesetzt und nicht leer, bauen und + installieren die Makefiles nur die HTML-Seiten des + www-Verzeichnisses. Alle Dokumente des doc-Verzeichnisses + (Handbuch, FAQ, Artikel) werden dabei ignoriert:</para> + + <screen>&prompt.root; <userinput>make WEB_ONLY=YES all install</userinput></screen> + </listitem> + </varlistentry> + + <varlistentry> + <term><makevar>NOPORTSCVS</makevar></term> + + <listitem> + <para>Ist diese Variable gesetzt, checken die Makefiles keine + Dateien aus dem Ports-CVS-Repository aus. Stattdessen werden + die Dateien aus dem Verzeichnis + <filename>/usr/ports</filename> (oder aus dem Verzeichnis, + auf das die Variable <envar>PORTSBASE</envar> zeigt) + verwendet.</para> + </listitem> + </varlistentry> + </variablelist> + + <para>Bei <envar>CVSROOT</envar> handelt es sich um eine + Umgebungsvariable. Sie muss auf der Kommandozeile oder in der + Konfigurationsdatei <filename>~/.profile</filename> gesetzt + werden.</para> + + <para><makevar>WEB_ONLY</makevar>, <makevar>ENGLISH_ONLY</makevar> + und <makevar>NOPORTSCVS</makevar> sind Variablen für Makefiles. + Diese werden entweder in <filename>/etc/make.conf</filename>, in + <filename>Makefile.inc</filename> oder als Umgebungsvariablen auf + der Kommandozeile oder in Ihrer Konfigurationsdatei gesetzt.</para> + </sect1> </chapter> <!-- diff --git a/de_DE.ISO8859-1/books/fdp-primer/translations/chapter.sgml b/de_DE.ISO8859-1/books/fdp-primer/translations/chapter.sgml index 9a407a1a2f..7d3360d89c 100644 --- a/de_DE.ISO8859-1/books/fdp-primer/translations/chapter.sgml +++ b/de_DE.ISO8859-1/books/fdp-primer/translations/chapter.sgml @@ -28,15 +28,480 @@ POSSIBILITY OF SUCH DAMAGE. $FreeBSD$ - $FreeBSDde: de-docproj/books/fdp-primer/translations/chapter.sgml,v 1.5 2004/08/30 22:39:59 mheinen Exp $ + $FreeBSDde: de-docproj/books/fdp-primer/translations/chapter.sgml,v 1.6 2004/10/31 11:40:16 jkois Exp $ + basiert auf: 1.26 --> <chapter id="translations"> - <title># Übersetzungen in andere Sprachen</title> + <chapterinfo> + <authorgroup> + <author> + <firstname>Johann</firstname> + <surname>Kois</surname> + <contrib>Übersetzt von </contrib> + </author> + </authorgroup> + </chapterinfo> - <para>Dieser Abschnitt ist noch nicht übersetzt. Lesen Sie - bitte <ulink url="&url.books.fdp-primer.en;/translations.html">das - Original in englischer Sprache</ulink>.</para> + <title>Übersetzungen</title> + + <para>Dieses Kapitel enthält die FAQ für die Übersetzung + der FreeBSD Dokumentation (FAQ, Handbuch, Artikel, Manualpages und + sonstige Dokumente) in andere Sprachen.</para> + + <para>Es beruht <emphasis>sehr</emphasis> stark auf den + Übersetzungs-FAQ des FreeBSD German Documentation Projects, die + ursprünglich von Frank Gründer + <email>elwood@mc5sys.in-berlin.de</email> geschrieben und danach von + Bernd Warken <email>bwarken@mayn.de</email> ins Englische + übersetzt wurden.</para> + + <para>Diese FAQ wird vom &a.doceng; gepflegt.</para> + + <qandaset> + <qandaentry> + <question> + <para>Warum eine FAQ?</para> + </question> + + <answer> + <para>Es melden sich immer mehr Leute auf der Mailingliste + freebsd-doc, die Teile der FreeBSD Dokumentation in andere + Sprachen übersetzen wollen. Diese FAQ soll die + am häufigsten gestellten Fragen beantworten, damit + möglichst rasch mit der Übersetzung begonnen + werden kann.</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Was bedeuten die Abkürzungen <phrase>i18n</phrase> + und <phrase>l10n</phrase>?</para> + </question> + + <answer> + <para><phrase>i18n</phrase> steht für + <foreignphrase>internationalization</foreignphrase> + (Internationalisierung), <phrase>l10n</phrase> für + <foreignphrase>localization</foreignphrase> (Lokalisierung). + Es handelt sich dabei um besser handhabbare Abkürzungen + dieser Begriffe.</para> + + <para><phrase>i18n</phrase> kann als <quote>i</quote>, gefolgt + von 18 Buchstaben, gefolgt von einem <quote>n</quote>, gelesen + werden. Analog steht <phrase>l10n</phrase> für + <quote>l</quote>, gefolgt von 10 Buchstaben, gefolgt von einem + <quote>n</quote>.</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Gibt es eigene Mailinglisten für Übersetzer?</para> + </question> + + <answer> + <para>Ja. Die verschiedenen Übersetzergruppen haben jeweils + eigene Mailinglisten. Genauere Informationen finden Sie in der + <ulink url="http://www.freebsd.org/docproj/translations.html"> + Liste der Übersetzungsprojekte</ulink>. Diese Liste + enthält die Mailinglisten und Internetseiten, die von den + einzelnen Übersetzungsprojekten betrieben werden.</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Werden noch Übersetzer benötigt?</para> + </question> + + <answer> + <para>Ja. Je mehr Leute an der Übersetzung arbeiten, desto + schneller wird diese fertig, und umso schneller sind + Änderungen im englischen Original auch in den + übersetzten Dokumenten vorhanden.</para> + + <para>Sie müsssen kein professioneller Dolmetscher sein, um + dabei zu helfen.</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Welche Sprachen muss ich dafür kennen/können?</para> + </question> + + <answer> + <para>Idealerweise haben Sie gute Kenntnisse in geschriebenem + Englisch, außerdem sollten Sie natürlich fit in + der Sprache sein, in die Sie übersetzen wollen.</para> + + <para>Englisch ist allerdings nicht unbedingt nötig. Sie + könnten beispielsweise auch die FAQ vom Spanischen ins + Ungarische übersetzen.</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Welche Software wird benötigt?</para> + </question> + + <answer> + <para>Es ist sehr empfehlenswert, eine lokale Kopie des FreeBSD + CVS-Repository (als Minimum den Dokumentationsteil) anzulegen, + entweder mit <application>CTM</application> oder mit + <application>CVSup</application>. Das Kapitel <quote>Das + Neueste und Beste</quote> des Handbuchs beschreibt die + Nutzung dieser Programme.</para> + + <para>Sie sollten außerdem mit + <application>CVS</application> vertraut sein. Damit ist es + möglich, festzustellen, was sich zwischen einzelnen + Versionen eines Dokuments geändert hat.</para> + + <para>[XXX Aufgabe -- Ein Tutorial schreiben, das die Verwendung + von CVSup beschreibt, um die Dokumentation herunterzuladen, + auszuchecken und festzustellen, was sich zwischen zwei + Versionen geändert hat.]</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Wie finde ich heraus, ob noch jemand Teile der + Dokumentation in die gleiche Sprache übersetzt?</para> + </question> + + <answer> + <para>Die <ulink + url="http://www.FreeBSD.org/docproj/translations.html"> + Übersetzungsseite </ulink> des Documentation Projects + listet alle Übersetzungs-Teams auf, die derzeit aktiv + sind. Arbeitet bereits jemand an der Übersetzung in + Ihre Sprache, so kontaktieren Sie dieses Team, damit + Dokumente nicht unnötigerweise mehrfach übersetzt + werden.</para> + + <para>Wenn Ihre Sprache nicht aufgeführt ist, senden Sie + bitte eine E-Mail an das &a.doc;. Vielleicht denkt ja jemand + über eine Übersetzung nach, hat sich aber noch nicht + dafür entschieden.</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Niemand übersetzt in meine Sprache. Was soll ich + machen?</para> + </question> + + <answer> + <para>Gratulation, Sie haben gerade das <quote>FreeBSD + <replaceable>Ihre-Sprache</replaceable> Documentation + Translation Project</quote> gestartet. Willkommen.</para> + + <para>Entscheiden Sie zuerst, ob Sie die dafür nötige + Zeit zur Verfügung haben. Da Sie als Einziger an der + Übersetzung in Ihre Sprache arbeiten, sind Sie dafür + verantwortlich, Ihre Arbeit zu veröffentlichen und die + Arbeit von Freiwilligen, die Ihnen dabei helfen wollen, zu + koordinieren.</para> + + <para>Senden Sie eine E-Mail an die Mailingliste des + Documentation Projects, in der Sie bekanntgeben, dass Sie an + der Übersetzung der Dokumentation arbeiten, damit die + Internetseiten aktualisiert werden können.</para> + + <para>Gibt es in Ihrem Land einen FreeBSD-Spiegelserver, so + sollten Sie den dafür Zuständigen kontaktieren und + nachfragen, ob er Ihnen Speicherplatz oder E-Mailadressen + für Ihr Projekt zur Verfügung stellen würde.</para> + + <para>Danach wählen Sie ein Dokument aus und beginnen + mit der Übersetzung. Am besten beginnen Sie mit kleineren + Dateien, beispielsweise den FAQ oder einem der Artikel.</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Ich habe ein Dokument übersetzt. Wo soll ich es + hinschicken?</para> + </question> + + <answer> + <para>Das kommt darauf an. Wenn Sie bereits in einem + Übersetzer-Team arbeiten (etwa dem japanischen oder dem + deutschen Team), dann sollten Sie deren Richtlinien zum Umgang + mit neuer Dokumentation folgen, die auf deren Internetseiten + beschrieben werden.</para> + + <para>Wenn Sie die einzige Person sind, die an der + Übersetzung in eine Sprache arbeitet, oder wenn Sie + für ein Übersetzungsprojekt verantwortlich sind, + und Ihre Aktualisierungen an das FreeBSD Project + übermitteln wollen, sollten Sie Ihre Übersetzungen + dorthin senden (lesen Sie dazu auch die nächste + Frage).</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Ich arbeite als einziger an der Übersetzung in diese + Sprache, wie versende ich meine Übersetzungen?</para> + + <para>oder</para> + + <para>Wir sind ein Übersetzer-Team, und wollen Dokumente + versenden, die unsere Mitglieder übersetzt haben?</para> + </question> + + <answer> + <para>Stellen Sie zuerst sicher, dass Ihre Übersetzungen + korrekt organisiert sind. Sie sollte sich also im + existierenden Dokumentationsbaum befinden, und ohne Fehler + bauen lassen.</para> + + <para>Zurzeit wird die FreeBSD Dokumentation unterhalb des + Verzeichnisses <filename>doc/</filename> gespeichert. Die + direkten Unterverzeichnisse werden entsprechend der + Sprachkodierung benannt, in der sie geschrieben sind. Diese + Kodierung nach ISO639 finden Sie auf einem FreeBSD-System + unter <filename>/usr/share/misc/iso639</filename>, + vorausgesetzt, das System wurde nach dem 20. Januar 1999 + gebaut.</para> + + <para>Wenn in Ihrer Sprache mehrere Kodierungen (wie dies etwa + für Chinesisch der Fall ist) vorhanden sind, existiert + für jede Kodierung ein eigenes Unterverzeichnis.</para> + + <para>Zuletzt existieren auch noch Verzeichnisse für die + einzelnen Dokumente.</para> + + <para>Die Verzeichnishierarchie für eine hypothetische + schwedische Übersetzung könnte etwa so + aussehen:</para> + + <programlisting>doc/ + sv_SE.ISO8859-1/ + Makefile + books/ + faq/ + Makefile + book.sgml</programlisting> + + <para>Bei <literal>sv_SE.ISO8859-1</literal> handelt es sich um + den Namen der Übersetzung in der + <filename><replaceable>lang</replaceable>.<replaceable>encoding</replaceable></filename> + Form. Beachten Sie auch, dass zum Bauen der Dokumentation + zwei Makefiles notwendig sind.</para> + + <para>Komprimieren Sie Ihre Übersetzungen mit &man.tar.1; + und &man.gzip.1; und senden Sie sie an das FreeBSD + Project.</para> + + <screen>&prompt.user; <userinput>cd doc</userinput> +&prompt.user; <userinput>tar cf swedish-docs.tar sv</userinput> +&prompt.user; <userinput>gzip -9 swedish-docs.tar</userinput></screen> + + <para>Legen Sie das Archiv <filename>swedish-docs.tar.gz</filename> + irgendwo ab. Wenn Sie keinen eigenen Webspace haben (etwa weil + Ihr Internetprovider Ihnen keinen zur Verfügung stellt), + können Sie auch eine E-Mail an das &a.doceng; schicken, um + abzuklären, ob Sie die Datei auch als E-Mail schicken + können.</para> + + <para>In beiden Fällen sollten Sie mit &man.send-pr.1; + einen Bericht über den Versand der Dokumentation + erstellen. Es ist sehr hilfreich, wenn Sie Ihre + Übersetzung vorher korrekturlesen lassen und + überprüfen, da es unwahrscheinlich ist, dass + der Committer Ihre Sprache sehr gut beherrscht.</para> + + <para>Danach wird jemand (meistens der Documentation Project + Manager, derzeit ist dies das &a.doceng;) überprüfen, + ob sich Ihre Übersetzungen problemlos bauen lassen. Dabei + wird besonders auf folgende Punkte geachtet:</para> + + <orderedlist> + <listitem> + <para>Verwenden alle Dateien RCS-Strings (wie "ID")?</para> + </listitem> + + <listitem> + <para>Arbeitet <command>make all</command> im Verzeichnis + <filename>sv_SE.ISO8859-1</filename> korrekt?</para> + </listitem> + + <listitem> + <para>Funktioniert <command>make install</command> ohne + Probleme?</para> + </listitem> + </orderedlist> + + <para>Gibt es dabei Probleme, so wird die Person, die Ihren + Beitrag durchsieht, sich wieder an Sie wenden, damit Sie + das Problem beheben.</para> + + <para>Treten keine Probleme auf, wird Ihre Übersetzung + so rasch als möglich committed.</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Kann ich landes- oder sprachspezifische Informationen + in meine Übersetzung aufnehmen?</para> + </question> + + <answer> + <para>Wir bitten Sie, dies nicht zu tun.</para> + + <para>Nehmen wir an, dass Sie das Handbuch ins Koreanische + übersetzen und einen Abschnitt mit + Händlerinformationen in das Handbuch aufnehmen + wollen.</para> + + <para>Es gibt keinen Grund, warum diese Information nicht auch + in der englischen (oder der deutschen, oder der spanischen, + oder der japanischen oder der …) Version vorhanden sein + sollte. Es ist etwa denkbar, dass sich jemand mit englischer + Muttersprache während eines Aufenthalts in Korea eine + FreeBSD-Kopie kaufen möchte. Außerdem wird dadurch + die weltweite Präsenz von FreeBSD verdeutlicht, was + natürlich ebenfalls von Vorteil ist.</para> + + <para>Wenn Sie also länderspezifische Informationen + ergänzen wollen, sollten Sie dies zuerst in der englischen + Version (mittels &man.send-pr.1;) tun, und die Änderung + anschließend in Ihre Sprache übersetzen.</para> + + <para>Vielen Dank.</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Wie lassen sich sprachspezifische Zeichen darstellen?</para> + </question> + + <answer> + <para>Nicht-ASCII-Zeichen innerhalb der Dokumentation werden + durch SGML-Entities dargestellt.</para> + + <para>Diese bestehen aus: Kaufmännischem Und (&), + den Namen der Entity, und einem Strichpunkt (;).</para> + + <para>Die Namen der Entities sind in ISO8879 definiert, die als + Port <filename role="package">textproc/iso8879</filename> + installiert werden kann.</para> + + <para>Dazu einige Beispiele:</para> + + <segmentedlist> + <segtitle>Entity</segtitle> + + <segtitle>Darstellung</segtitle> + + <segtitle>Beschreibung</segtitle> + + <seglistitem> + <seg>&eacute;</seg> + <seg>é</seg> + <seg>Kleines <quote>e</quote> mit (akutem) Akzent</seg> + </seglistitem> + + <seglistitem> + <seg>&Eacute;</seg> + <seg>É</seg> + <seg>Großes <quote>E</quote> mit (akutem) Akzent</seg> + </seglistitem> + + <seglistitem> + <seg>&uuml;</seg> + <seg>ü</seg> + <seg>Kleines Umlaut-<quote>u</quote></seg> + </seglistitem> + </segmentedlist> + + <para>Nachdem Sie den iso8879-Port installiert haben, ist die + vollständige Liste unter + <filename>/usr/local/share/sgml/iso8879</filename> + vorhanden.</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Wie spricht man den Leser an?</para> + </question> + + <answer> + <para>In englischen Dokumenten wird der Leser mit + <quote>you</quote> angesprochen, es wird nicht zwischen + formeller/informeller Anrede unterschieden, wie dies in + manchen anderen Sprachen der Fall ist.</para> + + <para>Wenn Sie in eine Sprache übersetzen, die diese + Unterscheidung trifft, verwenden Sie die Form, die auch in + den anderen technischen Dokumentationen dieser Sprache + verwendet wird. Für deutsche Versionen ist dies die + dritte Person Plural (<quote>Sie</quote>).</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Muss ich zusätzliche Informationen in meine + Übersetzungen einbauen?</para> + </question> + + <answer> + <para>Ja.</para> + + <para>Der Header der englischen Version jedes Textes sieht in + etwa so aus:</para> + + <programlisting><!-- + The FreeBSD Documentation Project + + $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/translations/chapter.sgml,v 1.5 2000/07/07 18:38:38 dannyboy Exp $ +--></programlisting> + + <para>Das exakte Aussehen kann unterschiedlich sein, die Zeile + mit $FreeBSD$ sowie der Ausdruck <literal>The + FreeBSD Documentation Project</literal> sind allerdings immer + enthalten. Beachten Sie, dass die Zeile mit $FreeBSD + von CVS automatisch expandiert wird, daher sollte an dieser + Stelle in Ihren neuen Dokumenten nur + <literal>$FreeBSD$</literal> stehen.</para> + + <para>Ihre übersetzten Dokumente sollten eine eigene + $FreeBSD$-Zeile enthalten. Zusätzlich + sollten Sie die Zeile mit <literal>The FreeBSD Documentation + Project</literal> in <literal>The FreeBSD + <replaceable>Ihre-Sprache</replaceable> Documentation + Project</literal> ändern.</para> + + <para>Außerdem sollten Sie eine weitere Zeile + einfügen, die festlegt, auf welcher Version des englischen + Originals Ihre Übersetzung basiert.</para> + + <para>Die spanische Version dieser Datei könnte etwa so + beginnen:</para> + + <programlisting><!-- + The FreeBSD Spanish Documentation Project + + $FreeBSD: doc/es_ES.ISO8859-1/books/fdp-primer/translations/chapter.sgml,v 1.3 1999/06/24 19:12:32 jesusr Exp $ + Original revision: 1.11 +--></programlisting> + </answer> + </qandaentry> + </qandaset> </chapter> <!-- diff --git a/de_DE.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml b/de_DE.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml index bf2df3d219..d3da4894db 100644 --- a/de_DE.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml +++ b/de_DE.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml @@ -28,15 +28,490 @@ POSSIBILITY OF SUCH DAMAGE. $FreeBSD$ - $FreeBSDde: de-docproj/books/fdp-primer/writing-style/chapter.sgml,v 1.4 2004/08/30 22:39:59 mheinen Exp $ + $FreeBSDde: de-docproj/books/fdp-primer/writing-style/chapter.sgml,v 1.5 2004/10/31 17:19:31 jkois Exp $ + basiert auf: 1.40 --> <chapter id="writing-style"> - <title># Der Schreibstil</title> + <chapterinfo> + <authorgroup> + <author> + <firstname>Johann</firstname> + <surname>Kois</surname> + <contrib>Übersetzt von </contrib> + </author> + </authorgroup> + </chapterinfo> - <para>Dieser Abschnitt ist noch nicht übersetzt. Lesen Sie - bitte <ulink url="&url.books.fdp-primer.en;/writing-style.html"> - das Original in englischer Sprache</ulink>.</para> + <title>Der Schreibstil</title> + + <para>Damit von verschiedenen Autoren geschriebene Dokumente + zueinander konsistent bleiben, gibt es einige Richtlinien, denen + Autoren bei der Erstellung ihrer Dokumente folgen müssen.</para> + + <variablelist> + <varlistentry> + <term>Verwendung von amerikanischem Englisch</term> + + <listitem> + <para>Es gibt mehrere englische Varianten und damit verbunden + verschiedene Schreibweisen für das gleiche Wort. Wo dies + der Fall ist, ist die amerikanische Schreibweise zu verwenden. + Man schreibt daher <quote>color</quote> statt + <quote>colour</quote>, <quote>rationalize</quote> statt + <quote>rationalise</quote>, und so weiter.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Vermeiden von Zusammenziehungen</term> + + <listitem> + <para>Verwenden Sie keine Zusammenziehungen, sondern schreiben + Sie die Phrase immer aus. Die Schreibweise + <quote>Don't use contractions.</quote> wäre also nicht + korrekt.</para> + + <para>Die Vermeidung von Zusammenziehungen sorgt für einen + etwas formelleren Ton, ist präziser und erleichtert die + Arbeit der Übersetzer.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Nutzung von Kommas bei Aufzählungen</term> + + <listitem> + <para>Bei einer Aufzählung innerhalb eines Absatzes sollten + Sie zwischen den einzelnen Begriffen Kommas setzen. Zwischen + dem letzten und vorletzten Begriff setzen Sie ein Komma und + das Wort <quote>und</quote>.</para> + + <para>Dazu ein Beispiel:</para> + + <blockquote> + <para>Das ist eine Liste von ein, zwei und drei Dingen.</para> + </blockquote> + + <para>Handelt es sich dabei um eine Liste von drei Begriffen, + <quote>ein</quote>, <quote>zwei</quote>, und + <quote>drei</quote>, oder um eine Liste von zwei Begriffen, + <quote>ein</quote> und <quote>zwei und drei</quote>?</para> + + <para>Es ist daher besser, explizit ein serielles Komma zu + setzen:</para> + + <blockquote> + <para>Das ist eine Liste von ein, zwei, und drei Dingen.</para> + </blockquote> + </listitem> + </varlistentry> + + <varlistentry> + <term>Vermeidung von redundanten Begriffen</term> + + <listitem> + <para>Versuchen Sie, keine redundanten Phrasen zu verwenden. + Dies gilt insbesondere für die Ausdrücke + <quote>der Befehl</quote>, <quote>die Datei</quote>, und + <quote>man command</quote>.</para> + + <para>Die folgenden zwei Beispiele veranschaulichen dies + für Befehle. Bevorzugt wird die Schreibweise des + zweiten Beispiels.</para> + + <informalexample> + <para>Verwenden Sie den Befehl <command>cvsup</command>, um + Ihre Quellen zu aktualisieren.</para> + </informalexample> + + <informalexample> + <para>Verwenden Sie <command>cvsup</command>, um Ihre Quellen + zu aktualisieren.</para> + </informalexample> + + <para>Analoges gilt für Dateinamen, wobei wiederum die + zweite Schreibweise bevorzugt wird.</para> + + <informalexample> + <para>… in der Datei + <filename>/etc/rc.local</filename>…</para> + </informalexample> + + <informalexample> + <para>… in + <filename>/etc/rc.local</filename>…</para> + </informalexample> + + <para>Auch für Manualpages gibt es zwei Schreibweisen. + Auch hier wird die zweite Schreibweise bevorzugt (das + zweite Beispiel nutzt das Tag + <sgmltag>citerefentry</sgmltag>).</para> + + <informalexample> + <para>Weitere Informationen finden Sie in + <command>man csh</command>.</para> + </informalexample> + + <informalexample> + <para>Weitere Informationen finden Sie in &man.csh.1;.</para> + </informalexample> + </listitem> + </varlistentry> + <varlistentry> + <term>Zwei Leerzeichen am Satzende</term> + + <listitem> + <para>Verwenden Sie immer zwei Leerzeichen am Ende eines Satzes. + Dadurch erhöht sich die Lesbarkeit des Textes und die + Nutzung von Werkzeugen wie <application>Emacs</application> + wird vereinfacht.</para> + + <para>Nun könnte man behaupten, dass ein Punkt vor einem + Großbuchstaben das Satzende markiert. Vor allem bei + Namen, beispielsweise bei <quote>Jordan K. Hubbard</quote>, + ist dies allerdings nicht der Fall. Wir haben hier ein + großes <literal>H</literal>, gefolgt von einem Punkt + und einem Leerzeichen. Dennoch handelt es sich nicht um + den Anfang eines neuen Satzes.</para> + </listitem> + </varlistentry> + </variablelist> + + <para>Eine ausführliche Beschreibung des korrekten Schreibstils + finden Sie im Buch <ulink url="http://www.bartleby.com/141/">Elements + of Style</ulink> von William Strunk.</para> + + <sect1 id="writing-style-guide"> + <title>Anleitungen für einen korrekten Schreibstil</title> + + <para>Damit die Quellen der Dokumentation selbst dann konsistent + bleiben, wenn viele Leute daran arbeiten, folgen Sie bitte den + folgenden Konventionen.</para> + + <sect2> + <title>Groß- und Kleinschreibung</title> + + <para>Tags werden in Kleinbuchstaben geschrieben, Sie schreiben + also <literal><para></literal>, <emphasis>nicht</emphasis> + <literal><PARA></literal>.</para> + + <para>Text im SGML-Kontext wird hingegen in Großbuchstaben + geschrieben. Man schreibt also + <literal><!ENTITY…></literal> und + <literal><!DOCTYPE…></literal>, + <emphasis>nicht</emphasis> + <literal><!entity…></literal> und + <literal><!doctype…></literal>.</para> + </sect2> + + <sect2> + <title>Abkürzungen (Akronyme)</title> + + <para>Abkürzungen sollten bei ihrer ersten Verwendung immer + ausgeschrieben werden. Man schreibt also beispielsweise + "Network Time Protocol + (<acronym role="Network Time Protocol">NTP</acronym>)." Nachdem + die Abkürzung definiert wurde, sollte hingegen nur noch die + Abkürzung verwendet werden, es sei denn, die Verwendung des + gesamten Begriffes macht im jeweiligen Kontext mehr Sinn. + Im Normalfall werden Akronyme in jedem Buch nur einmal definiert. + Es ist allerdings auch möglich, sie für jedes Kapitel + erneut zu definieren.</para> + + <para>Die drei ersten Vorkommen der Abkürzung sollten in + <acronym>-Tags eingeschlossen werden. Zusätzlich + wird ein <literal>role</literal>-Attribut mit dem + vollständigen Begriff definiert. Dadurch kann ein Link + zu einem Glossar erzeugt werden. Außerdem wird der + komplette Begriff angezeigt, wenn man den Mauscursor über + die Abkürzung bewegt.</para> + </sect2> + + <sect2> + <title>Einrückung</title> + + <para>Die erste Zeile jeder Datei hat die Einrückung 0, und + zwar <emphasis>unabhängig</emphasis> von der Einrückung + der Datei, in der sie enthalten ist.</para> + + <para>Öffnende Tags erhöhen die Einrückung um zwei + Leerzeichen. Schließende Tags verringern sie hingegen um + zwei Leerzeichen. Ein Block von acht Leerzeichen wird durch + einen Tabulator ersetzt. Ein solcher Block beginnt immer am + Anfang einer Zeile, führende Leerzeichen sind hier also + nicht erlaubt. Vermeiden Sie außerdem Leerzeichen am + Zeilenende. Der Inhalt von Elementen wird um zwei Leerzeichen + eingerückt, wenn er sich über mehr als eine Zeile + erstreckt.</para> + + <para>Der Quellcode dieses Abschnitts sieht daher in etwa so + aus:</para> + + <programlisting><![ CDATA [+--- Einrückung (Spalte) 0 +V +<chapter> + <title>...</title> + + <sect1> + <title>...</title> + + <sect2> + <title>Einrückung</title> + + <para>Die erste Zeile jeder Datei hat die Einrückung 0, und + zwar <emphasis>unabhängig</emphasis> von der Einrückung + der Datei, in der sie enthalten ist.</para> + + ... + </sect2> + </sect1> +</chapter>]]></programlisting> + + <para>Wenn Sie <application>Emacs</application> oder + <application>XEmacs</application> verwenden, um Ihre Dateien zu + bearbeiten, sollte der <literal>sgml-mode</literal> automatisch + geladen werden, und die lokalen + <application>Emacs</application>-Variablen am Ende einer Datei + sollten diesen Stil erzwingen.</para> + + <para>Verwenden Sie <application>Vim</application>, sollten Sie + Ihren Editor so konfigurieren:</para> + + <programlisting>augroup sgmledit + autocmd FileType sgml set formatoptions=cq2l " Special formatting options + autocmd FileType sgml set textwidth=70 " Wrap lines at 70 spaces + autocmd FileType sgml set shiftwidth=2 " Automatically indent + autocmd FileType sgml set softtabstop=2 " Tab key indents 2 spaces + autocmd FileType sgml set tabstop=8 " Replace 8 spaces with a tab + autocmd FileType sgml set autoindent " Automatic indentation +augroup END</programlisting> + + </sect2> + + <sect2> + <title>Die korrekte Schreibweise von Tags</title> + + <sect3> + <title>Einrücken von Tags</title> + + <para>Tags, die die gleiche Einrückung aufweisen wie das + vorangegangene Tag, sollten durch eine Leerzeile getrennt + werden, Tags mit unterschiedlicher Einrückung hingegen + nicht:</para> + + <informalexample> + <programlisting><![ CDATA [<article> + <articleinfo> + <title>NIS</title> + + <pubdate>October 1999</pubdate> + + <abstract> + <para>... + ... + ...</para> + </abstract> + </articleinfo> + + <sect1> + <title>...</title> + + <para>...</para> + </sect1> + + <sect1> + <title>...</title> + + <para>...</para> + </sect1> +</article>]]></programlisting> + </informalexample> + </sect3> + + <sect3> + <title>Gliederung von Tags</title> + + <para>Tags wie zum Beispiel <sgmltag>itemizedlist</sgmltag>, die + immer weitere Tags einschließen und selbst keine Zeichen + enthalten, befinden sich immer in einer eigenen Zeile.</para> + + <para>Tags wie <sgmltag>para</sgmltag> und + <sgmltag>term</sgmltag> können selbst Text enthalten, + und ihr Inhalt beginnt direkt nach dem Tag, und zwar + <emphasis>in der gleichen Zeile</emphasis>.</para> + + <para>Dies gilt analog, wenn diese zwei Tag-Arten wieder + geschlossen werden.</para> + + <para>Eine Vermischung dieser Tags kann daher zu Problemen + führen.</para> + + <para>Wenn auf ein Start-Tag, das keine Zeichen enthalten kann, + unmittelbar ein Tag folgt, das andere Tags einschließen + muss, um Zeichen darzustellen, befinden sich diese Tags auf + verschiedenen Zeilen. Das zweite Tag wird dabei + entsprechend eingerückt.</para> + + <para>Wenn ein Tag, das Zeichen enthalten kann, direkt nach + einem Tag, das keine Zeichen enthalten kann, geschlossen wird, + befinden sich beide Tags in der gleichen Zeile.</para> + </sect3> + </sect2> + + <sect2> + <title>Markup-Änderungen (<foreignphrase>white space + changes</foreignphrase>)</title> + + <para>Wenn Sie Änderungen committen, <emphasis>committen Sie + niemals Inhalts- und Formatierungsänderungen zur gleichen + Zeit</emphasis>.</para> + + <para>Nur auf diese Weise können die Übersetzungs-Teams + sofort erkennen, welche Änderungen durch Ihren Commit + verursacht wurden, ohne darüber nachdenken zu müssen, + ob sich eine Zeile geädert hat, weil Sie den Inhalt + geändert haben, oder weil Sie sie nur umformatiert + haben.</para> + + <para>Nehmen wir an, Sie haben zwei Sätze in einen Absatz + eingefügt. Daher sind zwei Zeilen nun länger als + 80 Zeichen. Zuerst committen Sie Ihre inhaltliche + Änderung inklusive der zu langen Zeilen. Im nächsten + Commit korrigieren Sie den Zeilenumbruch und geben in der + Commit-Mitteilung an, dass es sich nur um Änderung am + Markup handelt (<foreignphrase>whitespace-only + change</foreignphrase>), und Übersetzer den Commit daher + ignorieren können.</para> + </sect2> + + <sect2> + <title>Vermeiden von fehlerhaften Zeilenumbrüchen + (Nutzung von <foreignphrase>nonbreaking space</foreignphrase>)</title> + + <para>Vermeiden Sie Zeilenumbrüche an Stellen, an denen diese + häßlich aussehen oder es erschweren, einem Satz zu + folgen. Zeilenumbrüche hängen von der Breite des + gewählten Augabemedium ab. Insbesondere bei der Verwendung + von Textbrowsern können schlecht formatierte Absätze + wie der folgende entstehen:</para> + + <literallayout class="monospaced">Data capacity ranges from 40 MB to 15 +GB. Hardware compression …</literallayout> + + <para>Die Nutzung der Entity <literal>&nbsp;</literal> + verhindert Zeilenumbrüche zwischen zusammengehörenden + Teilen. Verwenden Sie <foreignphrase>nonbreaking + spaces</foreignphrase> daher in den folgenden Fällen:</para> + + <itemizedlist> + <listitem> + <para>Zwischen Zahlen und Einheiten:</para> + <programlisting><![ CDATA [57600 bps]]></programlisting> + </listitem> + + <listitem> + <para>Zwischen Programmnamen und Versionsnummern:</para> + <programlisting><![ CDATA [FreeBSD 4.7]]></programlisting> + </listitem> + + <listitem> + <para>Zwischen mehreren zusammengehörenden Wörtern + (Vorsicht bei Namen, die aus mehr als 3-4 Wörtern + bestehen, wie <quote>The FreeBSD Brazilian Portuguese + Documentation Project</quote>):</para> + <programlisting><![ CDATA [Sun Microsystems]]></programlisting> + </listitem> + </itemizedlist> + </sect2> + </sect1> + + <sect1 id="writing-style-word-list"> + <title>Häufig verwendete Wörter</title> + + <para>Die folgende Liste enthält einige Beispiele, wie + bestimmte Wörter innerhalb des FreeBSD + Documentation Projects geschrieben werden. Finden Sie ein + gesuchtes Wort hier nicht, sehen Sie bitte in der <ulink + url="http://www.oreilly.com/oreilly/author/stylesheet.html"> + Liste häufig verwendeter Wörter von + O'Reilly</ulink> nach.</para> + + <itemizedlist> + <listitem> + <para>2.2.X</para> + </listitem> + + <listitem> + <para>4.X-STABLE</para> + </listitem> + + <listitem> + <para>CDROM</para> + </listitem> + + <listitem> + <para>DoS <emphasis>(Denial of Service)</emphasis> </para> + </listitem> + + <listitem> + <para>FreeBSD Ports Collection</para> + </listitem> + + <listitem> + <para>IPsec</para> + </listitem> + + <listitem> + <para>Internet</para> + </listitem> + + <listitem> + <para>MHz</para> + </listitem> + + <listitem> + <para>Soft Updates</para> + </listitem> + + <listitem> + <para>Unix</para> + </listitem> + + <listitem> + <para>disk label</para> + </listitem> + + <listitem> + <para>email</para> + </listitem> + + <listitem> + <para>file system</para> + </listitem> + + <listitem> + <para>manual page</para> + </listitem> + + <listitem> + <para>mail server</para> + </listitem> + + <listitem> + <para>name server</para> + </listitem> + + <listitem> + <para>ports collection</para> + </listitem> + + <listitem> + <para>web server</para> + </listitem> + </itemizedlist> + + </sect1> </chapter> <!-- |