<commit_before><?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<appendix id="doc-standard">
    <title>Zend Framework Documentation Standard</title>

    <sect1 id="doc-standard.overview">
        <title>Overview</title>

        <sect2 id="doc-standard.overview.scope">
            <title>Scope</title>

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

            <para>
                Topics covered in the Zend Framework documentation standards include documentation
                file formatting and recommendations for documentation quality.
            </para>
        </sect2>
    </sect1>

    <sect1 id="doc-standard.file-formatting">
        <title>Documentation File Formatting</title>

        <sect2 id="doc-standard.file-formatting.xml-tags">
            <title>XML Tags</title>

            <para>
                Each manual file must include the following <acronym>XML</acronym> declarations at
                the top of the file:
            </para>

            <programlisting language="xml"><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
]]></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.
            </para>

            <programlisting language="xml"><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 14978 -->
<!-- Reviewed: no -->
]]></programlisting>
        </sect2>

        <sect2 id="doc-standard.file-formatting.max-line-length">
            <title>Maximum Line Length</title>

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

        <sect2 id="doc-standard.file-formatting.indentation">
            <title>Indentation</title>

            <para>Indentation should consist of 4 spaces. Tabs are not allowed.</para>

            <para>Tags which are at the same level must have the same indentation.</para>

            <programlisting language="xml"><![CDATA[
<sect1>
</sect1>

<sect1>
</sect1>
]]></programlisting>

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

            <programlisting language="xml"><![CDATA[
<sect1>
    <sect2>
    </sect2>
</sect1>
]]></programlisting>

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

            <programlisting language="xml"><![CDATA[
<!-- NOT ALLOWED: -->
<sect1><sect2>
</sect2></sect1>

<!-- ALLOWED -->
<para>
    <code>Zend_Magic</code> does not exist. <code>Zend_Acl</code> does.
</para>
]]></programlisting>
        </sect2>

        <sect2 id="doc-standard.file-formatting.line-termination">
            <title>Line Termination</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.
            </para><commit_msg>[DOCUMENTATION] English:<commit_after><?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
<appendix id="doc-standard">
    <title>Zend Framework Documentation Standard</title>

    <sect1 id="doc-standard.overview">
        <title>Overview</title>

        <sect2 id="doc-standard.overview.scope">
            <title>Scope</title>

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

            <para>
                Topics covered in Zend Framework's documentation standards include documentation
                file formatting and recommendations for documentation quality.
            </para>
        </sect2>
    </sect1>

    <sect1 id="doc-standard.file-formatting">
        <title>Documentation File Formatting</title>

        <sect2 id="doc-standard.file-formatting.xml-tags">
            <title>XML Tags</title>

            <para>
                Each manual file must include the following <acronym>XML</acronym> declarations at
                the top of the file:
            </para>

            <programlisting language="xml"><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<!-- Reviewed: no -->
]]></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.
            </para>

            <programlisting language="xml"><![CDATA[
<?xml version="1.0" encoding="UTF-8"?>
<!-- EN-Revision: 14978 -->
<!-- Reviewed: no -->
]]></programlisting>
        </sect2>

        <sect2 id="doc-standard.file-formatting.max-line-length">
            <title>Maximum Line Length</title>

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

        <sect2 id="doc-standard.file-formatting.indentation">
            <title>Indentation</title>

            <para>Indentation should consist of 4 spaces. Tabs are not allowed.</para>

            <para>Tags which are at the same level must have the same indentation.</para>

            <programlisting language="xml"><![CDATA[
<sect1>
</sect1>

<sect1>
</sect1>
]]></programlisting>

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

            <programlisting language="xml"><![CDATA[
<sect1>
    <sect2>
    </sect2>
</sect1>
]]></programlisting>

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

            <programlisting language="xml"><![CDATA[
<!-- NOT ALLOWED: -->
<sect1><sect2>
</sect2></sect1>

<!-- ALLOWED -->
<para>
    <classname>Zend_Magic</classname> does not exist. <classname>Zend_Acl</classname> does.
</para>
]]></programlisting>
        </sect2>

        <sect2 id="doc-standard.file-formatting.line-termination">
            <title>Line Termination</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.
            </para>
{'fraction_non_alphanumeric': 0.10277620396600566, 'fraction_numerical': 0.0113314447592068, 'mean_word_length': 2.020533880903491, 'pattern_counts': {'":': 0, '<': 205, '<?xml version=': 6, '>': 205, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 18}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5559247', 'n_tokens_mistral': 2352, 'n_tokens_neox': 2134, 'n_words': 743}