[MANUAL] German:

 - added review

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@23479 44c647ce-9c0f-0410-b52a-842ac1e357ba

documentation/manual/de/ref/documentation-standard.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!-- EN-Revision: 22743 -->
-<!-- Reviewed: no -->
+<!-- Reviewed: 22743 -->
 <appendix id="doc-standard">
     <title>Zend Framework Dokumentations Standard</title>
 
@@ -12,9 +12,9 @@
 
             <para>
                 Dieses Dokument bietet Richtlinien für die Erstellung der End-Benutzer
-                Dokumentation die im Zend Framework gefunden werden kann. Es ist als Richtlinie
+                Dokumentation, die im Zend Framework gefunden werden kann. Es ist als Richtlinie
                 für die Mitglieder des Zend Framework gedacht, welche Dokumentationen als Teil
-                Ihrer übermittelten Komponenten Dokumentation schreiben müssen, sowie für die
+                ihrer übermittelten Komponenten Dokumentation schreiben müssen, sowie für die
                 Übersetzer von Dokumentation. Der hier enthaltene Standard ist gedacht für einfache
                 Übersetzung von Dokumentationen, minimalisieren von Visualisierung und
                 stylistischen Unterschieden zwischen den unterschiedlichen Dokumentationsdateien,
@@ -29,7 +29,7 @@
             </para>
 
             <para>
-                Themen die im Zend Framework Dokumentations Standard beschrieben sind enthalten die
+                Themen, die im Zend Framework Dokumentations Standard beschrieben sind, enthalten die
                 Formatierung von Dokumentationsdateien sowie Empfehlungen für die Qualität der
                 Dokumentation.
             </para>
@@ -43,7 +43,7 @@
             <title>XML Tags</title>
 
             <para>
-                Jede Datei des Manuals muß die folgenden <acronym>XML</acronym> Deklarationen am
+                Jede Datei des Manuals muss die folgenden <acronym>XML</acronym> Deklarationen am
                 Beginn der Datei enthalten:
             </para>
 
@@ -54,7 +54,7 @@
 
             <para>
                 <acronym>XML</acronym> Dateien von übersetzten Sprachen müssen auch ein Revisions
-                Tag enthalten das mit der Revision der englischen Sprachdatei korrespondiert auf
+                Tag enthalten, das mit der Revision der englischen Sprachdatei korrespondiert, auf
                 der die Übersetzung basiert.
             </para>
 
@@ -84,7 +84,7 @@
             </para>
 
             <para>
-                Tags welche auf dem gleichen Level sind müssen auch die gleiche Einrückung haben.
+                Tags, welche auf dem gleichen Level sind, müssen auch die gleiche Einrückung haben.
             </para>
 
             <programlisting language="xml"><![CDATA[
@@ -96,7 +96,7 @@
 ]]></programlisting>
 
             <para>
-                Tags welche ein Level unter dem vorhergehenden Tag sind müssen mit 4 zusätzlichen
+                Tags, welche ein Level unter dem vorhergehenden Tag sind, müssen mit 4 zusätzlichen
                 Leerzeichen eingerückt werden.
             </para>
 
@@ -125,18 +125,18 @@
         </sect2>
 
         <sect2 id="doc-standard.file-formatting.line-termination">
-            <title>Zeilen Begrenzung</title>
+            <title>Zeilenendekennzeichen</title>
 
             <para>
-                Die Zeilen Begrenzung folgt der Unix Textdatei Konvention. Zeilen müssen mit einem
+                Die Zeilenendekennzeichen folgt der Unix Textdatei Konvention. Zeilen müssen mit einem
                 einzelnen Linefeed (LF) Zeichen enden. Linefeed Zeichen werden als ordinale 10,
                 oder Hexadezimale 0x0A repräsentiert.
             </para>
 
             <para>
-                Beachte: Es sind keine Carriage Returns (<acronym>CR</acronym>) zu verwenden welche
+                Beachte: Es sind keine Carriage Returns (<acronym>CR</acronym>) zu verwenden, welche
                 die Konvention in Apple OS's (0x0D) sind, oder die Carriage Return - Linefeed
-                Kombination (<acronym>CRLF</acronym>) welche der Standard für Windows OS (0x0D,
+                Kombination (<acronym>CRLF</acronym>), welche der Standard für Windows OS (0x0D,
                 0x0A) sind.
             </para>
         </sect2>
@@ -166,7 +166,7 @@
                 <title>Leerzeichen in Tags</title>
 
                 <para>
-                    Öffnende Block Tags sollten direkt nach Ihnen keine Leerzeichen haben sondern
+                    Öffnende Block Tags sollten direkt anschliessend keine Leerzeichen haben, sondern
                     nur einen Zeilenumbruch (und Einrückungen in der folgenden Zeile).
                 </para>
 
@@ -177,7 +177,7 @@
 ]]></programlisting>
 
                 <para>
-                    Öffnende Inline Tags sollten keine Leerzeichen haben die Ihnen direkt folgen.
+                    Öffnende Inline Tags sollten keine Leerzeichen haben, die direkt folgen.
                 </para>
 
                 <programlisting language="xml"><![CDATA[
@@ -189,7 +189,7 @@ Das ist die Klasse <classname>Zend_Class</classname>.
 ]]></programlisting>
 
                 <para>
-                    Schließenden Block Tags können Leerzeichen vorangestellt sein die dem aktuellen
+                    Schließenden Block Tags können Leerzeichen vorangestellt sein, die dem aktuellen
                     Einrückungslevel entsprechen, aber nicht mehr als diese Anzahl.
                 </para>
 
@@ -252,7 +252,7 @@ Das ist die Klasse <classname>Zend_Class</classname>
                 <title>Trennung zwischen Tags</title>
 
                 <para>
-                    Tags auf dem gleichen Level müssen durch eine leere Zeile getrennt sein um die
+                    Tags auf dem gleichen Level müssen durch eine leere Zeile getrennt sein, um die
                     Lesbarkeit zu erhöhen.
                 </para>
 
@@ -277,8 +277,8 @@ Das ist die Klasse <classname>Zend_Class</classname>
 
                 <para>
                     Das erste Untertag sollte direkt unterhalb seiner Eltern geöffnet werden, ohne
-                    das eine leere Zeile zwischen Ihnen ist; das letzte Untertag solte direkt vor
-                    dem Schließenden Tag seiner Eltern geschlossen werden.
+                    dass eine leere Zeile zwischen ihnen ist; das letzte Untertag sollte direkt vor
+                    dem schließenden Tag seiner Eltern geschlossen werden.
                 </para>
 
                 <programlisting language="xml"><![CDATA[
@@ -312,7 +312,7 @@ Das ist die Klasse <classname>Zend_Class</classname>
         </sect2>
 
         <sect2 id="doc-standard.file-formatting.program-listing">
-            <title>Programm Auflistungen</title>
+            <title>Programmcode-Abschnitte</title>
 
             <para>
                 Das öffnende <emphasis>&lt;programlisting&gt;</emphasis> Tag muss das richtige
@@ -327,12 +327,12 @@ Das ist die Klasse <classname>Zend_Class</classname>
 ]]></programlisting>
 
             <para>
-                <acronym>CDATA</acronym> sollte um alle Programm Auflistungen vorhanden sein.
+                <acronym>CDATA</acronym> sollte um alle Programmcode-Abschnitte vorhanden sein.
             </para>
 
             <para>
-                <emphasis>&lt;programlisting&gt;</emphasis> Sektionen dürfen keine Zeilenumbrüche
-                oder Leerzeichen am Anfang oder Ende der Sektion besitzen, da diese auch in der
+                <emphasis>&lt;programlisting&gt;</emphasis> Abschnitte dürfen keine Zeilenumbrüche
+                oder Leerzeichen am Anfang oder Ende des Abschnitts besitzen, da diese auch in der
                 endgültigen Ausgabe dargestellt werden.
             </para>
 
@@ -374,8 +374,8 @@ $render = "xxx";
 ]]></programlisting>
 
             <para>
-                Das <emphasis>&lt;programlisting&gt;</emphasis> Tag sollte das "language" Atribut
-                mit einem Wert enthalten der dem Inhalt der Programm Auflistung entspricht.
+                Das <emphasis>&lt;programlisting&gt;</emphasis> Tag sollte das "language" Attribut
+                mit einem Wert enthalten, der dem Inhalt des Programmcode-Abschnitts entspricht.
                 Typischerweise enthält es die Werte "css", "html", "ini", "javascript", "php",
                 "text", und "xml".
             </para>
@@ -392,8 +392,8 @@ $render = "xxx";
 ]]></programlisting>
 
             <para>
-                Für Programm Auflistungen die nur <acronym>PHP</acronym> Code enthalten werden
-                keine <acronym>PHP</acronym> Tags (wie z.B. "&lt;?php", "?&gt;") benötigt, und
+                Für Programmcode-Abschnitte, die nur <acronym>PHP</acronym> Code enthalten, werden
+                keine <acronym>PHP</acronym>-Tags (wie z.B. "&lt;?php", "?&gt;") benötigt, und
                 sollten auch nicht verwendet werden. Sie zeigen nur das Naheliegendste und werden
                 durch die Verwendung des <emphasis>&lt;programlisting&gt;</emphasis> Tags
                 impliziert.
@@ -413,7 +413,7 @@ $render = "xxx";
 ]]></programlisting>
 
             <para>
-                Die Zeilenlängen in Programm Auflistungen sollten den <link
+                Die Zeilenlängen in Programmcode-Abschnitten sollten den <link
                     linkend="coding-standard.php-file-formatting.max-line-length">Coding Standard
                     Empfehlungen</link> folgen.
             </para>
@@ -421,9 +421,9 @@ $render = "xxx";
             <para>
                 <methodname>require_once()</methodname>, <methodname>require()</methodname>,
                 <methodname>include_once()</methodname> und <methodname>include()</methodname>
-                sollten innerhalb von <acronym>PHP</acronym> Auflistungen nicht verwendet werden.
-                Sie zeigen nur das naheliegendste, und sind meistens nicht notwendig wenn ein
-                Autoloader verwendet wird. Sie sollten nur verwendet werden wenn Sie essentiell
+                sollten innerhalb von <acronym>PHP</acronym>-Listings nicht verwendet werden.
+                Sie zeigen nur das Naheliegendste, und sind meistens nicht notwendig, wenn ein
+                Autoloader verwendet wird. Sie sollten nur verwendet werden, wenn sie essentiell
                 für das Beispiel sind.
             </para>
 
@@ -432,7 +432,7 @@ $render = "xxx";
 
                 <para>
                     Short Tags (z.B., "&lt;?", "&lt;?=") sollten niemals innerhalb von
-                    <emphasis>programlisting</emphasis> oder einer Dokuments verwendet werden.
+                    <emphasis>programlisting</emphasis> oder eines Dokuments verwendet werden.
                 </para>
             </note>
         </sect2>
@@ -444,7 +444,7 @@ $render = "xxx";
                 <title>classname</title>
 
                 <para>
-                    Das Tag <emphasis>&lt;classname&gt;</emphasis> muß jedesmal verwendet werden
+                    Das Tag <emphasis>&lt;classname&gt;</emphasis> muß jedesmal verwendet werden,
                     wenn ein Klassenname durch sich selbst repräsentiert wird; er sollte nicht
                     in Kombination mit einem Methodennamen, Variablennamen, oder einer Konstante
                     verwendet werden, und auch anderer Inhalt ist nicht innerhalb des Tags erlaubt.
@@ -461,7 +461,7 @@ $render = "xxx";
                 <title>varname</title>
 
                 <para>
-                    Variablen müssen im <emphasis>&lt;varname&gt;</emphasis> Tag eingehüllt sein.
+                    Variablen müssen im <emphasis>&lt;varname&gt;</emphasis> Tag eingeschlossen sein.
                     Variablen müssen mit Verwendung des "$" Siegels geschrieben werden. Kein
                     anderer Inhalt ist innerhalb des Tags erlaubt, ausser es wird ein Klassenname
                     verwendet, der eine Klassenvariable anzeigt.
@@ -483,7 +483,7 @@ $render = "xxx";
                     stehen. Methoden müssen entweder die komplette Methoden Signatur enthalten,
                     oder zumindest ein Paar schließender Klammern (z.B., "()"). Kein anderer
                     Inhalt ist innerhalb dieses Tags erlaubt, ausser es wird ein Klassenname
-                    verwendet der eine Klassenmethode anzeigt.
+                    verwendet, der eine Klassenmethode anzeigt.
                 </para>
 
                 <programlisting language="xml"><![CDATA[
@@ -583,18 +583,18 @@ $render = "xxx";
             <title>Editoren ohne Autoformatierung verwenden</title>
 
             <para>
-                Für die Bearbeitung der Dokumentation sollten typischerweise keine formale
-                <acronym>XML</acronym> Editoren verwendet werden. Solche Editoren formatieren
-                bestehende Dokumente normalerweise so das diese Ihren eigenen Standards folgen
+                Für die Bearbeitung der Dokumentation sollten typischerweise keine formalen
+                <acronym>XML</acronym>-Editoren verwendet werden. Solche Editoren formatieren
+                bestehende Dokumente normalerweise so, dass diese ihren eigenen Standards folgen
                 und folgen dem Docbook Standard nicht strikt. Als Beispiel haben wir gesehen
-                das Sie die <acronym>CDATA</acronym> Tags entfernen, die Trennung von 4 Leerzeichen
+                das sie die <acronym>CDATA</acronym> Tags entfernen, die Trennung von 4 Leerzeichen
                 zu Tabs oder 2 Leerzeichen  ändern, usw.
             </para>
 
             <para>
-                Die Styling Richtlinien wurde großteile geschrieben um Übersetzern zu helfen damit
-                diese durch Verwendung von normalen <command>diff</command> Tools erkennen welche
-                Zeilen sich geändert haben. Die Automatische formatierung macht diesen Prozess
+                Die Styling Richtlinien wurde großteils geschrieben, um Übersetzern zu helfen, damit
+                diese durch Verwendung von normalen <command>diff</command>-Tools erkennen, welche
+                Zeilen sich geändert haben. Die automatische Formatierung macht diesen Prozess
                 viel schwieriger.
             </para>
         </sect2>
@@ -603,10 +603,10 @@ $render = "xxx";
             <title>Verwendung von Bildern</title>
 
             <para>
-                Gute Bilder und Diagramme können die Lesbarkeit und Gemeinsamkeit erhöhen. Sie
-                sollten immer dann verwendet werden wenn Sie diesen Zielen helfen. Bilder sollten
+                Gute Bilder und Diagramme können die Lesbarkeit und das Verständnis erhöhen. Sie
+                sollten immer dann verwendet werden, wenn sie diesen Zielen helfen. Bilder sollten
                 im Verzeichnis <filename>documentation/manual/en/figures/</filename> platziert,
-                und nach dem Kapitel benannt werden in dem Sie vorkommen.
+                und nach dem Kapitel benannt werden, in dem sie vorkommen.
             </para>
         </sect2>
 
@@ -614,14 +614,14 @@ $render = "xxx";
             <title>Gute Fallbeispiele</title>
 
             <para>
-                Man sollte nach guten Fallbeispielen sehen die von der Community verbreitet werden.
-                Speziell jene die in den Kommentaren der Proposals oder einer der Mailing Listen
-                gesendet werden. Beispiel zeigen oft viel besser die Verwendung als es
+                Man sollte nach guten Fallbeispielen suchen, die von der Community verbreitet werden.
+                Speziell jene, die in den Kommentaren der Proposals oder einer der Mailing Listen
+                gesendet werden. Beispiel zeigen oft viel besser die Verwendung, als es
                 Beschreibungen tun.
             </para>
 
             <para>
-                Wenn man Beispiele für die Inkludierung in das Handbuch schreibt, sollte man
+                Wenn man Beispiele für die Aufnahme in das Handbuch schreibt, sollte man
                 allen Coding Standards und Dokumentations Standards folgen.
             </para>
         </sect2>
@@ -630,13 +630,13 @@ $render = "xxx";
             <title>Vermeide die Wiederholung von phpdoc Inhalten</title>
 
             <para>
-                Das Handbuch ist dazu gedacht ein Referenzhandbuch für die Verwendung durch
+                Das Handbuch ist dazu gedacht, ein Referenzhandbuch für die Verwendung durch
                 Endbenutzer zu sein. Die Wiederholung von phpdoc Dokumentation für intern
                 verwendete Komponenten und Klassen ist nicht erwünscht, und die Beschreibungen
-                sollten auf die Verwendung fokusiert sein, und nicht der internen Arbeitsweise.
-                In jedem Fall und zu jeder Zeit wollen wir das sich die Dokumentations-Team auf
-                die Übersetzung des englischen Handbuchs und nicht den phpdoc Kommentaren
-                fokusiert.
+                sollten auf die Verwendung fokussiert sein, und nicht der internen Arbeitsweise.
+                In jedem Fall und zu jeder Zeit wollen wir, dass sich die Dokumentations-Teams auf
+                die Übersetzung des englischen Handbuchs und nicht auf ide phpdoc Kommentare
+                fokussiert.
             </para>
         </sect2>
 
@@ -644,12 +644,12 @@ $render = "xxx";
             <title>Verwendung von Links</title>
 
             <para>
-                Links sollten zu anderen Sektionen des Handbuchs oder externen Quellen verweisen
+                Links sollten zu anderen Abschnitten des Handbuchs oder externen Quellen verweisen,
                 statt Dokumentation zu wiederholen.
             </para>
 
             <para>
-                Die Verlinkung zu anderen Sektionen des Handbuchs kann durchgeführt werden indem
+                Die Verlinkung zu anderen Abschnitten des Handbuchs kann durchgeführt werden, indem
                 das <emphasis>&lt;link&gt;</emphasis> Tag verwendet wird (für welches man den Link
                 Text selbst angeben muß).
             </para>
@@ -663,7 +663,7 @@ $render = "xxx";
 ]]></programlisting>
 
             <para>
-                Um auf eine externe Ressource zu verweisen muß <emphasis>&lt;ulink&gt;</emphasis>
+                Um auf eine externe Ressource zu verweisen, muss <emphasis>&lt;ulink&gt;</emphasis>
                 verwendet werden:
             </para>