# Zend Framework ドキュメント標準

## 概要

### スコープ

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 `diff` tools.

You may adopt and/or modify these standards in accordance with the terms of our license.

Topics covered in Zend Framework's documentation standards include documentation file formatting and recommendations for documentation quality.

## ドキュメントファイル形式

### XML タグ

Each manual file must include the following XML declarations at the top of the file:

    <?xml version="1.0" encoding="UTF-8"?>
    <!-- Reviewed: no -->

XML files from translated languages must also include a revision tag containing the revision of the corresponding English-language file the translation was based on.

    <?xml version="1.0" encoding="UTF-8"?>
    <!-- EN-Revision: 14978 -->
    <!-- Reviewed: no -->

### 行の最大長

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 pairs are allowed to exceed the 100 chars as they are not allowed to be separated.

### インデント

Indentation should consist of 4 spaces. Tabs are not allowed.

Tags which are at the same level must have the same indentation.

    <sect1>
    </sect1>

    <sect1>
    </sect1>

Tags which are one level under the previous tag must be indented with 4 additional spaces.

    <sect1>
        <sect2>
        </sect2>
    </sect1>

Multiple block tags within the same line are not allowed; multiple inline tags are allowed, however.

    <!-- NOT ALLOWED: -->
    <sect1><sect2>
    </sect2></sect1>

    <!-- ALLOWED -->
    <para>
        <classname>Zend_Magic</classname> does not exist. <classname>Zend_Acl</classname> does.
    </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.

Note: Do not use carriage returns (CR) as is the convention in Apple OS's (0x0D) or the carriage return - linefeed combination (CRLF) as is standard for the Windows OS (0x0D, 0x0A).

### 空のタグ

空のタグは認められません。タグは全てテキストまたは子供タグを含まなければいけません。

    <!-- NOT ALLOWED -->
    <para>
        Some text. <link></link>
    </para>

    <para>
    </para>

### ドキュメント内での空白の利用

#### タグ内での空白

Opening block tags should have no whitespace immediately following them other than line breaks (and indentation on the following line).

    <!-- NOT ALLOWED -->
    <sect1>WHITESPACE
    </sect1>

Opening inline tags should have no whitespace immediately following them.

    <!-- NOT ALLOWED -->
    This is the class <classname> Zend_Class</classname>.

    <!-- OK -->
    This is the class <classname>Zend_Class</classname>.

Closing block tags may be preceded by whitespace equivalent to the current indentation level, but no more than that amount.

    <!-- NOT ALLOWED -->
        <sect1>
         </sect1>

    <!-- OK -->
        <sect1>
        </sect1>

Closing inline tags must not be preceded by any whitespace.

    <!-- NOT ALLOWED -->
    This is the class <classname>Zend_Class </classname>

    <!-- OK -->
    This is the class <classname>Zend_Class</classname>

#### 複数行の切断

複数行内での、またはタグの間での切断は認められません。

    <!-- NOT ALLOWED -->
    <para>
        Some text...

        ... and more text
    </para>

    <para>
        Another paragraph.
    </para>

    <!-- OK -->
    <para>
        Some text...
        ... and more text
    </para>

    <para>
        Another paragraph.
    </para>

#### タグの間の分離

読みやすくするために、同じレベルのタグは空行で分離しなければいけません。

    <!-- NOT ALLOWED -->
    <para>
        Some text...
    </para>
    <para>
        More text...
    </para>

    <!-- OK -->
    <para>
        Some text...
    </para>

    <para>
        More text...
    </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.

    <!-- NOT ALLOWED -->
    <sect1>

        <sect2>
        </sect2>

        <sect2>
        </sect2>

        <sect2>
        </sect2>

    </sect1>

    <!-- OK -->
    <sect1>
        <sect2>
        </sect2>

        <sect2>
        </sect2>

        <sect2>
        </sect2>
    </sect1>

### プログラム・リスティング

The opening <programlisting> tag must indicate the appropriate "language" attribute and be indented at the same level as its sibling blocks.

    <para>Sibling paragraph.</para>

    <programlisting language="php"><![CDATA[

CDATA should be used around all program listings.

<programlisting> sections must not add linebreaks or whitespace at the beginning or end of the section, as these are then represented in the final output.

    <!-- NOT ALLOWED -->
    <programlisting language="php"><![CDATA[

    $render = "xxx";

    ]]></programlisting>

    <!-- OK -->
    <programlisting language="php"><![CDATA[
    $render = "xxx";
    ]]></programlisting>

Ending CDATA and <programlisting> tags should be on the same line, without any indentation.

    <!-- NOT ALLOWED -->
        <programlisting language="php"><![CDATA[
    $render = "xxx";
    ]]>
        </programlisting>

    <!-- NOT ALLOWED -->
        <programlisting language="php"><![CDATA[
    $render = "xxx";
        ]]></programlisting>

    <!-- OK -->
        <programlisting language="php"><![CDATA[
    $render = "xxx";
    ]]></programlisting>

The <programlisting> 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".

    <!-- PHP -->
    <programlisting language="php"><![CDATA[

    <!-- Javascript -->
    <programlisting language="javascript"><![CDATA[

    <!-- XML -->
    <programlisting language="xml"><![CDATA[

For program listings containing only PHP code, PHP 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 <programlisting> tag.

    <!-- NOT ALLOWED -->
    <programlisting language="php"<![CDATA[<?php
        // ...
    ?>]]></programlisting>

    <programlisting language="php"<![CDATA[
    <?php
        // ...
    ?>
    ]]></programlisting>

Line lengths within program listings should follow the coding standards recommendations.

Refrain from using `require_once()`, `require()`, `include_once()`, and `include()` calls within PHP listings. They simply clutter the narrative, and are largely obviated when using an autoloader. Use them only when they are essential to the example.

#### ショートタグを決して使わないで下さい

Short tags (e.g., "<?", "<?=") should never be used within programlisting or the narrative of a document.

### 特殊なインラインタグの注意

#### classname

The tag <classname> 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.

    <para>
        The class <classname>Zend_Class</classname>.
    </para>

#### varname

Variables must be wrapped in the <varname> 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.

    <para>
        The variable <varname>$var</varname> and the class variable
        <varname>Zend_Class::$var</varname>.
    </para>

#### methodname

Methods must be wrapped in the <methodname> 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.

    <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>
    </para>

#### constant

Use the <constant> tag when denoting constants. Constants must be written in UPPERCASE. No other content is allowed within this tag, unless a class name is used, which indicates a class constant.

    <para>
        The constant <constant>FOO</constant> and the class constant
        <constant>Zend_Class::FOO</constant>.
    </para>

#### filename

Filenames and paths must be wrapped in the <filename> tag. No other content is allowed in this tag.

    <para>
        The filename <filename>application/Bootstrap.php</filename>.
    </para>

#### command

Commands, shell scripts, and program calls must be wrapped in the <command> tag. If the command includes arguments, these should also be included within the tag.

    <para>
        Execute <command>zf.sh create project</command>.
    </para>

#### code

Usage of the <code> tag is discouraged, in favor of the other inline tasks discussed previously.

### 特殊なブロックタグの注意

#### title

<title> タグで他のタグを保持してはいけません。

    <!-- NOT ALLOWED -->
    <title>Using <classname>Zend_Class</classname></title>

    <!-- OK -->
    <title>Using Zend_Class</title>

## 推奨事項

### 自動でフォーマットしないエディタを使ってください

ドキュメンテーションを編集するために、 一般的に、正式なXMLエディタを使用するべきではありません。 そのようなエディタは、通常、それらの独自の標準に合わせるために、 既存のドキュメントを自動的にフォーマットします。 および／または、docbook 標準に厳密には従いません。 例えば、それらはCDATAタグを消したり、 ４スペースの間隔をタブや２スペースに変えたりすることを経験しています。

The style guidelines were written in large part to assist translators in recognizing the lines that have changed using normal `diff` tools. Autoformatting makes this process more difficult.

### イメージを使ってください

Good images and diagrams can improve readability and comprehension. Use them whenever they will assist in these goals. Images should be placed in the `documentation/manual/en/figures/` directory, and be named after the section identifier in which they occur.

### ケースの例を使ってください

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.

When writing your examples for inclusion in the manual, follow all coding standards and documentation standards.

### phpdocの内容を繰り返すことを避けてください

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.

### リンクを使ってください

ドキュメントを繰り返す代わりに、 マニュアルの他のセクションや外部のソースにリンクしてください。

マニュアルの他のセクションへのリンクを <xref>タグ（セクションのタイトルをリンク・テキストの代わりにします） または<link>タグ（リンクのテキストを用意しなければいけません） のどちらかを使って実施できるでしょう。

    <para>
        "Xref" links to a section: <xref
            linkend="doc-standard.recommendations.links" />.
    </para>

    <para>
        "Link" links to a section, using descriptive text: <link
            linkend="doc-standard.recommendations.links">documentation on
            links</link>.
    </para>

外部リソースにリンクするには、<ulink>を使ってください。

    <para>
        The <ulink url="http://framework.zend.com/">Zend Framework site</ulink>.
    </para>