|
@@ -11,38 +11,40 @@
|
|
|
<title>Ziele</title>
|
|
<title>Ziele</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- This document provides guidelines for creation of the end-user
|
|
|
|
|
- documentation found within Zend Framework. It is intended as a
|
|
|
|
|
- guide to Zend Framework contributors, who must write
|
|
|
|
|
- documentation as part of component contributions, as well as to
|
|
|
|
|
- documentation translators. The standards contained herein are
|
|
|
|
|
- intended to ease translation of documentation, minimize
|
|
|
|
|
- visual and stylistic differences between different documentation
|
|
|
|
|
- files, and make finding changes in documentation easier with
|
|
|
|
|
- <command>diff</command> tools.
|
|
|
|
|
|
|
+ Dieses Dokument bietet Richtlinien für die Erstellung der End-Benutzer
|
|
|
|
|
+ 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
|
|
|
|
|
+ Ü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,
|
|
|
|
|
+ und macht das Finden von Änderungen in der Dokumentation einfacher mit
|
|
|
|
|
+ <command>diff</command> Tools.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- You may adopt and/or modify these standards in accordance with the terms of our
|
|
|
|
|
- <ulink url="http://framework.zend.com/license">license</ulink>.
|
|
|
|
|
|
|
+ Man kann diese Standards zusammen mit den Regeln unserer
|
|
|
|
|
+ <ulink url="http://framework.zend.com/license">Lizenz</ulink> adoptieren und oder
|
|
|
|
|
+ modifizieren.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Topics covered in the ZF documentation standards include documentation file
|
|
|
|
|
- formatting and recommendations for documentation quality.
|
|
|
|
|
|
|
+ Themen die im ZF Dokumentations Standard beschrieben sind enthalten die
|
|
|
|
|
+ Formatierung von Dokumentationsdateien sowie Empfehlungen für die Qualität der
|
|
|
|
|
+ Dokumentation.
|
|
|
</para>
|
|
</para>
|
|
|
</sect2>
|
|
</sect2>
|
|
|
</sect1>
|
|
</sect1>
|
|
|
|
|
|
|
|
<sect1 id="doc-standard.file-formatting">
|
|
<sect1 id="doc-standard.file-formatting">
|
|
|
- <title>Documentation File Formatting</title>
|
|
|
|
|
|
|
+ <title>Formatierung von Dokumentationsdateien</title>
|
|
|
|
|
|
|
|
<sect2 id="doc-standard.file-formatting.xml-tags">
|
|
<sect2 id="doc-standard.file-formatting.xml-tags">
|
|
|
<title>XML Tags</title>
|
|
<title>XML Tags</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Each manual file must include the following <acronym>XML</acronym> declarations at
|
|
|
|
|
- the top of the file:
|
|
|
|
|
|
|
+ Jede Datei des Manuals muß die folgenden <acronym>XML</acronym> Deklarationen am
|
|
|
|
|
+ Beginn der Datei enthalten:
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
@@ -51,9 +53,9 @@
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- <acronym>XML</acronym> files from translated languages must also include a revision
|
|
|
|
|
- tag containing the revision of the corresponding English-language file the
|
|
|
|
|
- translation was based on.
|
|
|
|
|
|
|
+ <acronym>XML</acronym> Dateien von übersetzten Sprachen müssen auch ein Revisions
|
|
|
|
|
+ Tag enthalten das mit der Revision der englischen Sprachdatei korrespondiert auf
|
|
|
|
|
+ der die Übersetzung basiert.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
@@ -64,21 +66,26 @@
|
|
|
</sect2>
|
|
</sect2>
|
|
|
|
|
|
|
|
<sect2 id="doc-standard.file-formatting.max-line-length">
|
|
<sect2 id="doc-standard.file-formatting.max-line-length">
|
|
|
- <title>Maximum Line Length</title>
|
|
|
|
|
|
|
+ <title>Maximale Zeilenlänge</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- The maximum line length, including tags, attributes, and indentation, is not to
|
|
|
|
|
- exceed 100 characters. There is only one exception to this rule: attribute/value
|
|
|
|
|
- pairs are allowed to exceed the 100 chars as they are not allowed to be seperated.
|
|
|
|
|
|
|
+ Die maximale Zeilenlänge, inklusive Tags, Attribute und Einrückungen, darf 100
|
|
|
|
|
+ Zeichen nicht überschreiten. Es gibt nur eine einzige Ausnahme zu dieser Regel:
|
|
|
|
|
+ Attributen und Werte Paaren ist es erlaubt die 100 Zeichen zu überschreiten wenn
|
|
|
|
|
+ diese nicht getrennt werden dürfen.
|
|
|
</para>
|
|
</para>
|
|
|
</sect2>
|
|
</sect2>
|
|
|
|
|
|
|
|
<sect2 id="doc-standard.file-formatting.indentation">
|
|
<sect2 id="doc-standard.file-formatting.indentation">
|
|
|
- <title>Indentation</title>
|
|
|
|
|
|
|
+ <title>Einrückung</title>
|
|
|
|
|
|
|
|
- <para>Indentation should consist of 4 spaces. Tabs are not allowed.</para>
|
|
|
|
|
|
|
+ <para>
|
|
|
|
|
+ Eine Einrückung sollte aus 4 Leerzeichen bestehen. Tabulatoren sind nicht erlaubt.
|
|
|
|
|
+ </para>
|
|
|
|
|
|
|
|
- <para>Tags which are at the same level must have the same indentation.</para>
|
|
|
|
|
|
|
+ <para>
|
|
|
|
|
+ Tags welche auf dem gleichen Level sind müssen auch die gleiche Einrückung haben.
|
|
|
|
|
+ </para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
<sect1>
|
|
<sect1>
|
|
@@ -89,8 +96,8 @@
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Tags which are one level under the previous tag must be indented with 4 additional
|
|
|
|
|
- spaces.
|
|
|
|
|
|
|
+ Tags welche ein Level unter dem vorhergehenden Tag sind müssen mit 4 zusätzlichen
|
|
|
|
|
+ Leerzeichen eingerückt werden.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
@@ -101,49 +108,50 @@
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Multiple block tags within the same line are not allowed; multiple inline tags are
|
|
|
|
|
- allowed, however.
|
|
|
|
|
|
|
+ Mehrere Block Tags in der gleichen Zeile sind nicht erlaubt; mehrere Inline Tags
|
|
|
|
|
+ sind trotzdem erlaubt.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
-<!-- NOT ALLOWED: -->
|
|
|
|
|
|
|
+<!-- NICHT ERLAUBT -->
|
|
|
<sect1><sect2>
|
|
<sect1><sect2>
|
|
|
</sect2></sect1>
|
|
</sect2></sect1>
|
|
|
|
|
|
|
|
-<!-- ALLOWED -->
|
|
|
|
|
|
|
+<!-- ERLAUBT -->
|
|
|
<para>
|
|
<para>
|
|
|
- <code>Zend_Magic</code> does not exist. <code>Zend_Acl</code> does.
|
|
|
|
|
|
|
+ <code>Zend_Magic</code> existiert nicht. <code>Zend_Acl</code> existiert.
|
|
|
</para>
|
|
</para>
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
</sect2>
|
|
</sect2>
|
|
|
|
|
|
|
|
<sect2 id="doc-standard.file-formatting.line-termination">
|
|
<sect2 id="doc-standard.file-formatting.line-termination">
|
|
|
- <title>Line Termination</title>
|
|
|
|
|
|
|
+ <title>Zeilen Begrenzung</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Line termination follows the Unix text file convention. Lines must end with a
|
|
|
|
|
- single linefeed (LF) character. Linefeed characters are represented as ordinal 10,
|
|
|
|
|
- or hexadecimal 0x0A.
|
|
|
|
|
|
|
+ Die Zeilen Begrenzung 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>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Note: Do not use carriage returns (<acronym>CR</acronym>) as is the convention in
|
|
|
|
|
- Apple OS's (0x0D) or the carriage return - linefeed combination
|
|
|
|
|
- (<acronym>CRLF</acronym>) as is standard for the Windows OS (0x0D, 0x0A).
|
|
|
|
|
|
|
+ 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,
|
|
|
|
|
+ 0x0A) sind.
|
|
|
</para>
|
|
</para>
|
|
|
</sect2>
|
|
</sect2>
|
|
|
|
|
|
|
|
<sect2 id="doc-standard.file-formatting.empty-tags">
|
|
<sect2 id="doc-standard.file-formatting.empty-tags">
|
|
|
- <title>Empty tags</title>
|
|
|
|
|
|
|
+ <title>Leere Tags</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Empty tags are not allowed; all tags must contain text or child tags.
|
|
|
|
|
|
|
+ Leere Tags sind nicht erlaubt; alle Tags müssen Text oder Untertags enthalten.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
-<!-- NOT ALLOWED -->
|
|
|
|
|
|
|
+<!-- NICHT ERLAUBT -->
|
|
|
<para>
|
|
<para>
|
|
|
- Some text. <link></link>
|
|
|
|
|
|
|
+ Irgendein Text. <link></link>
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
@@ -152,41 +160,41 @@
|
|
|
</sect2>
|
|
</sect2>
|
|
|
|
|
|
|
|
<sect2 id="doc-standard.file-formatting.whitespace">
|
|
<sect2 id="doc-standard.file-formatting.whitespace">
|
|
|
- <title>Usage of whitespace within documents</title>
|
|
|
|
|
|
|
+ <title>Verwendung von Leerzeichen in Dokumenten</title>
|
|
|
|
|
|
|
|
<sect3 id="doc-standard.file-formatting.whitespace.trailing">
|
|
<sect3 id="doc-standard.file-formatting.whitespace.trailing">
|
|
|
- <title>Whitespace within tags</title>
|
|
|
|
|
|
|
+ <title>Leerzeichen in Tags</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Opening block tags should have no whitespace immediately following them other
|
|
|
|
|
- than line breaks (and indentation on the following line).
|
|
|
|
|
|
|
+ Öffnende Block Tags sollten direkt nach Ihnen keine Leerzeichen haben sondern
|
|
|
|
|
+ nur einen Zeilenumbruch (und Einrückungen in der folgenden Zeile).
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
-<!-- NOT ALLOWED -->
|
|
|
|
|
-<sect1>WHITESPACE
|
|
|
|
|
|
|
+<!-- NICHT ERLAUBT -->
|
|
|
|
|
+<sect1>LEERZEICHEN
|
|
|
</sect1>
|
|
</sect1>
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Opening inline tags should have no whitespace immediately following them.
|
|
|
|
|
|
|
+ Öffnende Inline Tags sollten keine Leerzeichen haben die Ihnen direkt folgen.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
-<!-- NOT ALLOWED -->
|
|
|
|
|
-This is the class <classname> Zend_Class</classname>.
|
|
|
|
|
|
|
+<!-- NICHT ERLAUBT -->
|
|
|
|
|
+Das ist die Klasse <classname> Zend_Class</classname>.
|
|
|
|
|
|
|
|
<!-- OK -->
|
|
<!-- OK -->
|
|
|
-This is the class <classname>Zend_Class</classname>.
|
|
|
|
|
|
|
+Das ist die Klasse <classname>Zend_Class</classname>.
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Closing block tags may be preceded by whitespace equivalent to the current
|
|
|
|
|
- indentation level, but no more than that amount.
|
|
|
|
|
|
|
+ Schließenden Block Tags können Leerzeichen vorangestellt sein die dem aktuellen
|
|
|
|
|
+ Einrückungslevel entsprechen, aber nicht mehr als diese Anzahl.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
-<!-- NOT ALLOWED -->
|
|
|
|
|
|
|
+<!-- NICHT ERLAUBT -->
|
|
|
<sect1>
|
|
<sect1>
|
|
|
</sect1>
|
|
</sect1>
|
|
|
|
|
|
|
@@ -196,85 +204,85 @@ This is the class <classname>Zend_Class</classname>.
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Closing inline tags must not be preceded by any whitespace.
|
|
|
|
|
|
|
+ Schließenden Inline Tags dürfen keine Leerzeichen vorangestellt sein.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
-<!-- NOT ALLOWED -->
|
|
|
|
|
-This is the class <classname>Zend_Class </classname>
|
|
|
|
|
|
|
+<!-- NICHT ERLAUBT -->
|
|
|
|
|
+Das ist die Klasse <classname>Zend_Class </classname>
|
|
|
|
|
|
|
|
<!-- OK -->
|
|
<!-- OK -->
|
|
|
-This is the class <classname>Zend_Class</classname>
|
|
|
|
|
|
|
+Das ist die Klasse <classname>Zend_Class</classname>
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
</sect3>
|
|
</sect3>
|
|
|
|
|
|
|
|
<sect3 id="doc-standard.file-formatting.whitespace.multiple-line-breaks">
|
|
<sect3 id="doc-standard.file-formatting.whitespace.multiple-line-breaks">
|
|
|
- <title>Multiple line breaks</title>
|
|
|
|
|
|
|
+ <title>Mehrere Zeilenumbrüche</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Multiple line breaks within or between tags are not allowed.
|
|
|
|
|
|
|
+ Mehrere Zeilenumbrüche innerhalb oder auch zwischen Tags sind nicht erlaubt.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
-<!-- NOT ALLOWED -->
|
|
|
|
|
|
|
+<!-- NICHT ERLAUBT -->
|
|
|
<para>
|
|
<para>
|
|
|
- Some text...
|
|
|
|
|
|
|
+ Etwas Text...
|
|
|
|
|
|
|
|
- ... and more text
|
|
|
|
|
|
|
+ ... und mehr Text.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Another paragraph.
|
|
|
|
|
|
|
+ Anderer Paragraph.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<!-- OK -->
|
|
<!-- OK -->
|
|
|
<para>
|
|
<para>
|
|
|
- Some text...
|
|
|
|
|
- ... and more text
|
|
|
|
|
|
|
+ Etwas Text...
|
|
|
|
|
+ ... und mehr Text
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Another paragraph.
|
|
|
|
|
|
|
+ Anderer Paragraph.
|
|
|
</para>
|
|
</para>
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
</sect3>
|
|
</sect3>
|
|
|
|
|
|
|
|
<sect3 id="doc-standard.file-formatting.whitespace.tag-separation">
|
|
<sect3 id="doc-standard.file-formatting.whitespace.tag-separation">
|
|
|
- <title>Separation between tags</title>
|
|
|
|
|
|
|
+ <title>Trennung zwischen Tags</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Tags at the same level must be separated by an empty line to improve
|
|
|
|
|
- readability.
|
|
|
|
|
|
|
+ Tags auf dem gleichen Level müssen durch eine leere Zeile getrennt sein um die
|
|
|
|
|
+ Lesbarkeit zu erhöhen.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
-<!-- NOT ALLOWED -->
|
|
|
|
|
|
|
+<!-- NICHT ERLAUBT -->
|
|
|
<para>
|
|
<para>
|
|
|
- Some text...
|
|
|
|
|
|
|
+ Etwas Text...
|
|
|
</para>
|
|
</para>
|
|
|
<para>
|
|
<para>
|
|
|
- More text...
|
|
|
|
|
|
|
+ Mehr Text...
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<!-- OK -->
|
|
<!-- OK -->
|
|
|
<para>
|
|
<para>
|
|
|
- Some text...
|
|
|
|
|
|
|
+ Etwas Text...
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- More text...
|
|
|
|
|
|
|
+ Mehr Text...
|
|
|
</para>
|
|
</para>
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- The first child tag should open directly below its parent, with no empty line
|
|
|
|
|
- between them; the last child tag should close directly before the closing tag of
|
|
|
|
|
- its parent.
|
|
|
|
|
|
|
+ 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.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
-<!-- NOT ALLOWED -->
|
|
|
|
|
|
|
+<!-- NICHT ERLAUBT -->
|
|
|
<sect1>
|
|
<sect1>
|
|
|
|
|
|
|
|
<sect2>
|
|
<sect2>
|
|
@@ -304,32 +312,32 @@ This is the class <classname>Zend_Class</classname>
|
|
|
</sect2>
|
|
</sect2>
|
|
|
|
|
|
|
|
<sect2 id="doc-standard.file-formatting.program-listing">
|
|
<sect2 id="doc-standard.file-formatting.program-listing">
|
|
|
- <title>Program Listings</title>
|
|
|
|
|
|
|
+ <title>Programm Auflistungen</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- The opening <emphasis><programlisting></emphasis> tag must indicate the
|
|
|
|
|
- appropriate "language" attribute and be indented at the same level as its sibling
|
|
|
|
|
- blocks.
|
|
|
|
|
|
|
+ Das öffnende <emphasis><programlisting></emphasis> Tag muss das richtige
|
|
|
|
|
+ "language" Attribut anzeigen und auf dem gleichen Level eingerückt sein wie die
|
|
|
|
|
+ vorhergehenden Blöcke.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
-<para>Sibling paragraph.</para>
|
|
|
|
|
|
|
+<para>Vorhergehender Paragraph.</para>
|
|
|
|
|
|
|
|
<programlisting language="php">]]><<![CDATA[![CDATA[
|
|
<programlisting language="php">]]><<![CDATA[![CDATA[
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- <acronym>CDATA</acronym> should be used around all program listings.
|
|
|
|
|
|
|
+ <acronym>CDATA</acronym> sollte um alle Programm Auflistungen vorhanden sein.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- <emphasis><programlisting></emphasis> sections must not add linebreaks or
|
|
|
|
|
- whitespace at the beginning or end of the section, as these are then represented in
|
|
|
|
|
- the final output.
|
|
|
|
|
|
|
+ <emphasis><programlisting></emphasis> Sektionen dürfen keine Zeilenumbrüche
|
|
|
|
|
+ oder Leerzeichen am Anfang oder Ende der Sektion besitzen, da diese auch in der
|
|
|
|
|
+ endgültigen Ausgabe dargestellt werden.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
-<!-- NOT ALLOWED -->
|
|
|
|
|
|
|
+<!-- NICHT ERLAUBT -->
|
|
|
<programlisting language="php">]]><<![CDATA[![CDATA[
|
|
<programlisting language="php">]]><<![CDATA[![CDATA[
|
|
|
|
|
|
|
|
$render = "xxx";
|
|
$render = "xxx";
|
|
@@ -343,18 +351,18 @@ $render = "xxx";
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Ending <acronym>CDATA</acronym> and <emphasis><programlisting></emphasis>
|
|
|
|
|
- tags should be on the same line, without any indentation.
|
|
|
|
|
|
|
+ Endende <acronym>CDATA</acronym> und <emphasis><programlisting></emphasis>
|
|
|
|
|
+ Tags sollten in der gleichen Zeile, aber ohne Einrückung stehen.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
-<!-- NOT ALLOWED -->
|
|
|
|
|
|
|
+<!-- NICHT ERLAUBT -->
|
|
|
<programlisting language="php">]]><<![CDATA[![CDATA[
|
|
<programlisting language="php">]]><<![CDATA[![CDATA[
|
|
|
$render = "xxx";
|
|
$render = "xxx";
|
|
|
]]]]>><![CDATA[
|
|
]]]]>><![CDATA[
|
|
|
</programlisting>
|
|
</programlisting>
|
|
|
|
|
|
|
|
-<!-- NOT ALLOWED -->
|
|
|
|
|
|
|
+<!-- NICHT ERLAUBT -->
|
|
|
<programlisting language="php">]]><<![CDATA[![CDATA[
|
|
<programlisting language="php">]]><<![CDATA[![CDATA[
|
|
|
$render = "xxx";
|
|
$render = "xxx";
|
|
|
]]]]>><![CDATA[</programlisting>
|
|
]]]]>><![CDATA[</programlisting>
|
|
@@ -366,9 +374,10 @@ $render = "xxx";
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- The <emphasis><programlisting></emphasis> tag should contain the "language"
|
|
|
|
|
- attribute with a value appropriate to the contents of the program listing. Typical
|
|
|
|
|
- values include "css", "html", "ini", "javascript", "php", "text", and "xml".
|
|
|
|
|
|
|
+ Das <emphasis><programlisting></emphasis> Tag sollte das "language" Atribut
|
|
|
|
|
+ mit einem Wert enthalten der dem Inhalt der Programm Auflistung entspricht.
|
|
|
|
|
+ Typischerweise enthält es die Werte "css", "html", "ini", "javascript", "php",
|
|
|
|
|
+ "text", und "xml".
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
@@ -383,14 +392,15 @@ $render = "xxx";
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- For program listings containing only <acronym>PHP</acronym> code,
|
|
|
|
|
- <acronym>PHP</acronym> tags (e.g., "<?php", "?>") are not required, and
|
|
|
|
|
- should not be used. They simply clutter the narrative, and are implied by the use
|
|
|
|
|
- of the <emphasis><programlisting></emphasis> tag.
|
|
|
|
|
|
|
+ Für Programm Auflistungen die nur <acronym>PHP</acronym> Code enthalten werden
|
|
|
|
|
+ keine <acronym>PHP</acronym> Tags (wie z.B. "<?php", "?>") benötigt, und
|
|
|
|
|
+ sollten auch nicht verwendet werden. Sie zeigen nur das Naheliegendste und werden
|
|
|
|
|
+ durch die Verwendung des <emphasis><programlisting></emphasis> Tags
|
|
|
|
|
+ impliziert.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
-<!-- NOT ALLOWED -->
|
|
|
|
|
|
|
+<!-- NICHT ERLAUBT -->
|
|
|
<programlisting language="php"]]><<![CDATA[![CDATA[<?php
|
|
<programlisting language="php"]]><<![CDATA[![CDATA[<?php
|
|
|
// ...
|
|
// ...
|
|
|
?>]]]]>><![CDATA[</programlisting>
|
|
?>]]]]>><![CDATA[</programlisting>
|
|
@@ -403,44 +413,46 @@ $render = "xxx";
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Line lengths within program listings should follow the <link
|
|
|
|
|
- linkend="coding-standard.php-file-formatting.max-line-length">coding standards
|
|
|
|
|
- recommendations</link>.
|
|
|
|
|
|
|
+ Die Zeilenlängen in Programm Auflistungen sollten den <link
|
|
|
|
|
+ linkend="coding-standard.php-file-formatting.max-line-length">Coding Standard
|
|
|
|
|
+ Empfehlungen</link> folgen.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Refrain from using <methodname>require_once()</methodname>,
|
|
|
|
|
- <methodname>require()</methodname>, <methodname>include_once()</methodname>, and
|
|
|
|
|
- <methodname>include()</methodname> calls within <acronym>PHP</acronym> listings.
|
|
|
|
|
- They simply clutter the narrative, and are largely obviated when using an
|
|
|
|
|
- autoloader. Use them only when they are essential to the example.
|
|
|
|
|
|
|
+ <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
|
|
|
|
|
+ für das Beispiel sind.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<note>
|
|
<note>
|
|
|
- <title>Never use short tags</title>
|
|
|
|
|
|
|
+ <title>Niemals Short Tags verwenden</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Short tags (e.g., "<?", "<?=") should never be used within
|
|
|
|
|
- <emphasis>programlisting</emphasis> or the narrative of a document.
|
|
|
|
|
|
|
+ Short Tags (z.B., "<?", "<?=") sollten niemals innerhalb von
|
|
|
|
|
+ <emphasis>programlisting</emphasis> oder einer Dokuments verwendet werden.
|
|
|
</para>
|
|
</para>
|
|
|
</note>
|
|
</note>
|
|
|
</sect2>
|
|
</sect2>
|
|
|
|
|
|
|
|
<sect2 id="doc-standard.file-formatting.inline-tags">
|
|
<sect2 id="doc-standard.file-formatting.inline-tags">
|
|
|
- <title>Notes on specific inline tags</title>
|
|
|
|
|
|
|
+ <title>Notizen zu speziellen Inline Tags</title>
|
|
|
|
|
|
|
|
<sect3 id="doc-standard.file-formatting.inline-tags.classname">
|
|
<sect3 id="doc-standard.file-formatting.inline-tags.classname">
|
|
|
<title>classname</title>
|
|
<title>classname</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- The tag <emphasis><classname></emphasis> must be used each time a class name is
|
|
|
|
|
- represented by itself; it should not be used when combined with a method name,
|
|
|
|
|
- variable name, or constant, and no other content is allowed within the tag.
|
|
|
|
|
|
|
+ Das Tag <emphasis><classname></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.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
<para>
|
|
<para>
|
|
|
- The class <classname>Zend_Class</classname>.
|
|
|
|
|
|
|
+ Die Klasse <classname>Zend_Class</classname>.
|
|
|
</para>
|
|
</para>
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
</sect3>
|
|
</sect3>
|
|
@@ -449,14 +461,15 @@ $render = "xxx";
|
|
|
<title>varname</title>
|
|
<title>varname</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Variables must be wrapped in the <emphasis><varname></emphasis> tag.
|
|
|
|
|
- Variables must be written using the "$" sigil. No other content is allowed
|
|
|
|
|
- within this tag, unless a class name is used, which indicates a class variable.
|
|
|
|
|
|
|
+ Variablen müssen im <emphasis><varname></emphasis> Tag eingehüllt 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.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
<para>
|
|
<para>
|
|
|
- The variable <varname>$var</varname> and the class variable
|
|
|
|
|
|
|
+ Die Variable <varname>$var</varname> und die Klassenvariable
|
|
|
<varname>Zend_Class::$var</varname>.
|
|
<varname>Zend_Class::$var</varname>.
|
|
|
</para>
|
|
</para>
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
@@ -466,17 +479,18 @@ $render = "xxx";
|
|
|
<title>methodname</title>
|
|
<title>methodname</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Methods must be wrapped in the <emphasis><methodname></emphasis> tag.
|
|
|
|
|
- Methods must either include the full method signature or at the least a pair of
|
|
|
|
|
- closing parentheses (e.g., "()"). No other content is allowed within this tag,
|
|
|
|
|
- unless a class name is used, which indicates a class method.
|
|
|
|
|
|
|
+ Methoden müssen innerhalb des <emphasis><methodname></emphasis> Tags
|
|
|
|
|
+ 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.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
<para>
|
|
<para>
|
|
|
- The method <methodname>foo()</methodname> and the class method
|
|
|
|
|
- <methodname>Zend_Class::foo()</methodname>. A method with a full signature:
|
|
|
|
|
- <methodname>foo($bar, $baz)</methodname>
|
|
|
|
|
|
|
+ Die Methode <methodname>foo()</methodname> und die Klassenmethode
|
|
|
|
|
+ <methodname>Zend_Class::foo()</methodname>. Eine Methode mit der kompletten
|
|
|
|
|
+ Signatur <methodname>foo($bar, $baz)</methodname>
|
|
|
</para>
|
|
</para>
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
</sect3>
|
|
</sect3>
|
|
@@ -485,15 +499,15 @@ $render = "xxx";
|
|
|
<title>constant</title>
|
|
<title>constant</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Use the <emphasis><constant></emphasis> tag when denoting constants.
|
|
|
|
|
- Constants must be written in <acronym>UPPERCASE</acronym>. No other content is
|
|
|
|
|
- allowed within this tag, unless a class name is used, which indicates a class
|
|
|
|
|
- constant.
|
|
|
|
|
|
|
+ Das <emphasis><constant></emphasis> Tag ist zu verwenden wenn Konstanten
|
|
|
|
|
+ angezeigt werden sollen. Konstanten müssen <acronym>GROßGESCHRIEBEN</acronym>
|
|
|
|
|
+ werden. Kein anderer Inhalt ist innerhalb dieses Tags erlaubt, ausser es wird
|
|
|
|
|
+ ein Klassenname verwendet, der eine Klassenkonstante anzeigt.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
<para>
|
|
<para>
|
|
|
- The constant <constant>FOO</constant> and the class constant
|
|
|
|
|
|
|
+ Die Konstante <constant>FOO</constant> und die Klassenkonstante
|
|
|
<constant>Zend_Class::FOO</constant>.
|
|
<constant>Zend_Class::FOO</constant>.
|
|
|
</para>
|
|
</para>
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
@@ -503,14 +517,13 @@ $render = "xxx";
|
|
|
<title>filename</title>
|
|
<title>filename</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Filenames and paths must be wrapped in the
|
|
|
|
|
- <emphasis><filename></emphasis> tag. No other content is allowed in this
|
|
|
|
|
- tag.
|
|
|
|
|
|
|
+ Dateinamen und Pfade müssen im <emphasis><filename></emphasis> Tag
|
|
|
|
|
+ enthalten sein. Kein anderer Inhalt ist innerhalb dieses Tags erlaubt.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
<para>
|
|
<para>
|
|
|
- The filename <filename>application/Bootstrap.php</filename>.
|
|
|
|
|
|
|
+ Die Datei <filename>application/Bootstrap.php</filename>.
|
|
|
</para>
|
|
</para>
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
</sect3>
|
|
</sect3>
|
|
@@ -519,14 +532,14 @@ $render = "xxx";
|
|
|
<title>command</title>
|
|
<title>command</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Commands, shell scripts, and program calls must be wrapped in the
|
|
|
|
|
- <emphasis><command></emphasis> tag. If the command includes arguments,
|
|
|
|
|
- these should also be included within the tag.
|
|
|
|
|
|
|
+ Commands, Shell Skripte, und Programmaufrufe müssen im
|
|
|
|
|
+ <emphasis><command></emphasis> Tag enthalten sein. Wenn das Kommando
|
|
|
|
|
+ Argumente enthält sollten diese auch im Tag enthalten sein.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
<para>
|
|
<para>
|
|
|
- Execute <command>zf.sh create project</command>.
|
|
|
|
|
|
|
+ Ausführen von <command>zf.sh create project</command>.
|
|
|
</para>
|
|
</para>
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
</sect3>
|
|
</sect3>
|
|
@@ -535,127 +548,134 @@ $render = "xxx";
|
|
|
<title>code</title>
|
|
<title>code</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Usage of the <emphasis><code></emphasis> tag is discouraged, in favor of
|
|
|
|
|
- the other inline tasks discussed previously.
|
|
|
|
|
|
|
+ Die Verwendung des <emphasis><code></emphasis> Tags ist nicht erlaubt.
|
|
|
|
|
+ Stattdessen sollten die anderen vorher besprochenen Inline Tags verwendet
|
|
|
|
|
+ werden.
|
|
|
</para>
|
|
</para>
|
|
|
</sect3>
|
|
</sect3>
|
|
|
</sect2>
|
|
</sect2>
|
|
|
|
|
|
|
|
<sect2 id="doc-standard.file-formatting.block-tags">
|
|
<sect2 id="doc-standard.file-formatting.block-tags">
|
|
|
- <title>Notes on specific block tags</title>
|
|
|
|
|
|
|
+ <title>Notizen zu speziellen Block Tags</title>
|
|
|
|
|
|
|
|
<sect3 id="doc-standard.file-formatting.block-tags.title">
|
|
<sect3 id="doc-standard.file-formatting.block-tags.title">
|
|
|
<title>title</title>
|
|
<title>title</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- The <emphasis><title></emphasis> tag is not allowed to hold other tags.
|
|
|
|
|
|
|
+ Das <emphasis><title></emphasis> Tag darf keine anderen Tags enthalten.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
-<!-- NOT ALLOWED -->
|
|
|
|
|
-<title>Using <classname>Zend_Class</classname></title>
|
|
|
|
|
|
|
+<!-- NICHT ERLAUBT -->
|
|
|
|
|
+<title>Verwendung von <classname>Zend_Class</classname></title>
|
|
|
|
|
|
|
|
<!-- OK -->
|
|
<!-- OK -->
|
|
|
-<title>Using Zend_Class</title>
|
|
|
|
|
|
|
+<title>Verwendung von Zend_Class</title>
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
</sect3>
|
|
</sect3>
|
|
|
</sect2>
|
|
</sect2>
|
|
|
</sect1>
|
|
</sect1>
|
|
|
|
|
|
|
|
<sect1 id="doc-standard.recommendations">
|
|
<sect1 id="doc-standard.recommendations">
|
|
|
- <title>Recommendations</title>
|
|
|
|
|
|
|
+ <title>Empfehlungen</title>
|
|
|
|
|
|
|
|
<sect2 id="doc-standard.recommendations.editors">
|
|
<sect2 id="doc-standard.recommendations.editors">
|
|
|
- <title>Use editors without autoformatting</title>
|
|
|
|
|
|
|
+ <title>Editoren ohne Autoformatierung verwenden</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- For editing the documentation, typically you should not use formal
|
|
|
|
|
- <acronym>XML</acronym> editors. Such editors normally autoformat existing documents
|
|
|
|
|
- to fit their own standards and/or do not strictly follow the docbook standard. As
|
|
|
|
|
- examples, we have seen them erase the <acronym>CDATA</acronym> tags, change 4 space
|
|
|
|
|
- seperation to tabs or 2 spaces, etc.
|
|
|
|
|
|
|
+ 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
|
|
|
|
|
+ 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
|
|
|
|
|
+ zu Tabs oder 2 Leerzeichen ändern, usw.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- The style guidelines were written in large part to assist translators in recognizing
|
|
|
|
|
- the lines that have changed using normal <command>diff</command> tools.
|
|
|
|
|
- Autoformatting makes this process more difficult.
|
|
|
|
|
|
|
+ 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
|
|
|
|
|
+ viel schwieriger.
|
|
|
</para>
|
|
</para>
|
|
|
</sect2>
|
|
</sect2>
|
|
|
|
|
|
|
|
<sect2 id="doc-standard.recommendations.images">
|
|
<sect2 id="doc-standard.recommendations.images">
|
|
|
- <title>Use Images</title>
|
|
|
|
|
|
|
+ <title>Verwendung von Bildern</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Good images and diagrams can improve readability and comprehension. Use them
|
|
|
|
|
- whenever they will assist in these goals. Images should be placed in the
|
|
|
|
|
- <filename>documentation/manual/en/figures/</filename> directory, and be named after
|
|
|
|
|
- the section identifier in which they occur.
|
|
|
|
|
|
|
+ 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
|
|
|
|
|
+ im Verzeichnis <filename>documentation/manual/en/figures/</filename> platziert,
|
|
|
|
|
+ und nach dem Kapitel benannt werden in dem Sie vorkommen.
|
|
|
</para>
|
|
</para>
|
|
|
</sect2>
|
|
</sect2>
|
|
|
|
|
|
|
|
<sect2 id="doc-standard.recommendations.examples">
|
|
<sect2 id="doc-standard.recommendations.examples">
|
|
|
- <title>Use Case Examples</title>
|
|
|
|
|
|
|
+ <title>Gute Fallbeispiele</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Look for good use cases submitted by the community, especially those posted in
|
|
|
|
|
- proposal comments or on one of the mailing lists. Examples often illustrate usage
|
|
|
|
|
- far better than the narrative does.
|
|
|
|
|
|
|
+ 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
|
|
|
|
|
+ Beschreibungen tun.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- When writing your examples for inclusion in the manual, follow
|
|
|
|
|
- all coding standards and documentation standards.
|
|
|
|
|
|
|
+ Wenn man Beispiele für die Inkludierung in das Handbuch schreibt, sollte man
|
|
|
|
|
+ allen Coding Standards und Dokumentations Standards folgen.
|
|
|
</para>
|
|
</para>
|
|
|
</sect2>
|
|
</sect2>
|
|
|
|
|
|
|
|
<sect2 id="doc-standard.recommendations.phpdoc">
|
|
<sect2 id="doc-standard.recommendations.phpdoc">
|
|
|
- <title>Avoid Replicating phpdoc Contents</title>
|
|
|
|
|
|
|
+ <title>Vermeide die Wiederholung von phpdoc Inhalten</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- The manual is intended to be a reference guide for end-user usage. Replicating
|
|
|
|
|
- the phpdoc documentation for internal-use components and classes is not wanted, and
|
|
|
|
|
- the narrative should be focussed on usage, not the internal workings. In any case,
|
|
|
|
|
- at this time, we would like the documentation teams to focus on translating the
|
|
|
|
|
- English manual, not the phpdoc comments.
|
|
|
|
|
|
|
+ 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.
|
|
|
</para>
|
|
</para>
|
|
|
</sect2>
|
|
</sect2>
|
|
|
|
|
|
|
|
<sect2 id="doc-standard.recommendations.links">
|
|
<sect2 id="doc-standard.recommendations.links">
|
|
|
- <title>Use Links</title>
|
|
|
|
|
|
|
+ <title>Verwendung von Links</title>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Link to other sections of the manual or to external sources
|
|
|
|
|
- instead of recreating documentation.
|
|
|
|
|
|
|
+ Links sollten zu anderen Sektionen des Handbuchs oder externen Quellen verweisen
|
|
|
|
|
+ statt Dokumentation zu wiederholen.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- Linking to other sections of the manual may be done using either the
|
|
|
|
|
- <emphasis><xref></emphasis> tag (which will substitute the section title for
|
|
|
|
|
- the link text) or the <emphasis><link></emphasis> tag (to which you must
|
|
|
|
|
- provide link text).
|
|
|
|
|
|
|
+ Die Verlinkung zu anderen Sektionen des Handbuchs kann durchgeführt werden indem
|
|
|
|
|
+ das <emphasis><xref></emphasis> Tag verwendet wird (welches den Titel der
|
|
|
|
|
+ Sektion für den Link Text verwendet) oder das <emphasis><link></emphasis>
|
|
|
|
|
+ Tag (für welches man den Link Text selbst angeben muß).
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
<para>
|
|
<para>
|
|
|
- "Xref" links to a section: <xref
|
|
|
|
|
|
|
+ "Xref" verweist zu einer Sektion: <xref
|
|
|
linkend="doc-standard.recommendations.links" />.
|
|
linkend="doc-standard.recommendations.links" />.
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- "Link" links to a section, using descriptive text: <link
|
|
|
|
|
- linkend="doc-standard.recommendations.links">documentation on
|
|
|
|
|
- links</link>.
|
|
|
|
|
|
|
+ "Link" verweist zu einer Sektion, und verwendet beschreibenden Text: <link
|
|
|
|
|
+ linkend="doc-standard.recommendations.links">Dokumentation zum
|
|
|
|
|
+ Link</link>.
|
|
|
</para>
|
|
</para>
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
|
|
|
|
|
<para>
|
|
<para>
|
|
|
- To link to an external resource, use <emphasis><ulink></emphasis>:
|
|
|
|
|
|
|
+ Um auf eine externe Ressource zu verweisen muß <emphasis><ulink></emphasis>
|
|
|
|
|
+ verwendet werden:
|
|
|
</para>
|
|
</para>
|
|
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
<programlisting language="xml"><![CDATA[
|
|
|
<para>
|
|
<para>
|
|
|
- The <ulink url="http://framework.zend.com/">Zend Framework site</ulink>.
|
|
|
|
|
|
|
+ Die <ulink url="http://framework.zend.com/">Zend Framework Seite</ulink>.
|
|
|
</para>
|
|
</para>
|
|
|
]]></programlisting>
|
|
]]></programlisting>
|
|
|
</sect2>
|
|
</sect2>
|