[DOCUMENTATION] English:

 - manual fixes

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@16658 44c647ce-9c0f-0410-b52a-842ac1e357ba

documentation/manual/en/module_specs/Zend_Controller-Basics.xml

@@ -58,7 +58,7 @@
 
                 <para>
                     By default, <classname>Zend_Controller_Request_Http</classname> is
-                    used, which provides access to the entire HTTP request
+                    used, which provides access to the entire <acronym>HTTP</acronym> request
                     environment.
                 </para>
             </listitem>
@@ -78,22 +78,22 @@
 
                 <para>
                     The default router,
-                    <classname>Zend_Controller_Router_Rewrite</classname>, takes a URI
-                    endpoint as specified in
+                    <classname>Zend_Controller_Router_Rewrite</classname>, takes a
+                    <acronym>URI</acronym> endpoint as specified in
                     <classname>Zend_Controller_Request_Http</classname> and decomposes it
                     into a controller, action, and parameters based on the path
-                    information in the url. As an example, the URL
+                    information in the url. As an example, the <acronym>URL</acronym>
                     <filename>http://localhost/foo/bar/key/value</filename> would be
-                    decoded to use the <code>foo</code> controller,
-                    <code>bar</code> action, and specify a parameter
-                    <code>key</code> with a value of <code>value</code>.
+                    decoded to use the <emphasis>foo</emphasis> controller,
+                    <emphasis>bar</emphasis> action, and specify a parameter
+                    <emphasis>key</emphasis> with a value of <emphasis>value</emphasis>.
                 </para>
 
                 <para>
                     <classname>Zend_Controller_Router_Rewrite</classname> can also be used
                     to match arbitrary paths; see <link
-                        linkend="zend.controller.router">the router
-                        documentation</link> for more information.
+                        linkend="zend.controller.router">the router documentation</link>
+                    for more information.
                 </para>
             </listitem>
 
@@ -102,7 +102,7 @@
                     <classname>Zend_Controller_Dispatcher_Interface</classname> is used to
                     define dispatchers. Dispatching is the process of pulling
                     the controller and action from the request object and
-                    mapping them to a controller file/class and action method in
+                    mapping them to a controller file (or class) and action method in
                     the controller class. If the controller or action do not
                     exist, it handles determining default controllers and
                     actions to dispatch.
@@ -116,8 +116,8 @@
                     is reset at any point, the loop will be repeated, calling
                     whatever action is currently set in the request object. The
                     first time the loop finishes with the request object's
-                    dispatched status set (boolean true), it will finish
-                    processing.
+                    dispatched status set (<type>Boolean</type> <constant>TRUE</constant>),
+                    it will finish processing.
                 </para>
 
                 <para>
@@ -127,8 +127,8 @@
                     Controller, and action methods as camelCasedMethods ending
                     in the word Action:
                     <methodname>FooController::barAction()</methodname>. In this case, the
-                    controller would be referred to as <code>foo</code> and
-                    the action as <code>bar</code>.
+                    controller would be referred to as <emphasis>foo</emphasis> and
+                    the action as <emphasis>bar</emphasis>.
                 </para>
 
                 <note>
@@ -164,7 +164,7 @@
                 <para>
                     <classname>Zend_Controller_Action</classname> is the base action
                     controller component. Each controller is a single class
-                    that extends the <classname>Zend_Controller_Action class</classname>
+                    that extends the <classname>Zend_Controller_Action</classname> class
                     and should contain one or more action methods.
                 </para>
             </listitem>
@@ -180,7 +180,7 @@
                 <para>
                     The default response class is
                     <classname>Zend_Controller_Response_Http</classname>, which is
-                    suitable for use in an HTTP environment.
+                    suitable for use in an <acronym>HTTP</acronym> environment.
                 </para>
             </listitem>
         </itemizedlist>
@@ -190,8 +190,8 @@
         request is received by <classname>Zend_Controller_Front</classname>, which in turn
         calls <classname>Zend_Controller_Router_Rewrite</classname> to determine which
         controller (and action in that controller) to dispatch.
-        <classname>Zend_Controller_Router_Rewrite</classname> decomposes the URI in order
-        to set the controller and action names in the request.
+        <classname>Zend_Controller_Router_Rewrite</classname> decomposes the <acronym>URI</acronym>
+        in order to set the controller and action names in the request.
         <classname>Zend_Controller_Front</classname> then enters a dispatch loop. It
         calls <classname>Zend_Controller_Dispatcher_Standard</classname>, passing it the
         request, to dispatch to the controller and action specified in the

documentation/manual/en/module_specs/Zend_Controller-Dispatcher.xml

@@ -14,8 +14,8 @@
             action of that controller. If any of the module, controller, or
             action are not found, it will use default values for them.
             <classname>Zend_Controller_Dispatcher_Standard</classname> specifies
-            <code>index</code> for each of the controller and action defaults
-            and <code>default</code> for the module default value, but allows
+            <emphasis>index</emphasis> for each of the controller and action defaults
+            and <emphasis>default</emphasis> for the module default value, but allows
             the developer to change the default values for each using the
             <methodname>setDefaultController()</methodname>,
             <methodname>setDefaultAction()</methodname>, and
@@ -30,8 +30,8 @@
                 your default module namespaced as well (the default
                 configuration is that the default module is
                 <emphasis>not</emphasis> namespaced). As of 1.5.0, you can now
-                do so by specifying the <code>prefixDefaultModule</code> as true
-                in either the front controller or your dispatcher:
+                do so by specifying the <property>prefixDefaultModule</property> as
+                <constant>TRUE</constant> in either the front controller or your dispatcher:
             </para>
 
             <programlisting language="php"><![CDATA[
@@ -58,7 +58,7 @@ $dispatcher->setParam('prefixDefaultModule', true);
         <para>
             At the beginning of each iteration, it sets a flag in the request
             object indicating that the action has been dispatched. If an action
-            or pre/postDispatch plugin resets that flag, the dispatch loop will
+            or pre or postDispatch plugin resets that flag, the dispatch loop will
             continue and attempt to dispatch the new request. By changing the
             controller and/or action in the request and resetting the dispatched
             flag, the developer may define a chain of requests to perform.
@@ -110,7 +110,7 @@ public function bazAction()
             The dispatcher needs a variety of data in order to do its work - it
             needs to know how to format controller and action names, where to
             look for controller class files, whether or not a provided module
-            name is valid, and an API for determining if a given request is even
+            name is valid, and an <acronym>API</acronym> for determining if a given request is even
             dispatchable based on the other information available.
         </para>
 

documentation/manual/en/module_specs/Zend_Controller-Exceptions.xml

@@ -7,7 +7,7 @@
         <title>Introduction</title>
 
         <para>
-            The MVC components in Zend Framework utilize a Front Controller,
+            The <acronym>MVC</acronym> components in Zend Framework utilize a Front Controller,
             which means that all requests to a given site will go through a
             single entry point. As a result, all exceptions bubble up to the
             Front Controller eventually, allowing the developer to handle them
@@ -16,7 +16,7 @@
 
         <para>
             However, exception messages and backtrace information often contain
-            sensitive system information, such as SQL statements, file
+            sensitive system information, such as <acronym>SQL</acronym> statements, file
             locations, and more. To help protect your site, by default
             <classname>Zend_Controller_Front</classname> catches all exceptions and
             registers them with the response object; in turn, by default, the
@@ -28,7 +28,7 @@
         <title>Handling Exceptions</title>
 
         <para>
-            Several mechanisms are built in to the MVC components already to
+            Several mechanisms are built in to the <acronym>MVC</acronym> components already to
             allow you to handle exceptions.
         </para>
 
@@ -61,7 +61,7 @@
             </listitem>
 
             <listitem>
-                <para><classname>Zend_Controller_Front::throwExceptions()</classname></para>
+                <para><methodname>Zend_Controller_Front::throwExceptions()</methodname></para>
 
                 <para>
                     By passing a boolean true value to this method, you can tell
@@ -88,7 +88,7 @@ try {
 
             <listitem>
                 <para>
-                    <classname>Zend_Controller_Response_Abstract::renderExceptions()</classname>
+                    <methodname>Zend_Controller_Response_Abstract::renderExceptions()</methodname>
                 </para>
 
                 <para>
@@ -102,14 +102,14 @@ try {
 
             <listitem>
                 <para>
-                    <classname>Zend_Controller_Front::returnResponse()</classname> and
-                    <classname>Zend_Controller_Response_Abstract::isException()</classname>.
+                    <methodname>Zend_Controller_Front::returnResponse()</methodname> and
+                    <methodname>Zend_Controller_Response_Abstract::isException()</methodname>.
                 </para>
 
                 <para>
                     By passing a boolean true to
-                    <classname>Zend_Controller_Front::returnResponse()</classname>,
-                    <classname>Zend_Controller_Front::dispatch()</classname> will not render the
+                    <methodname>Zend_Controller_Front::returnResponse()</methodname>,
+                    <methodname>Zend_Controller_Front::dispatch()</methodname> will not render the
                     response, but instead return it. Once you have the response,
                     you may then test to see if any exceptions were trapped using
                     its <methodname>isException()</methodname> method, and retrieving the
@@ -131,7 +131,7 @@ if ($response->isException()) {
 
                 <para>
                     The primary advantage this method offers over
-                    <classname>Zend_Controller_Front::throwExceptions()</classname> is to
+                    <methodname>Zend_Controller_Front::throwExceptions()</methodname> is to
                     allow you to conditionally render the response after
                     handling the exception. This will catch any exception in the
                     controller chain, unlike the error handler plugin.
@@ -144,7 +144,7 @@ if ($response->isException()) {
         <title>MVC Exceptions You May Encounter</title>
 
         <para>
-            The various MVC components -- request, router, dispatcher, action
+            The various <acronym>MVC</acronym> components -- request, router, dispatcher, action
             controller, and response objects -- may each throw exceptions on
             occasion. Some exceptions may be conditionally overridden, and
             others are used to indicate the developer may need to consider
@@ -156,7 +156,7 @@ if ($response->isException()) {
         <itemizedlist>
             <listitem>
                 <para>
-                    <classname>Zend_Controller_Dispatcher::dispatch()</classname> will,
+                    <methodname>Zend_Controller_Dispatcher::dispatch()</methodname> will,
                     by default, throw an exception if an invalid controller is
                     requested. There are two recommended ways to deal with
                     this.
@@ -164,7 +164,9 @@ if ($response->isException()) {
 
                 <itemizedlist>
                     <listitem>
-                        <para>Set the <code>useDefaultControllerAlways</code> parameter.</para>
+                        <para>
+                            Set the <property>useDefaultControllerAlways</property> parameter.
+                        </para>
 
                         <para>
                             In your front controller, or your dispatcher, add
@@ -206,7 +208,7 @@ $dispatcher->setParam('useDefaultControllerAlways', true);
 
             <listitem>
                 <para>
-                    <classname>Zend_Controller_Action::__call()</classname> will throw a
+                    <methodname>Zend_Controller_Action::__call()</methodname> will throw a
                     <classname>Zend_Controller_Action_Exception</classname> if it cannot
                     dispatch a non-existent action to a method. Most likely,
                     you will want to use some default action in the controller
@@ -284,7 +286,7 @@ class My_Controller_Dispatcher extends Zend_Controller_Dispatcher
                         <para>
                             This method is nice because you can transparently
                             alter the action prior to final dispatch. However,
-                            it also means that typos in the URL may still
+                            it also means that typos in the <acronym>URL</acronym> may still
                             dispatch correctly, which is not great for search
                             engine optimization.
                         </para>
@@ -293,9 +295,9 @@ class My_Controller_Dispatcher extends Zend_Controller_Dispatcher
                     <listitem>
                         <para>
                             Use
-                            <classname>Zend_Controller_Action::preDispatch()</classname>
+                            <methodname>Zend_Controller_Action::preDispatch()</methodname>
                             or
-                            <classname>Zend_Controller_Plugin_Abstract::preDispatch()</classname>
+                            <methodname>Zend_Controller_Plugin_Abstract::preDispatch()</methodname>
                             to identify invalid actions.
                         </para>