|
|
@@ -2,7 +2,7 @@
|
|
|
<!-- Reviewed: no -->
|
|
|
<!-- EN-Revision: 22743 -->
|
|
|
<appendix id="doc-standard">
|
|
|
- <title>Zend Framework ドキュメント標準</title>
|
|
|
+ <title>Zend Framework ドキュメント標準(一部日本語)</title>
|
|
|
|
|
|
<sect1 id="doc-standard.overview">
|
|
|
<title>概要</title>
|
|
|
@@ -42,8 +42,7 @@
|
|
|
<title>XML タグ</title>
|
|
|
|
|
|
<para>
|
|
|
- Each manual file must include the following <acronym>XML</acronym> declarations at
|
|
|
- the top of the file:
|
|
|
+ 各マニュアルのファイル先頭に、下記の <acronym>XML</acronym> 宣言がなければなりません。
|
|
|
</para>
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
|
@@ -52,9 +51,8 @@
|
|
|
]]></programlisting>
|
|
|
|
|
|
<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> ファイルには、
|
|
|
+ 対応する翻訳元の英語ファイルのリビジョンに等しいリビジョン・タグもなければなりません。
|
|
|
</para>
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
|
@@ -67,6 +65,7 @@
|
|
|
<sect2 id="doc-standard.file-formatting.max-line-length">
|
|
|
<title>行の最大長</title>
|
|
|
|
|
|
+ <!-- TODO : to be translated -->
|
|
|
<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 and value
|
|
|
@@ -77,9 +76,9 @@
|
|
|
<sect2 id="doc-standard.file-formatting.indentation">
|
|
|
<title>インデント</title>
|
|
|
|
|
|
- <para>Indentation should consist of 4 spaces. Tabs are not allowed.</para>
|
|
|
+ <para>インデントは、空白文字4つで構成されなければなりません。タブは許されません。</para>
|
|
|
|
|
|
- <para>Tags which are at the same level must have the same indentation.</para>
|
|
|
+ <para>同じレベルにあるタグは、同じインデントを持たなければなりません。</para>
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
|
<sect1>
|
|
|
@@ -90,8 +89,7 @@
|
|
|
]]></programlisting>
|
|
|
|
|
|
<para>
|
|
|
- Tags which are one level under the previous tag must be indented with 4 additional
|
|
|
- spaces.
|
|
|
+ 前のタグの1つ下のレベルのタグは、さらに4つの空白文字でインデントされなければなりません。
|
|
|
</para>
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
|
@@ -102,8 +100,8 @@
|
|
|
]]></programlisting>
|
|
|
|
|
|
<para>
|
|
|
- Multiple block tags within the same line are not allowed; multiple inline tags are
|
|
|
- allowed, however.
|
|
|
+ 複数のブロック・タグは、同一行の中では許されません。
|
|
|
+ しかしながら、インライン・タグは複数許されます。
|
|
|
</para>
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
|
@@ -122,15 +120,17 @@
|
|
|
<title>行の終端</title>
|
|
|
|
|
|
<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.
|
|
|
+ 行の終端は、Unixテキスト・ファイル規約に従います。
|
|
|
+ 行は、単一のラインフィード(LF)文字で終わらなければなりません。
|
|
|
+ ラインフィード文字は、序数10または16進の0x0Aとして表現されます。
|
|
|
</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).
|
|
|
+ 注意:
|
|
|
+ Apple OS で規約となっているキャリッジ・リターン (<acronym>CR</acronym>;0x0D)
|
|
|
+ または、Windows OS で標準となっているキャリッジ・リターンと
|
|
|
+ ラインフィード (<acronym>CRLF</acronym>) の組合せ (0x0D, 0x0A)
|
|
|
+ を使用してはいけません。
|
|
|
</para>
|
|
|
</sect2>
|
|
|
|
|
|
@@ -158,8 +158,8 @@
|
|
|
<sect3 id="doc-standard.file-formatting.whitespace.trailing">
|
|
|
<title>タグ内での空白</title>
|
|
|
|
|
|
+ <!-- TODO : to be translated -->
|
|
|
<para>
|
|
|
- <!-- TODO : to be translated -->
|
|
|
Opening block tags should have no whitespace immediately following them other
|
|
|
than line breaks (and indentation on the following line).
|
|
|
</para>
|
|
|
@@ -171,7 +171,7 @@
|
|
|
]]></programlisting>
|
|
|
|
|
|
<para>
|
|
|
- Opening inline tags should have no whitespace immediately following them.
|
|
|
+ 開始のインライン・タグの直後に空白文字を置いてはいけません。
|
|
|
</para>
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
|
@@ -182,6 +182,7 @@ This is the class <classname> Zend_Class</classname>.
|
|
|
This is the class <classname>Zend_Class</classname>.
|
|
|
]]></programlisting>
|
|
|
|
|
|
+ <!-- TODO : to be translated -->
|
|
|
<para>
|
|
|
Closing block tags may be preceded by whitespace equivalent to the current
|
|
|
indentation level, but no more than that amount.
|
|
|
@@ -198,7 +199,7 @@ This is the class <classname>Zend_Class</classname>.
|
|
|
]]></programlisting>
|
|
|
|
|
|
<para>
|
|
|
- Closing inline tags must not be preceded by any whitespace.
|
|
|
+ 終わりのインライン・タグの前に空白文字を置いてはいけません。
|
|
|
</para>
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
|
@@ -269,10 +270,8 @@ This is the class <classname>Zend_Class</classname>
|
|
|
]]></programlisting>
|
|
|
|
|
|
<para>
|
|
|
- <!-- TODO : to be translated -->
|
|
|
- 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.
|
|
|
+ 最初の子タグは、空行を置かずに親タグの直下に開かなければいけません。
|
|
|
+ 最後の子タグは、親タグが閉じる直前で閉じなければいけません。
|
|
|
</para>
|
|
|
|
|
|
<programlisting language="xml"><![CDATA[
|
|
|
@@ -308,6 +307,7 @@ This is the class <classname>Zend_Class</classname>
|
|
|
<sect2 id="doc-standard.file-formatting.program-listing">
|
|
|
<title>プログラム・リスティング</title>
|
|
|
|
|
|
+ <!-- TODO : to be translated -->
|
|
|
<para>
|
|
|
The opening <emphasis><programlisting></emphasis> tag must indicate the
|
|
|
appropriate "language" attribute and be indented at the same level as its sibling
|
|
|
@@ -582,16 +582,16 @@ $render = "xxx";
|
|
|
</para>
|
|
|
|
|
|
<para>
|
|
|
- <!-- TODO : to be translated -->
|
|
|
- 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.
|
|
|
+ スタイル・ガイドラインは、通常の<command>diff</command>ツールを用いて
|
|
|
+ 変更した行を翻訳者が確認できるようにするために主に書かれました。
|
|
|
+ 自動フォーマットは、この処理をより難しくします。
|
|
|
</para>
|
|
|
</sect2>
|
|
|
|
|
|
<sect2 id="doc-standard.recommendations.images">
|
|
|
<title>イメージを使ってください</title>
|
|
|
|
|
|
+ <!-- TODO : to be translated -->
|
|
|
<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
|