[DOCUMENTATION] English:

- manual fixes

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

documentation/manual/en/module_specs/Zend_Controller-Router-Route-Chain.xml

@@ -25,9 +25,9 @@
         When chaining programatically, there are two ways to achieve this. The
         first one is to create a new
         <classname>Zend_Controller_Router_Route_Chain</classname> instance and then
-        calling the <code>chain</code> method multiple times with all routes
+        calling the <methodname>chain()</methodname> method multiple times with all routes
         which should be chained together. The other way is to take the first
-        route, e.g. a hostname route, and calling the <code>chain</code>
+        route, e.g. a hostname route, and calling the <methodname>chain()</methodname>
         method on it with the route which should be appended to it. This
         will not modify the hostname route, but return a new instance of
         <classname>Zend_Controller_Router_Route_Chain</classname>, which then has both
@@ -72,13 +72,13 @@ echo $chainedRoute->assemble();
         <para>
             To chain routes together in a config file, there are additional
             parameters for the configuration of those. The simpler approach is
-            to use the <code>chains</code> parameters. This one is simply a list
+            to use the <property>chains</property> parameters. This one is simply a list
             of routes, which will be chained with the parent route. Neither the
             parent- nor the child-route will be added directly to the router but
             only the resulting chained route. The name of the chained route in
             the router will be the parent route name and the child route name
-            concatenated with a dash (-) by default. A simple config in <acronym>XML</acronym> would look
-            like this:
+            concatenated with a dash (-) by default. A simple config in <acronym>XML</acronym>
+            would look like this:
         </para>
 
         <programlisting language="xml"><![CDATA[
@@ -92,11 +92,13 @@ echo $chainedRoute->assemble();
                 <chains>
                     <index type="Zend_Controller_Router_Route_Static">
                         <route></route>
-                        <defaults module="default" controller="index" action="index" />
+                        <defaults module="default" controller="index"
+                                  action="index" />
                     </index>
                     <imprint type="Zend_Controller_Router_Route_Static">
                         <route>imprint</route>
-                        <defaults module="default" controller="index" action="index" />
+                        <defaults module="default" controller="index"
+                                  action="index" />
                     </imprint>
                 </chains>
             </language>
@@ -118,16 +120,16 @@ echo $chainedRoute->assemble();
 ]]></programlisting>
 
         <para>
-            This will result in the three routes <code>www-language-index</code>,
-            <code>www-language-imprint</code> and
-            <code>users-language-profile</code> which will only match based on
-            the hostname and the route <code>misc</code>, which will match with
+            This will result in the three routes <command>www-language-index</command>,
+            <command>www-language-imprint</command> and
+            <command>users-language-profile</command> which will only match based on
+            the hostname and the route <command>misc</command>, which will match with
             any hostname.
         </para>
 
         <para>
             The alternative way of creating a chained route is via the
-            <code>chain</code> parameter, which can only be used with the
+            <property>chain</property> parameter, which can only be used with the
             chain-route type directly, and also just works in the root level:
         </para>
 
@@ -159,7 +161,7 @@ echo $chainedRoute->assemble();
 ]]></programlisting>
 
         <para>
-            You can also give the <code>chain</code> parameter as array instead
+            You can also give the <property>chain</property> parameter as array instead
             of separating the routes with a comma:
         </para>
 

documentation/manual/en/module_specs/Zend_Controller-Router-Route-Hostname.xml

@@ -36,15 +36,15 @@ $router->addRoute('user', $hostnameRoute->chain($plainPathRoute);
         constructor is a route definition that will be matched to a hostname. Route
         definitions consist of static and dynamic parts separated by the dot
         ('.') character. Dynamic parts, called variables, are marked by
-        prepending a colon to the variable name: <code>:username</code>.
-        Static parts are just simple text: <code>user</code>.
+        prepending a colon to the variable name: <command>:username</command>.
+        Static parts are just simple text: <command>user</command>.
     </para>
 
     <para>
         Hostname routes can, but never should be used as is. The reason behind
         that is, that a hostname route alone would match any path. So what you
         have to do is to chain a path route to the hostname route. This is done
-        like in the example by calling <methodname>$hostnameRoute->chain($pathRoute)</methodname>.
+        like in the example by calling <command>$hostnameRoute->chain($pathRoute);</command>.
         By doing this, <varname>$hostnameRoute</varname> isn't modified, but a new
         route (<classname>Zend_Controller_Router_Route_Chain</classname>) is returned,
         which can then be given to the router.

documentation/manual/en/module_specs/Zend_Controller-Router-Route-Regex.xml

@@ -185,8 +185,8 @@ $route = new Zend_Controller_Router_Route_Regex(
 ]]></programlisting>
 
     <para>
-        Which will result in mixed values available in the Request. As an
-        example, the <acronym>URL</acronym> <filename>http://domain.com/archive/2006/page/10</filename>
+        Which will result in mixed values available in the Request. As an example, the
+        <acronym>URL</acronym> <filename>http://domain.com/archive/2006/page/10</filename>
         will result in following values:
     </para>
 
@@ -201,9 +201,9 @@ $values = array(
 
     <para>
         Since regex patterns are not easily reversed, you will need to prepare
-        a reverse <acronym>URL</acronym> if you wish to use a <acronym>URL</acronym> helper or even an assemble method
-        of this class. This reversed path is represented by a string parsable by
-        sprintf() and is defined as a fourth construct parameter:
+        a reverse <acronym>URL</acronym> if you wish to use a <acronym>URL</acronym> helper or even
+        an assemble method of this class. This reversed path is represented by a string parsable by
+        <methodname>sprintf()</methodname> and is defined as a fourth construct parameter:
     </para>
 
     <programlisting language="php"><![CDATA[
@@ -223,7 +223,7 @@ $route = new Zend_Controller_Router_Route_Regex(
         <filename>http://domain.com/blog/archive/01-Using_the_Regex_Router.html</filename>,
         and have it decompose the last path element,
         <filename>01-Using_the_Regex_Router.html</filename>, into an article ID and
-        article title/description; this is not possible with the standard route.
+        article title or description; this is not possible with the standard route.
         With the Regex route, you can do something like the following solution:
     </para>
 

documentation/manual/en/module_specs/Zend_Controller-Router-Route-Rest.xml

@@ -56,12 +56,12 @@
                 </row>
                 <row>
                     <entry>POST</entry>
-                    <entry><filename>/product/ratings/:id?_method="PUT"</filename></entry>
+                    <entry><command>/product/ratings/:id?_method="PUT"</command></entry>
                     <entry><methodname>Product_RatingsController::putAction()</methodname></entry>
                 </row>
                 <row>
                     <entry>POST</entry>
-                    <entry><filename>/product/ratings/:id?_method="DELETE"</filename></entry>
+                    <entry><command>/product/ratings/:id?_method="DELETE"</command></entry>
                     <entry>
                         <methodname>Product_RatingsController::deleteAction()</methodname>
                     </entry>

documentation/manual/en/module_specs/Zend_Controller-Router-Route-Static.xml

@@ -19,8 +19,9 @@ $router->addRoute('login', $route);
 ]]></programlisting>
 
     <para>
-        Above route will match a <acronym>URL</acronym> of <filename>http://domain.com/login</filename>,
-        and dispatch to <methodname>AuthController::loginAction()</methodname>.
+        Above route will match a <acronym>URL</acronym> of
+        <filename>http://domain.com/login</filename>, and dispatch to
+        <methodname>AuthController::loginAction()</methodname>.
     </para>
 
     <note id="zend.controller.router.routes.static.warning">

documentation/manual/en/module_specs/Zend_Controller-Router-Route.xml

@@ -36,8 +36,8 @@ $router->addRoute('user', $route);
         constructor is a route definition that will be matched to a <acronym>URL</acronym>. Route
         definitions consist of static and dynamic parts separated by the slash
         ('/') character. Static parts are just simple text:
-        <code>author</code>. Dynamic parts, called variables, are marked by
-        prepending a colon to the variable name: <code>:username</code>.
+        <command>author</command>. Dynamic parts, called variables, are marked by
+        prepending a colon to the variable name: <command>:username</command>.
     </para>
 
     <note>
@@ -55,7 +55,7 @@ $router->addRoute('user', $route);
         This example route should be matched when you point your browser to
         <filename>http://domain.com/author/martel</filename>, in which case all its
         variables will be injected to the <classname>Zend_Controller_Request</classname>
-        object and will be accessible in your <code>ProfileController</code>.
+        object and will be accessible in your <classname>ProfileController</classname>.
         Variables returned by this example may be represented as an array of
         the following key and value pairs:
     </para>
@@ -71,7 +71,7 @@ $values = array(
     <para>
         Later on, <classname>Zend_Controller_Dispatcher_Standard</classname> should invoke
         the <methodname>userinfoAction()</methodname> method of your
-        <code>ProfileController</code> class (in the default module) based on
+        <classname>ProfileController</classname> class (in the default module) based on
         these values. There you will be able to access all variables by means of
         the <methodname>Zend_Controller_Action::_getParam()</methodname> or
         <methodname>Zend_Controller_Request::getParam()</methodname> methods:
@@ -152,7 +152,7 @@ $router->addRoute('archive', $route);
         <para>
             This route will then result in dispatching to the method
             <methodname>showAction()</methodname> of the class
-            <code>ArchiveController</code>.
+            <classname>ArchiveController</classname>.
         </para>
 
     </sect4>
@@ -243,7 +243,7 @@ $router->addRoute('archive', $route);
             </listitem>
             <listitem>
                 <para>
-                    Pass it as <code>@locale</code> parameter to the assemble
+                    Pass it as <command>@locale</command> parameter to the assemble
                     method.
                 </para>
             </listitem>
@@ -251,10 +251,10 @@ $router->addRoute('archive', $route);
 
         <para>
             Translated segments are separated into two parts. Fixed segments
-            are prefixed by a single <code>@</code>-sign, and will be
+            are prefixed by a single <emphasis>@</emphasis>-sign, and will be
             translated to the current locale when assembling and reverted
             to the message ID when matching again. Dynamic segments
-            are prefixed by <code>:@</code>. When assembling, the given
+            are prefixed by <command>:@</command>. When assembling, the given
             parameter will be translated and inserted into the parameter
             position. When matching, the translated parameter from the
             <acronym>URL</acronym> will be reverted to the message ID again.