summaryrefslogtreecommitdiff
path: root/zend/documentation/manual/core/en/doc-standard.overview.html
blob: 345659fad9b72cb3b56622d1d745fc7431366ea3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
                      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
    <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
    <title>Overview - Zend Framework Manual</title>

</head>
<body>
<table width="100%">
    <tr valign="top">
        <td width="85%">
            <table width="100%">
                <tr>
                    <td width="25%" style="text-align: left;">
                    <a href="doc-standard.html">Zend Framework Documentation Standard</a>
                    </td>

                    <td width="50%" style="text-align: center;">
                        <div class="up"><span class="up"><a href="doc-standard.html">Zend Framework Documentation Standard</a></span><br />
                        <span class="home"><a href="manual.html">Programmer's Reference Guide</a></span></div>
                    </td>

                    <td width="25%" style="text-align: right;">
                        <div class="next" style="text-align: right; float: right;"><a href="doc-standard.file-formatting.html">Documentation File Formatting</a></div>
                    </td>
                </tr>
            </table>
<hr />
<div id="doc-standard.overview" class="section"><div class="info"><h1 class="title">Overview</h1></div>
        

        <div class="section" id="doc-standard.overview.scope" name="doc-standard.overview.scope"><div class="info"><h1 class="title">Scope</h1></div>
            

            <p class="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
                <strong class="command">diff</strong> tools.
            </p>

            <p class="para">
                You may adopt and/or modify these standards in accordance with the terms of our
                <a href="http://framework.zend.com/license" class="link external">&raquo; license</a>.
            </p>

            <p class="para">
                Topics covered in Zend Framework&#039;s documentation standards include documentation
                file formatting and recommendations for documentation quality.
            </p>
        </div>
    </div>
        <hr />

            <table width="100%">
                <tr>
                    <td width="25%" style="text-align: left;">
                    <a href="doc-standard.html">Zend Framework Documentation Standard</a>
                    </td>

                    <td width="50%" style="text-align: center;">
                        <div class="up"><span class="up"><a href="doc-standard.html">Zend Framework Documentation Standard</a></span><br />
                        <span class="home"><a href="manual.html">Programmer's Reference Guide</a></span></div>
                    </td>

                    <td width="25%" style="text-align: right;">
                        <div class="next" style="text-align: right; float: right;"><a href="doc-standard.file-formatting.html">Documentation File Formatting</a></div>
                    </td>
                </tr>
            </table>
</td>
        <td style="font-size: smaller;" width="15%"> <style type="text/css">
#leftbar {
	float: left;
	width: 186px;
	padding: 5px;
	font-size: smaller;
}
ul.toc {
	margin: 0px 5px 5px 5px;
	padding: 0px;
}
ul.toc li {
	font-size: 85%;
	margin: 1px 0 1px 1px;
	padding: 1px 0 1px 11px;
	list-style-type: none;
	background-repeat: no-repeat;
	background-position: center left;
}
ul.toc li.header {
	font-size: 115%;
	padding: 5px 0px 5px 11px;
	border-bottom: 1px solid #cccccc;
	margin-bottom: 5px;
}
ul.toc li.active {
	font-weight: bold;
}
ul.toc li a {
	text-decoration: none;
}
ul.toc li a:hover {
	text-decoration: underline;
}
</style>
 <ul class="toc">
  <li class="header home"><a href="manual.html">Programmer's Reference Guide</a></li>
  <li class="header up"><a href="manual.html">Programmer's Reference Guide</a></li>
  <li class="header up"><a href="doc-standard.html">Zend Framework Documentation Standard</a></li>
  <li class="active"><a href="doc-standard.overview.html">Overview</a></li>
  <li><a href="doc-standard.file-formatting.html">Documentation File Formatting</a></li>
  <li><a href="doc-standard.recommendations.html">Recommendations</a></li>
 </ul>
 </td>
    </tr>
</table>
</body>
</html>